REST API
SUPPORTFEEDBACK

[beta] List or batch-get places

get
https://api.samsara.com/places

Returns places for the authorized organization. Supports cursor pagination or batch fetch by Samsara place ids via placeIds or by external ids via externalIds (mutually exclusive).

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

To use this endpoint, select Read Places under the Places 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

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.

string

Comma-separated Samsara place IDs for batch lookup (max 100). When set, list filters and cursor pagination are ignored. Mutually exclusive with externalIds.

string

Comma-separated external ID tokens (key:value) for batch lookup (max 100). When set, list filters and cursor pagination are ignored. Mutually exclusive with placeIds.

boolean
Defaults to false

When true, expands tag objects on each place. Defaults to false.

boolean
Defaults to false

When true, includes externalIds on each place. Defaults to false.

string

Comma-separated numeric tag IDs to filter places.

string

Reserved. Filtering by parent tag IDs is not implemented in this API version.

string

Comma-separated place type tokens (e.g. yard,normalGeofence).

string

Filter places by name text.

Responses

Updated 4 days ago

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 4 days ago