GET
/
work-orders
curl --request GET \
  --url https://api.serial.io/work-orders \
  --header 'Authorization: Bearer <token>'
[
  {
    "id": "<string>",
    "wo_number": 1,
    "name": "<string>",
    "description": "<string>",
    "component_id": "<string>",
    "part_number_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "created_at": "2023-11-07T05:31:56Z",
    "created_by_user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "status": "DRAFT",
    "phase": "<string>",
    "quantity": 123,
    "approvals": {
      "[approver_user_id]": {
        "approver_user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "requested_by_user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "requested_at": "2023-11-07T05:31:56Z",
        "status": "<any>",
        "last_updated_at": "2023-11-07T05:31:56Z"
      }
    },
    "assignee_user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "deadline": "2023-11-07T05:31:56Z",
    "activity_log": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "message": "<string>",
        "added_at": "2023-11-07T05:31:56Z",
        "added_by_user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "type": "CREATED",
        "data": "<string>"
      }
    ],
    "last_edited_at": "2023-11-07T05:31:56Z",
    "attachments": [
      {
        "dataset_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "value": "<string>",
        "file_name": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "added_at": "2023-11-07T05:31:56Z",
        "added_by_user_id": "<string>",
        "is_deleted": true
      }
    ]
  }
]

Authorizations

​
Authorization
string
header
required

API Key or Token formatted as Bearer <YOUR_KEY_OR_TOKEN>

Response

200
application/json
OK
​
id
string
​
wo_number
integer
Required range: x > 0
​
name
string
​
description
string | null
​
component_id
string
​
part_number_id
string | null
​
created_at
string
​
created_by_user_id
string
​
status
enum<string>
default:
DRAFT
Available options:
DRAFT,
REVIEW,
PRODUCTION,
COMPLETE,
CANCELED,
ARCHIVED
​
phase
string
​
quantity
integer
​
approvals
object

Approvals object will have one key value pair for every approver

​
assignee_user_id
string | null
​
deadline
string | null
​
activity_log
object[]
​
last_edited_at
string | null
​
attachments
object[]

Multiple datasets can be added to the attachments object

Delete Component Instance LinkCreate a work order