Sign in

v3

latestSwagger 2.02026-08-067506752.0 MB
approval

Return all approval requests for an approval chain

get/v1/org/{orgId}/approval-chain/{approvalChainId}/request

Path parameters

orgIdstring required

Org identifier (either id or slug)

approvalChainIdstring required

Approval chain id

Query parameters

limitinteger

Number of results to return

entityType'COMP_REVIEW' | 'SCENARIO' | 'TIMEOFF'

entity type to filter on

entityIdsstring

entity ids to filter on

Response

successful operation

nextstring

Example response

{
  "data": [
    {
      "id": "588f7ee98f138b19220041a7",
      "orgId": "588f7ee98f138b19220041a7",
      "entityId": "588f7ee98f138b19220041a7",
      "compReviewId": "588f7ee98f138b19220041a7",
      "approvalChainId": "588f7ee98f138b19220041a7",
      "createId": "588f7ee98f138b19220041a7",
      "createBehalfId": "588f7ee98f138b19220041a7",
      "createAttribution": {
        "principalUserId": "588f7ee98f138b19220041a7",
        "agentUserIds": [
          "588f7ee98f138b19220041a7"
        ],
        "eventId": "588f7ee98f138b19220041a7",
        "aiChatId": "588f7ee98f138b19220041a7"
      },
      "stageOverrides": [
        {
          "stageOverrideId": "588f7ee98f138b19220041a7",
          "approvalChainStageId": "588f7ee98f138b19220041a7",
          "groups": [
            {
              "groupId": "588f7ee98f138b19220041a7",
              "approvers": [
                {
                  "jobId": "588f7ee98f138b19220041a7",
                  "commentId": "588f7ee98f138b19220041a7",
                  "reassignCommentId": "588f7ee98f138b19220041a7",
                  "fallbackFor": "588f7ee98f138b19220041a7",
                  "actedByJobId": "588f7ee98f138b19220041a7"
                }
              ]
            }
          ]
        }
      ],
      "createAt": "2017-01-24T13:57:52Z",
      "updateId": "588f7ee98f138b19220041a7",
      "updateBehalfId": "588f7ee98f138b19220041a7",
      "updateAttribution": {
        "principalUserId": "588f7ee98f138b19220041a7",
        "agentUserIds": [
          "588f7ee98f138b19220041a7"
        ],
        "eventId": "588f7ee98f138b19220041a7",
        "aiChatId": "588f7ee98f138b19220041a7"
      },
      "updateAt": "2017-01-24T13:57:52Z",
      "deleteId": "588f7ee98f138b19220041a7",
      "deleteBehalfId": "588f7ee98f138b19220041a7",
      "deleteAttribution": {
        "principalUserId": "588f7ee98f138b19220041a7",
        "agentUserIds": [
          "588f7ee98f138b19220041a7"
        ],
        "eventId": "588f7ee98f138b19220041a7",
        "aiChatId": "588f7ee98f138b19220041a7"
      },
      "deleteAt": "2017-01-24T13:57:52Z"
    }
  ],
  "access": [
    {
      "ids": [
        "588f7ee98f138b19220041a7"
      ]
    }
  ]
}