SAsamsara
Trailer Assignments

List trailer assignments for all trailers

🚧 This endpoint is still on our legacy API.

Fetch trailer assignment data for all trailers in your organization.

<b>Rate limit:</b> 25 requests/sec (learn more about rate limits <a href="https://developers.samsara.com/docs/rate-limits" target="_blank">here</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.

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>

get/v1/fleet/trailers/assignments

Request

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

Query parameters

startMsinteger

Timestamp in Unix epoch miliseconds representing the start of the period to fetch. Omitting both startMs and endMs only returns current assignments.

endMsinteger

Timestamp in Unix epoch miliseconds representing the end of the period to fetch. Omitting endMs sets endMs as the current time

limitnumber

Pagination parameter indicating the number of results to return in this request. Used in conjunction with either 'startingAfter' or 'endingBefore'.

startingAfterstring

Pagination parameter indicating the cursor position to continue returning results after. Used in conjunction with the 'limit' parameter. Mutually exclusive with 'endingBefore' parameter.

endingBeforestring

Pagination parameter indicating the cursor position to return results before. Used in conjunction with the 'limit' parameter. Mutually exclusive with 'startingAfter' parameter.

Response

Returns trailer assignment data for all trailers in your organization

Example response

{
  "pagination": {
    "endCursor": "MTU5MTEzNjA2OTU0MzQ3",
    "startCursor": "MTU5MTEzNjA2OTU0MzQ3"
  },
  "trailers": [
    {
      "id": 2041,
      "name": "myTrailer",
      "trailerAssignments": [
        {
          "driverId": 2047,
          "endMs": 1462881998034,
          "startMs": 1462878398034
        }
      ]
    }
  ]
}

Changes

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