List work orders

GET

work-orders

List work orders

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

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.oncanary.com/v1/work-orders', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "data": [
    {
      "id": "<string>",
      "title": "<string>",
      "description": "<string>",
      "type": "preventive",
      "status": "open",
      "priority": "low",
      "requested_by": "<string>",
      "creator_id": "<string>",
      "assigned_to_user_id": "<string>",
      "assigned_to_team_id": "<string>",
      "asset_id": "<string>",
      "location_id": "<string>",
      "due_date": "2023-11-07T05:31:56Z",
      "scheduled_start": "2023-11-07T05:31:56Z",
      "estimated_hours": 4999.995,
      "recurrence_info": {
        "type": "DAILY",
        "interval": 1,
        "days": [
          "SUNDAY"
        ],
        "day": 16
      },
      "previous_id": "<string>",
      "next_id": "<string>",
      "completed_at": "2023-11-07T05:31:56Z",
      "completer_id": "<string>",
      "completion_summary": "<string>",
      "inventory_reconciliation_required": true,
      "image_url": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "extraFields": {}
    }
  ],
  "meta": {
    "request_id": "<string>",
    "api_version": "<string>",
    "pagination": {
      "has_more": true,
      "cursor": "<string>",
      "total_count": 1
    }
  }
}

{
  "type": "https://api.oncanary.com/errors/validation_error",
  "title": "Validation Error",
  "status": 400,
  "detail": "Request validation failed",
  "request_id": "req_01JAY8FVDM6CH4R3X9Q2T7K5NP",
  "code": "validation_error"
}

{
  "type": "https://api.oncanary.com/errors/validation_error",
  "title": "Validation Error",
  "status": 400,
  "detail": "Request validation failed",
  "request_id": "req_01JAY8FVDM6CH4R3X9Q2T7K5NP",
  "code": "validation_error"
}

{
  "type": "https://api.oncanary.com/errors/validation_error",
  "title": "Validation Error",
  "status": 400,
  "detail": "Request validation failed",
  "request_id": "req_01JAY8FVDM6CH4R3X9Q2T7K5NP",
  "code": "validation_error"
}

{
  "type": "https://api.oncanary.com/errors/validation_error",
  "title": "Validation Error",
  "status": 400,
  "detail": "Request validation failed",
  "request_id": "req_01JAY8FVDM6CH4R3X9Q2T7K5NP",
  "code": "validation_error"
}

Authorizations

Authorization

string

header

required

Organization API key with an sk_live_ or sk_test_ prefix

Query Parameters

limit

integer

default:20

Maximum number of items to return from a Canary-native list (1-100)

Required range: 1 <= x <= 100

cursor

string

Pagination cursor from previous response

direction

enum<string>

default:desc

Sort direction

Available options:

asc,

desc

status

enum<string>

Filter by status (use 'todo' for open, on-hold, and in-progress work)

Available options:

open,

on_hold,

in_progress,

done,

canceled,

skipped,

todo

type

enum<string>

Filter by work-order type

Available options:

preventive,

reactive,

other,

cycle_count

priority

enum<string>

Filter by priority

Available options:

low,

medium,

high,

critical

asset_id

string

Filter by asset ID

location_id

string

Filter by location ID

assigned_to_user_id

string

Filter by assigned user ID

assigned_to_team_id

string

Filter by assigned team ID

Response

List of work orders

data

object[]

required

Show child attributes

meta

object

required

Show child attributes

List work orders

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

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.oncanary.com/v1/work-orders', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "data": [
    {
      "id": "<string>",
      "title": "<string>",
      "description": "<string>",
      "type": "preventive",
      "status": "open",
      "priority": "low",
      "requested_by": "<string>",
      "creator_id": "<string>",
      "assigned_to_user_id": "<string>",
      "assigned_to_team_id": "<string>",
      "asset_id": "<string>",
      "location_id": "<string>",
      "due_date": "2023-11-07T05:31:56Z",
      "scheduled_start": "2023-11-07T05:31:56Z",
      "estimated_hours": 4999.995,
      "recurrence_info": {
        "type": "DAILY",
        "interval": 1,
        "days": [
          "SUNDAY"
        ],
        "day": 16
      },
      "previous_id": "<string>",
      "next_id": "<string>",
      "completed_at": "2023-11-07T05:31:56Z",
      "completer_id": "<string>",
      "completion_summary": "<string>",
      "inventory_reconciliation_required": true,
      "image_url": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "extraFields": {}
    }
  ],
  "meta": {
    "request_id": "<string>",
    "api_version": "<string>",
    "pagination": {
      "has_more": true,
      "cursor": "<string>",
      "total_count": 1
    }
  }
}

{
  "type": "https://api.oncanary.com/errors/validation_error",
  "title": "Validation Error",
  "status": 400,
  "detail": "Request validation failed",
  "request_id": "req_01JAY8FVDM6CH4R3X9Q2T7K5NP",
  "code": "validation_error"
}

{
  "type": "https://api.oncanary.com/errors/validation_error",
  "title": "Validation Error",
  "status": 400,
  "detail": "Request validation failed",
  "request_id": "req_01JAY8FVDM6CH4R3X9Q2T7K5NP",
  "code": "validation_error"
}

{
  "type": "https://api.oncanary.com/errors/validation_error",
  "title": "Validation Error",
  "status": 400,
  "detail": "Request validation failed",
  "request_id": "req_01JAY8FVDM6CH4R3X9Q2T7K5NP",
  "code": "validation_error"
}

{
  "type": "https://api.oncanary.com/errors/validation_error",
  "title": "Validation Error",
  "status": 400,
  "detail": "Request validation failed",
  "request_id": "req_01JAY8FVDM6CH4R3X9Q2T7K5NP",
  "code": "validation_error"
}

API essentials

Work management

Equipment

Inventory

Organization data

Authorizations

Query Parameters

Response