Hubs

List all hubs for the organization

Retrieve all hubs (planners) in the organization. This endpoint supports pagination and filtering based on hub IDs and update times.

<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 Routes under the Driver Workflow 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/hubs

Request

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

Query parameters

hubIdsstring

A comma-separated list of hub IDs for filtering results.

startTimestring date-time

Returns hubs updated after the specified time in UTC

endTimestring date-time

Returns hubs updated before the specified time in UTC

afterstring

If specified, should be the endCursor 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

Maximum number of objects to return. Default and maximum is 100

Response

OK response.

Example response

{
  "data": [
    {
      "createdAt": "2024-01-15T10:30:00Z",
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "name": "West Coast Distribution Center",
      "timeZone": "America/Los_Angeles",
      "updatedAt": "2024-01-15T10:30:00Z"
    }
  ],
  "pagination": {
    "endCursor": "YXJyYXljb25uZWN0aW9uOjEwMA=="
  }
}

Changes

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