Approvals

List approval flows

get

Authorizations

Path parameters

organizationIdstringrequired

The organization ID

Query parameters

pageTokenstring

Pagination token that keeps of track of the current position in the list

limitinteger · min: 1 · max: 100 · default: 10

Limits the number of results to return

reverseboolean · default: false

Order in which to retrieve the results

statusstring · enum · default: active

Options: active, deleted

objectTypestring · mrn

The identifier of the object

objectActionstring · enum

The action performed on the object

Options: create, update, delete

tagsstring

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/organizations/{organizationId}/approvals' \
  --header 'Authorization: Bearer jwt'

200

422

200

{
  "results": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "organizationId": "123e4567-e89b-12d3-a456-426614174000",
      "workspaceId": "123e4567-e89b-12d3-a456-426614174000",
      "ownerId": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "description": "text",
      "objectType": "text",
      "objectAction": "create",
      "steps": [
        {
          "type": "any",
          "users": [
            "123e4567-e89b-12d3-a456-426614174000"
          ],
          "reviewers": [
            {
              "type": "user",
              "id": "123e4567-e89b-12d3-a456-426614174000"
            }
          ],
          "message": "text"
        }
      ],
      "createdAt": "2025-03-19T04:02:36.499Z",
      "updatedAt": "2025-03-19T04:02:36.499Z",
      "tags": [
        {
          "key": "text",
          "value": "text"
        }
      ]
    }
  ],
  "nextPageToken": "text"
}

OK

Create approval flow

post

Authorizations

Path parameters

organizationIdstringrequired

The organization ID

Body

namestringrequired

descriptionstringrequired

objectTypestring · mrnrequired

The identifier of the object

objectActionstring · enumrequired

The action performed on the object

Options: create, update, delete

tagsobject[]

A tag that can be used to identify this flow.

stepsobject[]required

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/organizations/{organizationId}/approvals' \
  --header 'Authorization: Bearer jwt' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "text",
    "description": "text",
    "objectType": "text",
    "objectAction": "create",
    "tags": [
      {
        "key": "text",
        "value": "text"
      }
    ],
    "steps": [
      {
        "type": "any",
        "users": [
          "123e4567-e89b-12d3-a456-426614174000"
        ],
        "reviewers": [
          {
            "type": "user",
            "id": "123e4567-e89b-12d3-a456-426614174000"
          }
        ],
        "message": "text"
      }
    ]
  }'

201

409

422

201

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "organizationId": "123e4567-e89b-12d3-a456-426614174000",
  "workspaceId": "123e4567-e89b-12d3-a456-426614174000",
  "ownerId": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "description": "text",
  "objectType": "text",
  "objectAction": "create",
  "steps": [
    {
      "type": "any",
      "users": [
        "123e4567-e89b-12d3-a456-426614174000"
      ],
      "reviewers": [
        {
          "type": "user",
          "id": "123e4567-e89b-12d3-a456-426614174000"
        }
      ],
      "message": "text"
    }
  ],
  "createdAt": "2025-03-19T04:02:36.499Z",
  "updatedAt": "2025-03-19T04:02:36.499Z",
  "tags": [
    {
      "key": "text",
      "value": "text"
    }
  ]
}

OK

Retrieve approval flow

get

Authorizations

Path parameters

organizationIdstringrequired

The organization ID

approvalIdstring · uuidrequired

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/organizations/{organizationId}/approvals/{approvalId}' \
  --header 'Authorization: Bearer jwt'

200

404

200

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "organizationId": "123e4567-e89b-12d3-a456-426614174000",
  "workspaceId": "123e4567-e89b-12d3-a456-426614174000",
  "ownerId": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "description": "text",
  "objectType": "text",
  "objectAction": "create",
  "steps": [
    {
      "type": "any",
      "users": [
        "123e4567-e89b-12d3-a456-426614174000"
      ],
      "reviewers": [
        {
          "type": "user",
          "id": "123e4567-e89b-12d3-a456-426614174000"
        }
      ],
      "message": "text"
    }
  ],
  "createdAt": "2025-03-19T04:02:36.499Z",
  "updatedAt": "2025-03-19T04:02:36.499Z",
  "tags": [
    {
      "key": "text",
      "value": "text"
    }
  ]
}

OK

Delete approval flow

delete

Authorizations

Path parameters

organizationIdstringrequired

The organization ID

approvalIdstring · uuidrequired

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url '/organizations/{organizationId}/approvals/{approvalId}' \
  --header 'Authorization: Bearer jwt'

204

404

409

204

No body

OK

Update approval flow

patch

Authorizations

Path parameters

organizationIdstringrequired

The organization ID

approvalIdstring · uuidrequired

Body

namestring

descriptionstring

objectTypestring

objectActionstring · enum

Options: create, update, delete

stepsobject[]

Responses

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PATCH \
  --url '/organizations/{organizationId}/approvals/{approvalId}' \
  --header 'Authorization: Bearer jwt' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "text",
    "description": "text",
    "objectType": "text",
    "objectAction": "create",
    "steps": [
      {
        "type": "any",
        "users": [
          "123e4567-e89b-12d3-a456-426614174000"
        ],
        "reviewers": [
          {
            "type": "user",
            "id": "123e4567-e89b-12d3-a456-426614174000"
          }
        ],
        "message": "text"
      }
    ]
  }'

200

404

409

422

200

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "organizationId": "123e4567-e89b-12d3-a456-426614174000",
  "workspaceId": "123e4567-e89b-12d3-a456-426614174000",
  "ownerId": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "description": "text",
  "objectType": "text",
  "objectAction": "create",
  "steps": [
    {
      "type": "any",
      "users": [
        "123e4567-e89b-12d3-a456-426614174000"
      ],
      "reviewers": [
        {
          "type": "user",
          "id": "123e4567-e89b-12d3-a456-426614174000"
        }
      ],
      "message": "text"
    }
  ],
  "createdAt": "2025-03-19T04:02:36.499Z",
  "updatedAt": "2025-03-19T04:02:36.499Z",
  "tags": [
    {
      "key": "text",
      "value": "text"
    }
  ]
}

OK