List Change Approvals
Retrieve a paginated list of all approvals linked to a module object (Change, Incident, Service Request, or other supported module).
URL: GET /api/v1/change/{change_id}/approval
Example: GET http://172.16.15.185/api/v1/change/13/approval
Path Variables
| Variable | Type | Description |
|---|---|---|
{ref_id} | long | ID of the Change record. |
Request Headers
| Key | Description |
|---|---|
Authorization | Bearer {access token obtained after authorization} |
Content-Type | application/json |
Example Request
curl --location 'http://172.16.15.185/api/v1/change/13/approval' \
--header 'Authorization: Apikey wGjCygm6LvI7J1LT%40HHW%2Bs0ighXw7TeP5biyBL1uvBkzRnKMidKLUsz%2FIHEIn9w%3D%3D'
Example Response (200 OK)
{
"objectList": [
{
"id": 117,
"subject": "Approval Required for - CHG-13",
"description": null,
"status": "pending",
"decisionRule": null,
"totalStages": 1,
"currentStageNumber": 1,
"makerCheckerApproval": false,
"refId": 13,
"model": "change",
"createdAt": 1786691665020,
"updatedAt": 1786691665030
}
],
"totalCount": 1
}
Response Fields
| Field | Type | Description |
|---|---|---|
objectList | array | List of approval summary objects. |
totalCount | int | Total number of approvals for the object. |
id | long | Unique approval ID. Use this value in subsequent endpoints. |
subject | string | Approval subject line. |
description | string | Approval description text. |
status | string | Overall approval status: pending, approved, rejected, or cancelled. |
decisionRule | string | Decision logic of the active stage: unanimous, majority, or any_one. |
totalStages | int | Total number of stages defined in the approval. |
currentStageNumber | int | Currently active stage number. Returns 0 if the approval has not started. |
makerCheckerApproval | boolean | true if this is a maker-checker approval. |
refId | long | ID of the parent module object. |
model | string | Module name of the parent object (for example, change). |
createdAt | long or string | Creation timestamp. Epoch milliseconds by default; formatted string when ?pretty=true is set. |
updatedAt | long or string | Last update timestamp. Epoch milliseconds by default; formatted string when ?pretty=true is set. |
Stage Details Not Included
This endpoint returns approval summaries only. To retrieve stages and approvers, call GET Approval Detail with the id returned here.
Error Responses
| Scenario | HTTP Status | When It Occurs |
|---|---|---|
Invalid {module} value | 400 Bad Request | {module} does not match a known module identifier. |
Invalid {ref_id} (less than or equal to 0) | 400 Bad Request | A negative or zero object ID was provided. |
| Unauthorized | 401 Unauthorized | Session expired or no valid credentials were provided. |