OpenMax
Free Trial

Apps API · Approvals

Approvals: 7 endpoints

← All groups

GET /api/v1/approvals

List approval requests

Scope: work:approval:read · Called with: appToken · operationId: list-approval-requests

Required app scope: work:approval:read.

Lists approval requests for the active organization. Response wrapped in standard envelope.

Parameters

Name In Type Required Description
status query string Filter by approval status
kind query string Filter by approval kind; several kinds comma-separated (e.g. app_publish,app_install)
scope_type query string Filter by scope type
scope_id query string (uuid) Filter by scope UUID
action query string Filter by action
page query integer (int32) Page number (default: 1)
page_size query integer (int32) Items per page (default: 20, max: 100)
order_by query string Sort expression, e.g. created_at:desc

Responses

POST /api/v1/approvals

Create approval request

Scope: work:approval:write · Called with: appToken · operationId: create-approval-request

Required app scope: work:approval:write.

Creates a resource authorization or external share approval request. Response wrapped in standard envelope.

Request body

application/json · CreateApprovalRequestBody

Field Type Required Description
action string Requested action
approver_member_id string (uuid) Approver member UUID
detail any Approval request detail
kind string: resource_grant, external_share yes Approval request kind
policy_id string (uuid) Approval policy UUID
request_expires_at string (date-time) Request expiry time
request_reason string Request reason
scope_id string (uuid) yes Scope/resource UUID
scope_type string yes Scope/resource type

Responses

GET /api/v1/approvals/{approval_id}

Get approval request

Scope: work:approval:read · Called with: appToken · operationId: get-approval-request

Required app scope: work:approval:read.

Returns one approval request. Response wrapped in standard envelope.

Parameters

Name In Type Required Description
approval_id path string (uuid) yes Approval request UUID

Responses

POST /api/v1/approvals/{approval_id}/cancel

Cancel approval request

Scope: work:approval:write · Called with: appToken · operationId: cancel-approval-request

Required app scope: work:approval:write.

Cancels a pending approval request. app_publish / app_install requests answer 400: the submitter withdraws a version with withdraw-app-version. Response wrapped in standard envelope.

Parameters

Name In Type Required Description
approval_id path string (uuid) yes Approval request UUID

Request body

application/json · CancelApprovalRequestBody

Field Type Required Description
reason string Cancellation reason

Responses

POST /api/v1/approvals/{approval_id}/decide

Decide approval request

Scope: work:approval:decide · Called with: appToken · operationId: decide-approval-request

Required app scope: work:approval:decide.

Approves or rejects a pending approval request. app_publish / app_install requests are decided only by a human member holding app.manage who is not the requester (403 APP_PRINCIPAL_KIND_INVALID for Agents, 403 APP_SELF_APPROVAL_FORBIDDEN for the requester); approving publishes the version or installs the app in the same transaction (409 APP_VERSION_STATE_INVALID when the submission no longer matches, or when the app of an install request is no longer published, which also cancels that request). Response wrapped in standard envelope.

Parameters

Name In Type Required Description
approval_id path string (uuid) yes Approval request UUID

Request body

application/json · DecideApprovalRequestBody

Field Type Required Description
reason string Decision reason
status string: approved, rejected yes Decision status

Responses

POST /api/v1/approvals/{approval_id}/expire

Expire approval request

Scope: work:approval:write · Called with: appToken · operationId: expire-approval-request

Required app scope: work:approval:write.

Expires a pending approval request. app_publish / app_install requests never expire and answer 400. Response wrapped in standard envelope.

Parameters

Name In Type Required Description
approval_id path string (uuid) yes Approval request UUID

Request body

application/json · ExpireApprovalRequestBody

Field Type Required Description
reason string Expiry reason

Responses

POST /api/v1/approvals/{approval_id}/revoke

Revoke approval grant

Scope: work:approval:write · Called with: appToken · operationId: revoke-approval-grant

Required app scope: work:approval:write.

Revokes the authorization effect of an approved resource grant and records an approval.revoked audit event. app_publish / app_install requests answer 400 (an app is stopped by suspending or uninstalling it). Response wrapped in standard envelope.

Parameters

Name In Type Required Description
approval_id path string (uuid) yes Approval request UUID

Request body

application/json · RevokeApprovalRequestBody

Field Type Required Description
reason string Revoke reason

Responses