SAsamsara
Maintenance Sites

List maintenance sites

Returns a paginated list of maintenance sites for the organization.

<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 Maintenance Sites under the Work Orders 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/maintenance/sites

Request

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

Query parameters

idsstring

A filter on the data based on this comma-separated list of ID values.

isArchivedboolean

A filter on the data based on Archived. Whether the site is archived. Archived sites are no longer active but are retained for historical record.

placeIdsstring

A filter on the data based on this comma-separated list of Place IDs values.

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 200 objects.

includeExternalIdsboolean

If true, include externalIds in each response object.

Response

OK response.

Example response

{
  "data": [
    {
      "archivedAt": "2019-06-13T19:08:25Z",
      "createdAt": "2019-06-13T19:08:25Z",
      "customAddress": {
        "formattedAddress": "12345",
        "latitude": 123.45,
        "longitude": 123.45
      },
      "description": "12345",
      "externalIds": [
        {
          "key": "12345",
          "value": "12345"
        }
      ],
      "id": "12345",
      "isArchived": true,
      "name": "12345",
      "places": [
        {
          "id": "281474976710656"
        }
      ],
      "siteCode": "12345",
      "siteType": "Unknown",
      "updatedAt": "2019-06-13T19:08:25Z"
    }
  ],
  "pagination": {
    "endCursor": "MjkY",
    "hasNextPage": true
  }
}

Changes

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