---
title: "[beta] List ridership passengers."
method: GET
path: "/ridership/passengers"
tags: ["Beta APIs"]
---

# \[beta\] List ridership passengers.

`GET /ridership/passengers`

## Request

- Base URL: `https://api.samsara.com`
- URL: `https://api.samsara.com/ridership/passengers`
- Auth: HTTP bearer

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.

## Query parameters

- `tagId` string, required
- `after` string
- `limit` integer
- `includeExternalIds` boolean

## Response `200`

OK response.

- RidershipPassengersListRidershipPassengersResponseBody
  - `data` RidershipPassengerObjectResponseBody[], required: List of ridership passengers
    - `classification` string: Passenger grade level: `pk1`–`pk4` are pre-kindergarten categories, `k` is kindergarten, and `grade1`–`grade12` are grades 1–12.
    - `createdAtTime` string, required: The time the passenger was created in RFC 3339 format.
    - `externalIds` object: Customer-defined IDs that link this passenger to another system, such as {"student": "STU-001"}.
    - `firstName` string, required: First name of the passenger.
    - `id` string, required: The unique Samsara ID of the passenger.
    - `identifiers` RidershipPassengerIdentifierObjectResponseBody[]: List of identifiers associated with the passenger.
      - `id` string, required: The unique Samsara ID of the identifier.
      - `status` 'active' | 'inactive' | 'unknown', required: Whether the identifier is active or inactive. Valid values: `active`, `inactive`, `unknown`
      - `type` 'rfid' | 'unknown', required: The type of identifier. Valid values: `rfid`, `unknown`
      - `value` string, required: Value of the identifier, such as the value read from an RFID card.
    - `isActive` boolean, required: Whether the passenger is active.
    - `lastName` string, required: Last name of the passenger.
    - `specialInstructions` RidershipPassengerSpecialInstructionsObjectResponseBody: Special instructions for the passenger.
      - `isGuardianRequired` boolean: Whether a guardian is required for the passenger.
      - `isSpecialEducation` boolean: Whether the passenger requires special education accommodations.
    - `tagIds` string[]: Samsara IDs of the tags assigned to this passenger.
    - `updatedAtTime` string, required: The time the passenger was last updated in RFC 3339 format.
  - `pagination` GoaPaginationResponseResponseBody, required: Pagination parameters.
    - `endCursor` string, required: Cursor identifier representing the last element in the response. This value should be used in conjunction with a subsequent request's 'after' query parameter. This may be an empty string if there are no more pages left to view.
    - `hasNextPage` boolean, required: True if there are more pages of results immediately available after this endCursor.

## Other responses

- `401`: Unauthorized response.
- `404`: Not Found response.
- `405`: Method Not Allowed response.
- `413`: Content Too Large response.
- `429`: Too Many Requests response.
- `500`: Internal Server Error response.
- `501`: Not Implemented response.
- `502`: Bad Gateway response.
- `503`: Service Unavailable response.
- `504`: Gateway Timeout response.
- `default`: Bad Request response.

---

[API](https://skmtc.dev/samsara/apis/samsara-api.md) - [All operations](https://skmtc.dev/samsara/apis/samsara-api/llms.txt) - [OpenAPI document](https://skmtc.dev/samsara/apis/samsara-api/revisions/a9e35d4999be?raw)
