Skip to main content
POST
/
change
/
list
List changes
curl --request POST \
  --url 'https://api.flashcat.cloud/change/list?app_key=' \
  --header 'Content-Type: application/json' \
  --data '
{
  "start_time": 1716960000,
  "end_time": 1717046400,
  "p": 1,
  "limit": 10,
  "integration_ids": [
    362
  ],
  "orderby": "start_time",
  "asc": false,
  "include_events": false
}
'
{
  "request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
  "data": {
    "total": 1,
    "has_next_page": false,
    "items": [
      {
        "change_id": "664a1b2c3d4e5f6a7b8c9d0e",
        "account_id": 10001,
        "channel_id": 5001,
        "channel_name": "Production",
        "channel_status": "active",
        "integration_id": 362,
        "integration_name": "GitHub Deploy",
        "title": "Deploy api-server v2.3.1",
        "description": "Rolling deploy to production cluster",
        "change_key": "deploy-api-server-2311",
        "change_status": "Done",
        "start_time": 1716962400,
        "last_time": 1716962700,
        "end_time": 1716963000,
        "labels": {
          "service": "api-server",
          "env": "prod"
        },
        "link": "https://github.com/acme/api-server/actions/runs/123"
      }
    ]
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.flashcat.cloud/llms.txt

Use this file to discover all available pages before exploring further.

​
Restrictions

AspectValue
Rate limits1,000 requests/minute; 50 requests/second per account
PermissionsNone — any valid app_key can call this operation

Authorizations

​
app_key
string
query
required

App key issued from the Flashduty console under Account → APP Keys. Required on every public API call. Keep it secret — it grants the same access as the owning account.

Body

application/json
​
start_time
integer<int64>

Unix timestamp in seconds for the start of the query window.

​
end_time
integer<int64>

Unix timestamp in seconds for the end of the query window.

​
p
integer<int64>

Page number, starting at 1.

Required range: x >= 1
​
limit
integer<int64>
default:10

Number of items per page.

Required range: 1 <= x <= 100
​
channel_ids
integer<int64>[]

Filter by collaboration channel IDs.

​
integration_ids
integer<int64>[]

Filter by reporting integration IDs.

​
orderby
enum<string>

Field to sort the result by.

Available options:
start_time,
last_time
​
asc
boolean

Sort in ascending order when true.

​
include_events
boolean

Include the underlying change events for each change when true.

​
query
string

Free-text or regular-expression search over change fields.

Response

Success

Success response envelope. On every 2xx response, request_id identifies the call (also mirrored in the Flashcat-Request-Id header) and data holds the endpoint-specific payload. Failure responses use a different shape — see ErrorResponse.

​
request_id
string
required

Unique ID for this request. Mirrored in the Flashcat-Request-Id response header. Include it when reporting issues.

Example:

"01HK8XQE3Z7JM2NTFQ5YJ8P9R4"

​
data
object
required

Endpoint-specific payload. See each operation's 200 response schema.