SAsamsara
Driver-Trailer Assignments

Get currently active driver-trailer assignments for driver.

Get currently active driver-trailer assignments for driver.

<b>Rate limit:</b> 5 requests/sec (learn more about rate limits <a href="https://developers.samsara.com/docs/rate-limits" target="_blank">here</a>).

To use this endpoint, select Read Assignments under the Assignments category when creating or editing an API token. <a href="https://developers.samsara.com/docs/authentication#scopes-for-api-tokens" target="_blank">Learn More.</a>

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.

get/driver-trailer-assignments

Request

  • Base URL
    https://api.samsara.com
  • Auth
    HTTP bearer

Query parameters

driverIdsstring[] required

A filter on the data based on this comma-separated list of driver IDs and externalIds. Example: driverIds=1234,5678,payroll:4841

afterstring

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.

includeExternalIdsboolean

Optional boolean indicating whether to return external IDs on supported entities

Response

OK response.

Example response

{
  "data": [
    {
      "createdAtTime": "2019-06-13T19:08:25Z",
      "driver": {
        "driverId": "0987"
      },
      "endTime": "2019-06-13T20:10:25Z",
      "id": "08b3aeada5f4ab3010c0b4efa28d2d1890dbf8d48d2d6",
      "startTime": "2019-06-13T19:08:25Z",
      "trailer": {
        "trailerId": "494123"
      },
      "updatedAtTime": "2019-06-13T19:10:25Z"
    }
  ],
  "pagination": {
    "endCursor": "MjkY",
    "hasNextPage": true
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.