SAsamsara
Beta APIs

[beta] List or batch-get 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).

<b>Rate limit:</b> 5 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 Places under the Places 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/places

Request

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

Query parameters

afterstring

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.

limitinteger

The limit for how many objects will be in the response. Default and max for this value is 512 objects.

placeIdsstring

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

externalIdsstring

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.

includeTagsboolean

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

includeExternalIdsboolean

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

tagIdsstring

Comma-separated numeric tag IDs to filter places.

parentTagIdsstring

Comma-separated parent tag IDs to filter places. Includes places tagged with each parent tag and its descendant tags.

placeTypesstring

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

namestring

Filter places by name text.

hubIdsstring

Comma-separated route-planning hub IDs (UUIDs). Returns places associated with any of the given hubs.

Response

OK response.

Example response

{
  "data": [
    {
      "address": "123 Main St",
      "addressLatitude": 37.7749,
      "addressLongitude": -122.4194,
      "businessContacts": {
        "contacts": [
          {
            "email": "bob@example.com",
            "name": "Bob Smith",
            "phoneNumber": "+14155555678"
          }
        ],
        "email": [
          "warehouse@example.com"
        ],
        "phoneNumbers": [
          "+14155551234"
        ]
      },
      "cameraRecordingModeType": "inherit",
      "createdAtTime": "2019-06-13T19:08:25Z",
      "externalIds": {
        "Exercitationem non.": "Autem est laboriosam corrupti et voluptatibus sapiente."
      },
      "geofence": {
        "circle": {
          "latitude": 37.7749,
          "longitude": -122.4194,
          "radiusMeters": 150
        },
        "polygon": {
          "vertices": [
            {
              "latitude": 37.7749,
              "longitude": -122.4194
            }
          ]
        },
        "type": "circle"
      },
      "id": "12345",
      "iftaExemptionTypes": [
        "Eum sapiente cum.",
        "Aut asperiores blanditiis quas nihil dolor.",
        "Eum maiores eos maiores.",
        "Provident ut."
      ],
      "isShowAddressesEnabled": true,
      "name": "Oakland Yard",
      "navigation": {
        "locations": [
          {
            "driverInstructions": "Check in at booth.",
            "latitude": 37.7749,
            "locationType": "entrance",
            "longitude": -122.4194,
            "name": "Main gate"
          }
        ]
      },
      "notes": "Receiving 6-2",
      "placeTypes": [
        "Alias repellat ut commodi velit.",
        "Animi qui.",
        "Ea voluptatem voluptas et architecto sapiente suscipit.",
        "Porro ipsum quo enim alias error."
      ],
      "routing": [
        {
          "driverInstructions": "Use lane 2",
          "hubId": "550e8400-e29b-41d4-a716-446655440003",
          "hubNotes": "Zone A preferred",
          "orderServiceTime": {
            "capacityServiceTime": {
              "capacityId": "550e8400-e29b-41d4-a716-446655440001",
              "quantityPerServiceTime": 0.5,
              "serviceTimeSeconds": 60
            },
            "fixedServiceTimeSeconds": 300,
            "isEnabled": true,
            "modeType": "variable"
          },
          "position": "first",
          "priority": 3,
          "requiredSkills": [
            {
              "id": "550e8400-e29b-41d4-a716-446655440000",
              "name": "Refrigerated"
            }
          ],
          "routingExternalId": "store-A",
          "serviceTime": {
            "isEnabled": true,
            "serviceTimeMinutes": 5
          },
          "serviceWindows": [
            {
              "days": [
                "Illum alias perspiciatis.",
                "Iste dolores cupiditate delectus corrupti."
              ],
              "endTime": "17:00:01",
              "startTime": "09:00:00"
            }
          ]
        }
      ],
      "safetyEventExclusions": [
        "Quas nemo.",
        "Error tenetur sunt."
      ],
      "streetView": {
        "headingDegrees": 90,
        "isEnabled": true,
        "latitude": 37.7749,
        "longitude": -122.4194,
        "zoom": 1
      },
      "tags": [
        {
          "id": "1001",
          "name": "Yard",
          "parentTagId": "500"
        }
      ],
      "updatedAtTime": "2019-06-13T19:08:25Z"
    }
  ],
  "pagination": {
    "endCursor": "MjkY",
    "hasNextPage": true
  }
}

Changes

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