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.

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

To use this endpoint, select Read Routes under the Driver Workflow 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.

GET /hubs

List all hubs for the organization

cURL

curl --request GET \
  --url https://api.samsara.com/hubs \
  --header 'Authorization: Bearer <token>'

200

{
  "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": {
    "hasNextPage": false,
    "endCursor": "YXJyYXljb25uZWN0aW9uOjEwMA=="
  }
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

hubIds · string

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

startTime · string<date-time>

Returns hubs updated after the specified time in UTC

endTime · string<date-time>

Returns hubs updated before the specified time in UTC

after · string

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.

limit · integer · default: 100

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

Required range: x <= 100

Response

200

application/json

OK response.

data · object[] · required

Hub data

Show child attributes

pagination · object · required

Pagination information

Show child attributes