{
  "opencollection": "1.0.0",
  "info": {
    "name": "Samsara Carrier API",
    "version": "2024-11-18"
  },
  "request": {
    "auth": {
      "type": "bearer",
      "token": "{{bearerToken}}"
    }
  },
  "items": [
    {
      "info": {
        "name": "Carrier",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Retrieve Assignments",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.samsara.com/fleet/carrier-proposed-assignments",
            "params": [
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "The limit for how many objects will be in the response. Default and max for this value is 512 objects."
              },
              {
                "name": "after",
                "value": "",
                "type": "query",
                "description": "If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results."
              },
              {
                "name": "driverIds",
                "value": "",
                "type": "query",
                "description": "A filter on the data based on this comma-separated list of driver IDs and externalIds. Example: `driverIds=1234,5678,payroll:4841`"
              },
              {
                "name": "activeTime",
                "value": "",
                "type": "query",
                "description": "If specified, shows assignments that will be active at this time. Defaults to now, which would show current active assignments. In RFC 3339 format. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00)."
              }
            ]
          },
          "docs": "Show the assignments created by the POST fleet/carrier-proposed-assignments. This endpoint will only show the assignments that are active for drivers and currently visible to them in the driver app. Once a proposed assignment has been accepted, the endpoint will not return any data. \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our <a href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\">API feedback form</a>. If you encountered an issue or"
        },
        {
          "info": {
            "name": "Create an Assignment",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.samsara.com/fleet/carrier-proposed-assignments",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Creates a new assignment that a driver can later use. Each driver can only have one future assignment. \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our <a href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\">API feedback form</a>. If you encountered an issue or noticed inaccuracies in the API documentation, please <a href=\"https://www.samsara.com/help\" target=\"_blank\">submit a case</a> to our support team.\n\nTo use this endpoint, select **"
        },
        {
          "info": {
            "name": "Delete an Assignment",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.samsara.com/fleet/carrier-proposed-assignments/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "ID of the assignment."
              }
            ]
          },
          "docs": "Permanently delete an assignment. You can only delete assignments that are not yet active. To override a currently active assignment, create a new empty one, instead. \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our <a href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\">API feedback form</a>. If you encountered an issue or noticed inaccuracies in the API documentation, please <a href=\"https://www.samsara.com/help\" target=\"_blank\">submit "
        }
      ]
    }
  ],
  "bundled": true
}