Trailer Assignments

List trailer assignments for a given trailer

🚧 This endpoint is still on our legacy API.

Fetch trailer assignment data for a single trailer.

<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/{trailerId}/assignments

Request

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

Path parameters

trailerIdinteger required

ID of trailer. Must contain only digits 0-9.

Query parameters

startMsinteger

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

endMsinteger

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

Response

Returns trailer assignment data for a single trailer

idinteger required

ID of the trailer

namestring string required

Assignment trailer name (given when creating trailer via the trailer portal)

Example response

{
  "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.