Change requests: Get
Description
Retrieve a single change request by its ID, in any status, including exports of the live story and the draft.
Request
HTTP Method: GET
| Path Parameter | Description |
|---|---|
| change_request_id | The ID of the change request. |
Sample request
curl --proto '=https' --tlsv1.2 -X GET \
https://<tenant-domain>/api/v1/change_requests/<<change_request_id>> \
-H 'content-type: application/json' \
-H 'Authorization: Bearer <<CREDENTIAL.tines_api_key>>'
Response
A successful request will return a JSON object describing the change request.
Field description
| Parameter | Description |
|---|---|
| id | The ID of the change request. Pass it as change_request_id, along with story_id, to approve, reject, cancel, or promote the change request. |
| name | Name of the change request. |
| description | Description of the change request. |
| status | Status of the change request: PENDING, APPROVED, REJECTED, PUSHED, or IN_PROGRESS. IN_PROGRESS means its author canceled it. |
| story_id | ID of the story the change request is for. Matches the ID in the story's URL. |
| story_name | Name of the live story. |
| team_id | ID of the team that owns the story. |
| draft_id | ID of the draft containing the changes. Matches the ID in the draft's URL. Null when the draft no longer exists. |
| draft_name | Name of the draft containing the changes. Null when the draft no longer exists. |
| user_id | ID of the user who created the change request. |
| participants | An array of IDs of the users who made changes in the change request. Usually empty once the change request is pushed. |
| created_at | ISO 8601 timestamp describing when the change request was created. |
| updated_at | ISO 8601 timestamp describing when the change request was last updated. |
| live_story_export | The export of the live story, as a JSON string. |
| draft_export | The export of the draft, as a JSON string. Null when the draft no longer exists. |
Sample response
{
"id": 21,
"name": "Add enrichment step",
"description": "Look up the sender before triage",
"status": "PENDING",
"story_id": 154,
"story_name": "Phishing triage",
"team_id": 42,
"draft_id": 1234,
"draft_name": "Initial draft",
"user_id": 7,
"participants": [7, 12],
"created_at": "2026-10-27T09:00:00Z",
"updated_at": "2026-10-27T09:00:00Z",
"live_story_export": "{\"schema_version\":26,\"name\":\"Phishing triage\",\"agents\":[]}",
"draft_export": "{\"schema_version\":26,\"name\":\"Phishing triage\",\"agents\":[{\"name\":\"Look up sender\"}]}"
}