Gets work orders.

Gets work orders.

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

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

GET /maintenance/work-orders

Gets work orders.

cURL

curl --request GET \
  --url https://api.samsara.com/maintenance/work-orders \
  --header 'Authorization: Bearer <token>'

200

{
  "data": [
    {
      "assetId": "12443",
      "createdAtTime": "2019-06-13T19:08:25Z",
      "id": "5",
      "status": "OPEN",
      "updatedAtTime": "2019-06-13T19:08:25Z",
      "archivedAtTime": "2019-06-13T19:08:25Z",
      "assignedUserId": "1234",
      "attachments": [
        {
          "id": "9814a1fa-f0c6-408b-bf85-51dc3bc71ac7",
          "processingStatus": "processing",
          "url": "https://samsara-forms-submission-media-uploads.s3.us-west-2.amazonaws.com/123456",
          "urlExpiresAt": "2019-06-13T19:08:25Z"
        }
      ],
      "category": "PREVENTIVE",
      "closingNotes": "Everything was fixed without issues.",
      "completedAtTime": "2019-06-13T19:08:25Z",
      "createdByUserId": "1234",
      "description": "The vehicle is not starting.",
      "discount": {
        "basisPoints": 500,
        "money": {
          "amount": "94.01",
          "currency": "usd"
        }
      },
      "dueAtTime": "2019-06-13T19:08:25Z",
      "engineHours": 91823,
      "invoiceNumber": "123456",
      "items": [
        {
          "id": "9814a1fa-f0c6-408b-bf85-51dc3bc71ac7",
          "type": "ISSUE"
        }
      ],
      "odometerMeters": 91823,
      "poNumber": "123456",
      "priority": "HIGH",
      "serviceTaskInstances": [
        {
          "id": "9814a1fa-f0c6-408b-bf85-51dc3bc71ac7",
          "serviceTaskId": "9814a1fa-f0c6-408b-bf85-51dc3bc71ac7",
          "status": "Unknown",
          "laborHourlyCost": {
            "amount": "94.01",
            "currency": "usd"
          },
          "laborTimeMinutes": 60,
          "parts": [
            {
              "id": "9814a1fa-f0c6-408b-bf85-51dc3bc71ac7",
              "partId": "P0077",
              "quantity": 2.5,
              "costCentsOverride": 1000
            }
          ],
          "partsCost": {
            "amount": "94.01",
            "currency": "usd"
          }
        }
      ],
      "tax": {
        "basisPoints": 700,
        "money": {
          "amount": "94.01",
          "currency": "usd"
        }
      },
      "unallocatedLabor": {
        "cost": {
          "amount": "94.01",
          "currency": "usd"
        },
        "timeMinutes": 60
      },
      "vendorUuid": "5523a39f-42ef-4820-83d0-dfe73dbe7853"
    }
  ],
  "pagination": {
    "endCursor": "MjkY",
    "hasNextPage": true
  }
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

ids · string[]

Filter by the IDs. Up to 100 ids. Returns all if no ids are provided.

after · 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.

Response

200

application/json

OK response.

data · object[] · required

Work Orders

Show child attributes

pagination · object · required

Pagination parameters.

Show child attributes