Pleaxy

Raise purchase orders, approve and pay invoices, and set up your workspace.

API reference

Approvals

The purchase orders and invoices waiting on you.

More about this resource

The caller's own approval queue: the purchase orders and invoices whose current step names them.

Endpoints

List approvals

Lists the documents waiting for your approval.

GET/v1/workspaces/{regionId}/approvals

Returns

200 OK with the object shown in the response.

More details

Lists the purchase orders and invoices in this workspace whose current approval step names the caller, and, for an administrator, the documents whose current step names nobody and so needs an approver assigned.

Changed 2026-09-24, a security fix inside v1: needsAssignment is filled only for a signed-in administrator, the only caller who can reassign a step. For an API key, whatever its procurement role, every list is empty: no approval step can name a key.

Response fields

  • purchaseOrders / invoicesarray

    Documents at a step that names the caller.

  • needsAssignmentobject

    Documents whose current step names nobody. Empty unless the caller is a signed-in administrator.

Errors

  • 401 Unauthorized - No credential was presented, or the Bearer token / X-Api-Key value is missing, invalid, expired, or revoked.
  • 403 Forbidden - The caller's Bearer token or API key doesn't grant access to this workspace (regionId), or lacks the required role.
GET /v1/workspaces/{regionId}/approvals
Request
curl "$PLEAXY_API_BASE_URL/v1/workspaces/{regionId}/approvals" \
  -H "X-Api-Key: $PLEAXY_API_KEY"
Response · 200 OK
{
   "purchaseOrders": [ PurchaseOrder ],
   "invoices": [ Invoice ],
   "needsAssignment": { "purchaseOrders": [ PurchaseOrder ], "invoices": [ Invoice ] }
}
Talk to us