Approvals
The organization ID
Pagination token that keeps of track of the current position in the list
Limits the number of results to return
10
Order in which to retrieve the results
false
active
Possible values: The identifier of the object
The action performed on the object
OK
Request validation failed
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-08-15T18:24:39.036Z",
"updatedAt": "2025-08-15T18:24:39.036Z",
"tags": [
{
"key": "text",
"value": "text"
}
]
}
],
"nextPageToken": "text"
}
The organization ID
The identifier of the object
The action performed on the object
OK
The HTTP 409 Conflict response status code indicates a request conflict with current state of the target resource.
Request validation failed
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-08-15T18:24:39.036Z",
"updatedAt": "2025-08-15T18:24:39.036Z",
"tags": [
{
"key": "text",
"value": "text"
}
]
}
The organization ID
OK
Resource not found
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-08-15T18:24:39.036Z",
"updatedAt": "2025-08-15T18:24:39.036Z",
"tags": [
{
"key": "text",
"value": "text"
}
]
}
The organization ID
OK
Resource not found
The HTTP 409 Conflict response status code indicates a request conflict with current state of the target resource.
DELETE /organizations/{organizationId}/approvals/{approvalId} HTTP/1.1
Host:
Authorization: Bearer jwt
Accept: */*
No content
The organization ID
OK
Resource not found
The HTTP 409 Conflict response status code indicates a request conflict with current state of the target resource.
Request validation failed
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-08-15T18:24:39.036Z",
"updatedAt": "2025-08-15T18:24:39.036Z",
"tags": [
{
"key": "text",
"value": "text"
}
]
}
Last updated
Was this helpful?