--- title: "[beta] List or batch-get places" method: GET path: "/places" tags: ["Beta APIs"] --- # \[beta\] List or batch-get places `GET /places` ## Request - Base URL: `https://api.samsara.com` - URL: `https://api.samsara.com/places` - Auth: HTTP bearer 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. ## Query parameters - `after` string - `limit` integer - `placeIds` string - `externalIds` string - `includeTags` boolean - `includeExternalIds` boolean - `tagIds` string - `parentTagIds` string - `placeTypes` string - `name` string - `hubIds` string ## Response `200` OK response. - PlacesGetPlacesResponseBody - `data` PlaceResponseObjectResponseBody[], required: Places matching the request. - `address` string, required: Address string. - `addressLatitude` number, double: Latitude of the place pin (map marker), stored independently of the geofence. Omitted when no pin is set. - `addressLongitude` number, double: Longitude of the place pin (map marker), stored independently of the geofence. Omitted when no pin is set. - `businessContacts` PlaceBusinessContactsResponseResponseBody: Business contact information for a place. - `contacts` PlaceBusinessContactResponseResponseBody[]: Named contacts. - `email` string: Contact email. - `name` string: Display name. - `phoneNumber` string: Contact phone. - `email` string[]: Place-level email addresses. - `phoneNumbers` string[]: Place-level phone numbers. - `cameraRecordingModeType` string: Camera recording mode: inherit, fullRecording, driverPrivacy, completePrivacy, or unknown. - `createdAtTime` string, date-time, required: Created timestamp in RFC 3339 format. - `externalIds` object: External ids when includeExternalIds=true. - `geofence` PlaceGeofenceResponseResponseBody, required: Discriminated place geofence. GET returns circle, polygon, or unknown when stored geometry cannot be mapped. - `circle` PlaceGeofenceCircleResponseResponseBody: Circle geofence geometry. - `latitude` number, double, required: Circle center latitude in decimal degrees. - `longitude` number, double, required: Circle center longitude in decimal degrees. - `radiusMeters` integer, required: Radius in meters; must be positive. - `polygon` PlaceGeofencePolygonResponseResponseBody: Polygon geofence geometry. - `vertices` PlaceGeofenceVertexResponseResponseBody[], required: Polygon vertices; at least three. - `latitude` number, double, required: Latitude in decimal degrees. - `longitude` number, double, required: Longitude in decimal degrees. - `type` 'circle' | 'polygon' | 'unknown', required: Geofence type: circle, polygon, or unknown. Valid values: `circle`, `polygon`, `unknown` - `id` string, required: Samsara place id. - `iftaExemptionTypes` string[]: IFTA exemption labels. - `isAutoDismissRolledStopsEnabled` boolean: Auto-dismiss rolled stops. - `isShowAddressesEnabled` boolean: Show addresses inside geofence. - `name` string, required: Place name. - `navigation` PlaceNavigationResponseResponseBody: Navigation metadata. - `locations` PlaceNavigationLocationResponseResponseBody[], required: Navigation locations. - `driverInstructions` string: Driver instructions. - `latitude` number, double, required: Latitude. - `locationType` string, required: Navigation location type. - `longitude` number, double, required: Longitude. - `name` string, required: Location name. - `notes` string: Notes. - `placeTypes` string[]: Assigned place types. - `routing` RoutingResponseResponseBody[]: Route-planning rows when present. - `driverInstructions` string: Default instructions for drivers. - `hubId` string, required: Hub (planner) UUID. - `hubNotes` string: Hub-facing notes. - `isDepot` boolean, required: Whether this routing row is a depot. - `orderServiceTime` RoutingOrderServiceTimeResponseResponseBody: Order service time configuration for a routing row. - `capacityServiceTime` RoutingCapacityServiceTimeResponseResponseBody: Per-capacity order service time entry. - `capacityId` string, required: Capacity UUID. - `quantityPerServiceTime` number, double, required: Quantity units per service time chunk. - `serviceTimeSeconds` integer, required: Service time in seconds. - `fixedServiceTimeSeconds` integer: Fixed order service time in seconds. - `isEnabled` boolean, required: Whether order service time settings apply at this stop. - `modeType` string, required: Mode: unknown, unspecified, fixed, or variable. - `position` string: Stop position preference: first or last. - `priority` integer: Route priority from 1 (lowest) to 5 (highest). - `requiredSkills` RoutingRequiredSkillResponseResponseBody[]: Required planner skills. - `id` string, required: Planner skill UUID. - `name` string: Skill display name when resolved on GET. - `routingExternalId` string: Customer-defined external identifier within the hub. - `serviceTime` RoutingServiceTimeResponseResponseBody: Additional service time at a routing row. - `isEnabled` boolean, required: Whether additional service time is enabled. - `serviceTimeMinutes` integer, required: Whole minutes of additional service time. - `serviceWindows` RoutingServiceWindowResponseResponseBody[]: Configured service windows. - `days` string[], required: Days this window applies. - `endTime` string, required: End time as HH:MM:SS in the org timezone. - `startTime` string, required: Start time as HH:MM:SS in the org timezone. - `safetyEventExclusions` string[]: Configured safety exclusions. - `streetView` PlaceStreetViewResponseResponseBody: Street view settings for a place. - `headingDegrees` number, double: Camera heading clockwise from true north; 0 ≤ headingDegrees < 360 on write, normalized mod 360 on GET. - `isEnabled` boolean, required: Whether street view is enabled. - `latitude` number, double: Latitude. - `longitude` number, double: Longitude. - `pitchDegrees` number, double: Camera pitch relative to the Street View horizon; −90 ≤ pitchDegrees ≤ 90. - `zoom` number, double: Zoom level. - `tags` PlaceTagResponseResponseBody[]: Tags when includeTags=true. - `id` string, required: Samsara tag id. - `name` string: Tag name when resolved. - `parentTagId` string: Parent tag id when present. - `updatedAtTime` string, date-time, required: Updated timestamp in RFC 3339 format. - `pagination` GoaPaginationResponseResponseBody, required: Pagination parameters. - `endCursor` string, required: Cursor identifier representing the last element in the response. This value should be used in conjunction with a subsequent request's 'after' query parameter. This may be an empty string if there are no more pages left to view. - `hasNextPage` boolean, required: True if there are more pages of results immediately available after this endCursor. ## Other responses - `401`: Unauthorized response. - `404`: Not Found response. - `405`: Method Not Allowed response. - `413`: Content Too Large response. - `429`: Too Many Requests response. - `500`: Internal Server Error response. - `501`: Not Implemented response. - `502`: Bad Gateway response. - `503`: Service Unavailable response. - `504`: Gateway Timeout response. - `default`: Bad Request response. --- [API](https://skmtc.dev/samsara/apis/samsara-api.md) - [All operations](https://skmtc.dev/samsara/apis/samsara-api/llms.txt) - [OpenAPI document](https://skmtc.dev/samsara/apis/samsara-api/revisions/a9e35d4999be?raw)