Zum Hauptinhalt springen
GET
/
api
/
offers
/
{id}
/
approval
Get the approval state
curl --request GET \
  --url https://coreapi.io/api/offers/{id}/approval \
  --header 'Authorization: Bearer <token>'
{
  "requiresApproval": true,
  "canCurrentUserDecide": true,
  "request": {
    "id": "<string>",
    "step": {
      "order": 123,
      "approvers": [
        {
          "id": "<string>",
          "label": "<string>"
        }
      ],
      "name": "<string>"
    },
    "decisions": [
      {
        "account": "<string>",
        "decidedAt": "2023-11-07T05:31:56Z",
        "comment": "<string>"
      }
    ],
    "requestedBy": {
      "id": "<string>",
      "name": "<string>"
    },
    "requestedAt": "2023-11-07T05:31:56Z"
  }
}

Autorisierungen

​
Authorization
string
header
erforderlich

API token of the organisation. Send it as Authorization: Bearer api_... The token is bound to exactly one organisation.

Pfadparameter

​
id
string<ulid>
erforderlich

Offer ID (ULID).

Antwort

The approval sub-resource.

Internal approval state of an offer. Returned only to authenticated staff, never to the recipient.

​
versionApprovalStatus
enum<string>
erforderlich
Verfügbare Optionen:
not_required,
pending,
approved,
rejected,
superseded
​
requiresApproval
boolean
erforderlich

Whether an approval workflow applies.

​
canCurrentUserDecide
boolean
erforderlich

Whether the caller is a named approver who may decide now.

​
request
object

The running approval request. Null when none is pending.