API referenceApprovals

Movements awaiting a signature

Everything waiting on a decision, newest first. Defaults to `pending` because that is the working queue; the decided ones are an archive somebody goes looking for, and defaulting to all of them would bury today's three payouts under last quarter's four hundred.

GET
/api/b/v1/approvals

Everything waiting on a decision, newest first.

Defaults to pending because that is the working queue; the decided ones are an archive somebody goes looking for, and defaulting to all of them would bury today's three payouts under last quarter's four hundred.

Authorization

OAuth2PasswordBearer
AuthorizationBearer <token>

In: header

Query Parameters

status?|

Defaults to pending — the queue, rather than the archive.

subject_type?|null
limit?Limit
Range1 <= value <= 200
Default50
offset?Offset
Range0 <= value
Default0
admin_access_token?string|null

Response Body

application/json

application/json

curl -X GET "https://example.com/api/b/v1/approvals"
{  "approvals": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "subject_type": "payout",      "subject_id": "80e197be-61ad-4068-b4ff-a483fb5c18f9",      "amount_minor": 0,      "currency": "string",      "status": "pending",      "required_approvals": 0,      "current_level": 1,      "levels": [        {}      ],      "approvals_recorded": 0,      "initiated_by": "9f5ebe27-153d-4963-8417-06d50be356ec",      "initiated_by_name": "string",      "created_at": "2019-08-24T14:15:22Z",      "decided_at": "2019-08-24T14:15:22Z"    }  ]}

Retire an approval threshold DELETE

Take a threshold out of use. Flagged inactive rather than deleted, so "what control was in force in March" stays answerable.

One approval, with its decisions GET

The request and every answer recorded against it so far. A pending request with no decisions is normal — it means nobody has looked yet, which is different from somebody having declined.