SAsamsara
Beta APIs

[beta] Fetches all jobs

Fetches jobs based on id/uuid or provided filters.

To use this endpoint, select Read Jobs under the Equipment 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/beta/industrial/jobs

Request

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

Query parameters

idstring

A jobId or uuid in STRING format. JobId must be prefixed with jobId:(Examples: "8d218e6c-7a16-4f9f-90f7-cc1d93b9e596", "jobId:98765").

startDatestring

A start time in RFC 3339 format. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00).

endDatestring

An end time in RFC 3339 format. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00).

industrialAssetIdsstring[]

IndustrialAssetId in STRING format. (Example: "8d218e6c-7a16-4f9f-90f7-cc1d93b9e596").

fleetDeviceIdsinteger[]

FleetDeviceId in INTEGER format. (Example: 123456).

status'active' | 'scheduled' | 'completed'

A job status in STRING format. Job statuses can be one of three (ignores case): "active", "scheduled", "completed" Valid values: active, scheduled, completed

customerNamestring

Customer name to filter by

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.

Response

OK response.

idstring

The job id of the failed request

uuidstring

The uuid of the failed request

Example response

{
  "data": [
    {
      "address": {
        "address": "1990 Alameda st, San Francisco, Ca 94103",
        "latitude": 37.456345,
        "longitude": 34.5633749,
        "name": "Worksite #1"
      },
      "createdAt": "2019-06-13T19:08:25Z",
      "customerName": "Samsara",
      "endDate": "2019-06-13T19:08:25Z",
      "fleetDevices": [
        {
          "id": 123456,
          "name": "My Device"
        }
      ],
      "id": "1553",
      "industrialAssets": [
        {
          "id": "8d218e6c-7a16-4f9f-90f7-cc1d93b9e596",
          "name": "My asset"
        }
      ],
      "modifiedAt": "2019-06-13T19:08:25Z",
      "name": "My Job Name",
      "notes": "These are my notes",
      "ontimeWindowAfterArrivalMs": 300000,
      "ontimeWindowBeforeArrivalMs": 300000,
      "startDate": "2019-06-13T19:08:25Z",
      "status": "active",
      "uuid": "8d218e6c-7a16-4f9f-90f7-cc1d93b9e596"
    }
  ],
  "id": "1553",
  "pagination": {
    "endCursor": "MjkY",
    "hasNextPage": true
  },
  "uuid": "8d218e6c-7a16-4f9f-90f7-cc1d93b9e596"
}

Changes

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