Skip to main content
GET
Get process by ID

Authorizations

Authorization
string
header
required

HTTP Basic Authentication with API credentials

Path Parameters

processid
integer
required

Process ID

Response

Process details

Organisations are limited to those the caller belongs to; steps are every step of the process, ordered by status (START, CURRENT, END) then rank.

_self
string<uri-reference>

URL of the resource

id
integer

Process identifier

name
string

Process name

organisations
object
steps
object
companion
object | null

Companion app configuration of the process; null when the process is not configured.

_schema
string<uri-reference>
_status
enum<string>
Available options:
OK