REST API
SUPPORTFEEDBACK

[beta] List ridership passengers.

get
https://api.samsara.com/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.

Rate limit: 5 requests/sec (learn more about rate limits here).

To use this endpoint, select Read Ridership under the Ridership category when creating or editing an API token. Learn More.

Submit Feedback: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
required

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

string

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.

integer
1 to 512
Defaults to 512

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

boolean

Optional boolean indicating whether to return external IDs on supported entities

Responses

Updated 6 months ago

Did this page help you?
Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 6 months ago

Did this page help you?