REST API
SUPPORTFEEDBACK

[beta] List custom properties for a specific hub

get
https://api.samsara.com/hub/customProperties

Retrieve custom properties for a specific hub.

Beta: This endpoint is in beta and is likely to change before being broadly available. Reach out to your Samsara Representative to have RoutePlanning APIs enabled for your organization.

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.

Query Params
string
required

The hub identifier

string

A comma-separated list of custom property IDs that can be used for filtering.

string

A comma-separated list of custom property names that can be used for filtering.

date-time

Time filter of when the custom property was updated, in RFC 3339 format

date-time

Time filter of when the custom property was updated, in RFC 3339 format

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.

integer
≤ 100
Defaults to 100

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

Responses

Updated 3 months ago

Language
Credentials
Bearer
URL
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 3 months ago