Change requests: List
Description
Retrieve a list of change requests across stories, newest first. Only the latest change request for each draft is returned.
Request
HTTP Method: GET
| Query Parameter | Description |
|---|---|
| team_id | Optional Only return change requests for stories in this team. Repeat as team_id[]= to select multiple teams, e.g. ?team_id[]=1&team_id[]=2. |
| status | Optional Only return change requests with this status: PENDING, APPROVED, REJECTED, PUSHED, or IN_PROGRESS. Repeat as status[]= to select multiple statuses. Defaults to every status except PUSHED. |
| per_page | Optional The number of results returned per page. Defaults to 20. |
| page | Optional The page of results to return. Defaults to 1. |
Sample request
curl --proto '=https' --tlsv1.2 -X GET \
'https://<tenant-domain>/api/v1/change_requests?status=PENDING&team_id=42' \
-H 'content-type: application/json' \
-H 'Authorization: Bearer <<CREDENTIAL.tines_api_key>>'
Response
A successful request will return a JSON object containing an array of the change requests the requesting token has access to.
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. |
Sample response
{
"change_requests": [
{
"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"
}
],
"meta": {
"current_page": "https://<tenant-domain>/api/v1/change_requests?status=PENDING&team_id=42&per_page=20&page=1",
"previous_page": null,
"next_page": null,
"next_page_number": null,
"per_page": 20,
"pages": 1,
"count": 1
}
}