List approval requests

GET/api/v1/approvals

Authorization

AuthorizationOAuth2 access token · headerrequired

Authorization-code grant with PKCE. Clients are public and hold no secret. Discovery is published at /.well-known/oauth-authorization-server/api/auth.

Scopes:api.access

Responses

200

Every request the caller may read

Array of ApprovalRequest

activeStageintegerrequired

min -9007199254740991 · max 9007199254740991

contentHashstringrequired

createdAtstring<date-time>required

matches ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$

definitionIdstringrequired

min length 1 · max length 255

idstringrequired

min length 1 · max length 255

organizationIdstringrequired

min length 1 · max length 255

recordIdstringrequired

min length 1 · max length 255

recordRevisionintegerrequired

min 1 · max 2147483647

snapshotobjectrequired

stagesApprovalStage[]required

Show properties

Array of ApprovalStage

approverUserIdstringrequired

min length 1 · max length 255

labelstringrequired

stateApprovalStaterequired

Allowed:pendingapprovedrejectedwithdrawn

submittedBystringrequired

min length 1 · max length 255

400

The request body, query or parameters were refused

codestringrequired

Allowed:invalid_inputnot_foundconflictforbidden

detailany

errorstringrequired

reasonstring

401

The access token is missing, invalid or revoked

errorstringrequired

403

The tenant's module is off, or the token's scope or the member's role does not permit the action

codestringrequired

Allowed:invalid_inputnot_foundconflictforbidden

detailany

errorstringrequired

reasonstring

404

No such record, or none the caller may read

codestringrequired

Allowed:invalid_inputnot_foundconflictforbidden

detailany

errorstringrequired

reasonstring

413

The request exceeds the route's body limit

errorstringrequired

500

An unexpected failure

errorstringrequired

Request

curl -X GET '/api/v1/api/v1/approvals' \
  -H 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  -H 'Accept: application/json'

const response = await fetch("/api/v1/api/v1/approvals", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_ACCESS_TOKEN",
    "Accept": "application/json"
  }
});

import requests

response = requests.get(
    "/api/v1/api/v1/approvals",
    headers={
        "Authorization": "Bearer YOUR_ACCESS_TOKEN",
        "Accept": "application/json"
    },
)

Response

[
  {
    "activeStage": -9007199254740991,
    "contentHash": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "definitionId": "string",
    "id": "string",
    "organizationId": "string",
    "recordId": "string",
    "recordRevision": 1,
    "snapshot": {
      "property1": "string",
      "property2": "string"
    },
    "stages": [
      {
        "approverUserId": "string",
        "label": "string"
      }
    ],
    "state": "pending",
    "submittedBy": "string"
  }
]

{
  "code": "invalid_input",
  "detail": null,
  "error": "string",
  "reason": "string"
}

{
  "error": "string"
}

{
  "code": "invalid_input",
  "detail": null,
  "error": "string",
  "reason": "string"
}

{
  "code": "invalid_input",
  "detail": null,
  "error": "string",
  "reason": "string"
}

{
  "error": "string"
}

{
  "error": "string"
}