Sign in

v1

latestOpenAPI 3.0.22026-07-26191278525.6 KB
Approval Workflow

Get Approval Workflow

Get an approval workflow by entity type and entity id

get/api/v2/ats/{entityType}/approval-workflow/{entityId}

Path parameters

entityTypestring required

Entity type

entityIdinteger required

Entity id

Headers

Authorizationstring required

The secret key to access the api. It starts with the bearer token

Response

OK

statusstring nullable

Current status of the approval workflow.

createdAtstring date-time nullable

Datetime when the approval workflow was created

entityTypestring nullable

Type of the entity associated with the approval workflow.

entityIdinteger nullable

ID of the entity associated with the approval workflow.

approvalWorkflowIdinteger nullable

ID of the approval workflow.

groupIdstring nullable

Group id

updatedAtstring date-time nullable

Datetime when the approval workflow was last updated

triggerApprovalboolean nullable

Whether to initiate the approval process. If true, emails will be sent to approvers.