Beta APIs

[beta] Get a ridership passenger.

Get a passenger by Samsara UUID or external ID, such as student:STU-001. External IDs are omitted from the response unless includeExternalIds=true.

<b>Rate limit:</b> 10 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/{id}

Request

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

Path parameters

idstring required

Samsara UUID of the passenger, or an external ID in key:value format, such as student:STU-001.

Query parameters

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"
  }
}

Changes

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