Approvals

List approval flows

get

Authorizations

accessKey

HTTPRequired

Uses the Authorization header: 'AccessKey ' followed by your access key token (e.g., 'Authorization: AccessKey AbCdEfGhIjKlMnOpQrStUvWxYzAbCdEfGhIj')

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

422

Request validation failed

application/json

get

/organizations/{organizationId}/approvals

HTTPcURLJavaScriptPython

GET /organizations/{organizationId}/approvals HTTP/1.1
Host: api.bird.com
Authorization: AccessKey YOUR_SECRET_TOKEN
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-12-16T21:23:00.050Z",
      "updatedAt": "2025-12-16T21:23:00.050Z",
      "tags": [
        {
          "key": "text",
          "value": "text"
        }
      ]
    }
  ],
  "nextPageToken": "text"
}

Create approval flow

post

Authorizations

accessKey

HTTPRequired

Uses the Authorization header: 'AccessKey ' followed by your access key token (e.g., 'Authorization: AccessKey AbCdEfGhIjKlMnOpQrStUvWxYzAbCdEfGhIj')

Path parameters

organizationIdstringRequired

The organization ID

Body

application/json

namestringRequired

descriptionstringRequired

objectTypestring · mrnRequired

The identifier of the object

objectActionstring · enumRequired

The action performed on the object

Possible values:

Responses

201

OK

application/json

409

The HTTP 409 Conflict response status code indicates a request conflict with current state of the target resource.

application/json

422

Request validation failed

application/json

post

/organizations/{organizationId}/approvals

HTTPcURLJavaScriptPython

POST /organizations/{organizationId}/approvals HTTP/1.1
Host: api.bird.com
Authorization: AccessKey YOUR_SECRET_TOKEN
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-12-16T21:23:00.050Z",
  "updatedAt": "2025-12-16T21:23:00.050Z",
  "tags": [
    {
      "key": "text",
      "value": "text"
    }
  ]
}

Retrieve approval flow

get

Authorizations

accessKey

HTTPRequired

Uses the Authorization header: 'AccessKey ' followed by your access key token (e.g., 'Authorization: AccessKey AbCdEfGhIjKlMnOpQrStUvWxYzAbCdEfGhIj')

Path parameters

organizationIdstringRequired

The organization ID

approvalIdstring · uuidRequired

Responses

200

OK

application/json

404

Resource not found

application/json

get

/organizations/{organizationId}/approvals/{approvalId}

HTTPcURLJavaScriptPython

GET /organizations/{organizationId}/approvals/{approvalId} HTTP/1.1
Host: api.bird.com
Authorization: AccessKey YOUR_SECRET_TOKEN
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-12-16T21:23:00.050Z",
  "updatedAt": "2025-12-16T21:23:00.050Z",
  "tags": [
    {
      "key": "text",
      "value": "text"
    }
  ]
}

Delete approval flow

delete

Authorizations

accessKey

HTTPRequired

Uses the Authorization header: 'AccessKey ' followed by your access key token (e.g., 'Authorization: AccessKey AbCdEfGhIjKlMnOpQrStUvWxYzAbCdEfGhIj')

Path parameters

organizationIdstringRequired

The organization ID

approvalIdstring · uuidRequired

Responses

204

OK

No content

404

Resource not found

application/json

409

The HTTP 409 Conflict response status code indicates a request conflict with current state of the target resource.

application/json

delete

/organizations/{organizationId}/approvals/{approvalId}

HTTPcURLJavaScriptPython

DELETE /organizations/{organizationId}/approvals/{approvalId} HTTP/1.1
Host: api.bird.com
Authorization: AccessKey YOUR_SECRET_TOKEN
Accept: */*

No content

Update approval flow

patch

Authorizations

accessKey

HTTPRequired

Uses the Authorization header: 'AccessKey ' followed by your access key token (e.g., 'Authorization: AccessKey AbCdEfGhIjKlMnOpQrStUvWxYzAbCdEfGhIj')

Path parameters

organizationIdstringRequired

The organization ID

approvalIdstring · uuidRequired

Body

application/json

namestringOptional

descriptionstringOptional

objectTypestringOptional

objectActionstring · enumOptionalPossible values:

Responses

200

OK

application/json

404

Resource not found

application/json

409

The HTTP 409 Conflict response status code indicates a request conflict with current state of the target resource.

application/json

422

Request validation failed

application/json

patch

/organizations/{organizationId}/approvals/{approvalId}

HTTPcURLJavaScriptPython

PATCH /organizations/{organizationId}/approvals/{approvalId} HTTP/1.1
Host: api.bird.com
Authorization: AccessKey YOUR_SECRET_TOKEN
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-12-16T21:23:00.050Z",
  "updatedAt": "2025-12-16T21:23:00.050Z",
  "tags": [
    {
      "key": "text",
      "value": "text"
    }
  ]
}