v3

latestSwagger 2.02026-08-067506752.0 MB

approval

Return approval chains

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

Path parameters

orgIdstring required

Org identifier (either id or slug)

Query parameters

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

The type of entity

entityIdstring

the id of the entity

fromstring

Approval chain id to start paginating from

limitinteger

Number of results to return

Response

successful operation

nextstring

Example response

{
  "data": [
    {
      "id": "588f7ee98f138b19220041a7",
      "orgId": "588f7ee98f138b19220041a7",
      "entityId": "588f7ee98f138b19220041a7",
      "entityType": "SCENARIO",
      "name": "Comp Review 06/15/2022",
      "fallbackApproverJobId": "588f7ee98f138b19220041a7",
      "approvalNotifierGroups": [
        {
          "groupId": "588f7ee98f138b19220041a7",
          "userIds": [
            "588f7ee98f138b19220041a7"
          ]
        }
      ],
      "createId": "588f7ee98f138b19220041a7",
      "createBehalfId": "588f7ee98f138b19220041a7",
      "createAttribution": {
        "principalUserId": "588f7ee98f138b19220041a7",
        "agentUserIds": [
          "588f7ee98f138b19220041a7"
        ],
        "eventId": "588f7ee98f138b19220041a7",
        "aiChatId": "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"
      ]
    }
  ]
}