No-code docs

Approvals

List approval flows

get
Authorizations
Path parameters
organizationIdstringRequired

The organization ID

Query parameters
pageTokenstringOptional

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

limitinteger · min: 1 · max: 100Optional

Limits the number of results to return

Default: 10
reversebooleanOptional

Order in which to retrieve the results

Default: false
statusstring · enumOptionalDefault: activePossible values:
objectTypestring · mrnOptional

The identifier of the object

objectActionstring · enumOptional

The action performed on the object

Possible values:
tagsstringOptional
Responses
200
OK
application/json
Responseall of
and
get
GET /organizations/{organizationId}/approvals HTTP/1.1
Host: 
Authorization: Bearer jwt
Accept: */*

{
  "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",
          "reviewers": [
            {
              "type": "user",
              "id": "123e4567-e89b-12d3-a456-426614174000"
            }
          ],
          "message": "text"
        }
      ],
      "createdAt": "2025-07-05T17:15:31.185Z",
      "updatedAt": "2025-07-05T17:15:31.185Z",
      "tags": [
        {
          "key": "text",
          "value": "text"
        }
      ]
    }
  ],
  "nextPageToken": "text"
}

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

Possible values:
Responses
201
OK
application/json
post
POST /organizations/{organizationId}/approvals HTTP/1.1
Host: 
Authorization: Bearer jwt
Content-Type: application/json
Accept: */*
Content-Length: 235

{
  "name": "text",
  "description": "text",
  "objectType": "text",
  "objectAction": "create",
  "tags": [
    {
      "key": "text",
      "value": "text"
    }
  ],
  "steps": [
    {
      "type": "any",
      "reviewers": [
        {
          "type": "user",
          "id": "123e4567-e89b-12d3-a456-426614174000"
        }
      ],
      "message": "text"
    }
  ]
}
{
  "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",
      "reviewers": [
        {
          "type": "user",
          "id": "123e4567-e89b-12d3-a456-426614174000"
        }
      ],
      "message": "text"
    }
  ],
  "createdAt": "2025-07-05T17:15:31.185Z",
  "updatedAt": "2025-07-05T17:15:31.185Z",
  "tags": [
    {
      "key": "text",
      "value": "text"
    }
  ]
}

Retrieve approval flow

get
Authorizations
Path parameters
organizationIdstringRequired

The organization ID

approvalIdstring · uuidRequired
Responses
200
OK
application/json
get
GET /organizations/{organizationId}/approvals/{approvalId} HTTP/1.1
Host: 
Authorization: Bearer jwt
Accept: */*

{
  "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",
      "reviewers": [
        {
          "type": "user",
          "id": "123e4567-e89b-12d3-a456-426614174000"
        }
      ],
      "message": "text"
    }
  ],
  "createdAt": "2025-07-05T17:15:31.185Z",
  "updatedAt": "2025-07-05T17:15:31.185Z",
  "tags": [
    {
      "key": "text",
      "value": "text"
    }
  ]
}

Delete approval flow

delete
Authorizations
Path parameters
organizationIdstringRequired

The organization ID

approvalIdstring · uuidRequired
Responses
204
OK
delete
DELETE /organizations/{organizationId}/approvals/{approvalId} HTTP/1.1
Host: 
Authorization: Bearer jwt
Accept: */*

No content

Update approval flow

patch
Authorizations
Path parameters
organizationIdstringRequired

The organization ID

approvalIdstring · uuidRequired
Body
namestringOptional
descriptionstringOptional
objectTypestringOptional
objectActionstring · enumOptionalPossible values:
Responses
200
OK
application/json
patch
PATCH /organizations/{organizationId}/approvals/{approvalId} HTTP/1.1
Host: 
Authorization: Bearer jwt
Content-Type: application/json
Accept: */*
Content-Length: 196

{
  "name": "text",
  "description": "text",
  "objectType": "text",
  "objectAction": "create",
  "steps": [
    {
      "type": "any",
      "reviewers": [
        {
          "type": "user",
          "id": "123e4567-e89b-12d3-a456-426614174000"
        }
      ],
      "message": "text"
    }
  ]
}
{
  "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",
      "reviewers": [
        {
          "type": "user",
          "id": "123e4567-e89b-12d3-a456-426614174000"
        }
      ],
      "message": "text"
    }
  ],
  "createdAt": "2025-07-05T17:15:31.185Z",
  "updatedAt": "2025-07-05T17:15:31.185Z",
  "tags": [
    {
      "key": "text",
      "value": "text"
    }
  ]
}

Last updated

Was this helpful?