Skip to main content
GET
Get Procedure

Authorizations

Authorization
string
header
required

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

Path Parameters

id
string
required
Example:

"cm0upgshc000rwf5eop1u2awr"

Response

Retrieve procedure

id
string
required
Example:

"cm0upgshc000rwf5eop1u2awr"

name
string
required
Example:

"Proced AI title"

priority
enum<string>
required
Available options:
LOW,
MEDIUM,
HIGH
Example:

"MEDIUM"

state
enum<string>
required
Available options:
TODO,
IN_PROGRESS,
COMPLETED,
WAITING
Example:

"TODO"

creatorId
string
required
Example:

"cm2uj5ffn001x7xtag73jmpx0"

position
number
required
Example:

1

dueAt
string
required
Example:

"2024-09-22T22:00:00.000Z"

createdAt
string
required
Example:

"2024-09-22T22:00:00.000Z"

updatedAt
string
required
Example:

"2024-09-22T22:00:00.000Z"

projectId
string
required
Example:

"cm2uj5ffn001x7xtag73jmpx0"

workspaceId
string
required
Example:

"cm2uj5ffn001x7xtag73jmpx0"

displayVideo
boolean
required
Example:

true

isFineTunedData
boolean
required
Example:

false

shortId
string | null
Example:

"cm0upgshc000rwf5eop1u2awr"

content
string | null
Example:

"Procedure content goes here."

categoryId
string | null
Example:

"cm2uqwcpd002s7xta3b1j8q3p"

doerId
string | null
Example:

"cm2uj5ffn001x7xtag73jmpx0"

captureId
string | null
Example:

"cm2uqwcpd002s7xta3b1j8q3p"

category
object | null
doer
object | null
project
object | null
comments
object[] | null