Beta APIs

[beta] List ridership passengers.

List passengers assigned to a tag. External IDs are omitted from the response unless includeExternalIds=true.

Results are paginated. A page may contain fewer results than requested. While pagination.hasNextPage is true, pass pagination.endCursor as after to retrieve the next page.

<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 Ridership under the Ridership 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/ridership/passengers

Request

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

Query parameters

tagIdstring required

Samsara ID of the tag to filter passengers by, such as 5678. External IDs are not supported here.

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.

limitinteger

The limit for how many objects will be in the response. Default and max for this value is 512 objects.

includeExternalIdsboolean

Optional boolean indicating whether to return external IDs on supported entities

Response

OK response.

Example response

{
  "data": [
    {
      "classification": "grade5",
      "createdAtTime": "2024-11-15T10:00:00Z",
      "firstName": "John",
      "id": "a1b2c3d4-5e6f-7a8b-9c0d-1e2f3a4b5c6d",
      "identifiers": [
        {
          "id": "b2c3d4e5-6f7a-8b9c-0d1e-2f3a4b5c6d7e",
          "status": "active",
          "type": "rfid",
          "value": "0418A2BC93"
        }
      ],
      "isActive": true,
      "lastName": "Doe",
      "tagIds": [
        "5678",
        "9012"
      ],
      "updatedAtTime": "2024-11-15T10:30:00Z"
    }
  ],
  "pagination": {
    "endCursor": "MjkY",
    "hasNextPage": true
  }
}

Changes

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