Skip to main content

Approval Workflows

When an API Product is configured to require approval for subscriptions, an approval request is automatically created. Administrators can then approve or decline the request.

List approval requests​

curl -X GET "https://<your-subdomain>.backend.<region>.controlplane.boomi.com/approvalRequests?page=1&size=10" \
  -H "Authorization: Bearer <your-token>"

Filter parameters​

ParameterTypeDescription
statusstringPENDING, APPROVED, or DECLINED
apiProductUUIDFilter by API product
applicationUUIDFilter by application

Get an approval request​

curl -X GET "https://<your-subdomain>.backend.<region>.controlplane.boomi.com/approvalRequests/<request-id>" \
  -H "Authorization: Bearer <your-token>"

Approve a request​

curl -X PUT "https://<your-subdomain>.backend.<region>.controlplane.boomi.com/approvalRequests/<request-id>/approve" \
  -H "Authorization: Bearer <your-token>"

Decline a request​

curl -X PUT "https://<your-subdomain>.backend.<region>.controlplane.boomi.com/approvalRequests/<request-id>/decline" \
  -H "Authorization: Bearer <your-token>"

Add a comment to an approval request​

curl -X POST "https://<your-subdomain>.backend.<region>.controlplane.boomi.com/approvalRequests/<request-id>/comments" \
  -H "Authorization: Bearer <your-token>" \
  -H "Content-Type: application/json" \
  -d '{
    "comment": "Please provide more details about the use case."
  }'

Pending approval requests​

List only pending approval requests for the current user:

curl -X GET "https://<your-subdomain>.backend.<region>.controlplane.boomi.com/approvalRequests/pending" \
  -H "Authorization: Bearer <your-token>"