GET
/
processes
curl --request GET \
  --url https://api.serial.io/processes \
  --header 'Authorization: Bearer <token>'
[
  {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "company_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "use_api": true,
    "record_operator": true,
    "is_mandatory": true,
    "break_prior_links": true,
    "dependent_process_ids": [
      "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    ],
    "type": "PRODUCTION",
    "revision": 123,
    "carbon_copy": {},
    "revision_description": "<string>",
    "is_latest_revision": true,
    "created_by_user_id": "<string>",
    "allow_batch": true,
    "approved": true,
    "approved_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "approved_at": "2023-11-07T05:31:56Z"
  }
]

Authorizations

Authorization
string
header
required

API Key or Token formatted as Bearer <YOUR_KEY_OR_TOKEN>

Query Parameters

name
string

Find a process by name

is_mandatory
boolean

Find processes by whether they are mandatory or not

component_id
string

Get Processes linked to a component id

show_steps
boolean

Show the process steps related to a process

process_id
string

Find process by its database id

Response

200
application/json
OK
id
string
company_id
string
name
string
created_at
string
use_api
boolean
record_operator
boolean
is_mandatory
boolean
dependent_process_ids
string[]
type
enum<string>
Available options:
PRODUCTION,
INSTANTIATION,
ASSIGN_WORK_ORDER
revision
integer
carbon_copy
object | null
revision_description
string | null
is_latest_revision
boolean
created_by_user_id
string | null
allow_batch
boolean
approved
boolean
approved_by
string
approved_at
string