> ## Documentation Index
> Fetch the complete documentation index at: https://docs.flashduty.com/llms.txt
> Use this file to discover all available pages before exploring further.

# List changes

> Query change records within a time window, with filtering, search, and pagination.

## Restrictions

| Aspect      | Value                                                         |
| ----------- | ------------------------------------------------------------- |
| Rate limits | **1,000 requests/minute**; **50 requests/second** per account |
| Permissions | None — any valid `app_key` can call this operation            |


## OpenAPI

````yaml /api-reference/on-call.openapi.en.json post /change/list
openapi: 3.1.0
info:
  title: Flashduty Open API
  description: >-
    Public HTTP API for the Flashduty incident management platform — incidents,
    notification templates, channels, schedules, monitors, RUM, and platform
    administration. Every operation is authenticated with an `app_key` query
    parameter issued from the Flashduty console under Account → APP Keys.
    Responses follow a uniform envelope: `{ request_id, data }` on success, `{
    request_id, error }` on failure.
  version: 1.0.0
servers:
  - url: https://api.flashcat.cloud
    description: Flashduty Open API
security:
  - AppKeyAuth: []
tags:
  - name: On-call/Incidents
    description: ''
  - name: On-call/Channels
    description: ''
  - name: On-call/Alerts
    description: >-
      Search, inspect, and act on alerts. Manage card views and alert processing
      pipelines.
  - name: On-call/Integrations
    description: ''
  - name: On-call/IM integrations
    description: IM integration queries, such as which integrations have war room enabled.
  - name: On-call/Schedules
    description: ''
  - name: On-call/Calendars
    description: ''
  - name: On-call/Notification templates
    description: ''
  - name: On-call/Alert enrichment
    description: Custom fields, enrichment rules, and data mapping (schema, data, API).
  - name: On-call/Analytics
    description: ''
  - name: On-call/Status pages
    description: ''
  - name: On-call/Changes
    description: ''
paths:
  /change/list:
    post:
      tags:
        - On-call/Changes
      summary: List changes
      description: >-
        Query change records within a time window, with filtering, search, and
        pagination.
      operationId: change-read-list
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListChangeRequest'
            example:
              start_time: 1716960000
              end_time: 1717046400
              p: 1
              limit: 10
              integration_ids:
                - 362
              orderby: start_time
              asc: false
              include_events: false
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/SuccessEnvelope'
                  - type: object
                    properties:
                      data:
                        $ref: '#/components/schemas/ListChangeResponse'
              example:
                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
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/ServerError'
components:
  schemas:
    ListChangeRequest:
      type: object
      properties:
        start_time:
          type: integer
          format: int64
          description: Unix timestamp in seconds for the start of the query window.
        end_time:
          type: integer
          format: int64
          description: Unix timestamp in seconds for the end of the query window.
        p:
          type: integer
          description: Page number, starting at 1.
          format: int64
          minimum: 1
        limit:
          type: integer
          description: Number of items per page.
          format: int64
          minimum: 1
          maximum: 100
          default: 10
        channel_ids:
          type: array
          items:
            type: integer
            description: ''
            format: int64
          description: Filter by collaboration channel IDs.
        integration_ids:
          type: array
          items:
            type: integer
            description: ''
            format: int64
          description: Filter by reporting integration IDs.
        orderby:
          type: string
          description: Field to sort the result by.
          enum:
            - start_time
            - last_time
        asc:
          type: boolean
          description: Sort in ascending order when true.
        include_events:
          type: boolean
          description: Include the underlying change events for each change when true.
        query:
          type: string
          description: Free-text or regular-expression search over change fields.
    SuccessEnvelope:
      type: object
      description: >-
        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`.
      properties:
        request_id:
          type: string
          description: >-
            Unique ID for this request. Mirrored in the Flashcat-Request-Id
            response header. Include it when reporting issues.
          example: 01HK8XQE3Z7JM2NTFQ5YJ8P9R4
        data:
          description: Endpoint-specific payload. See each operation's 200 response schema.
      required:
        - request_id
        - data
    ListChangeResponse:
      type: object
      properties:
        total:
          type: integer
          description: Total number of matching changes.
          format: int64
        has_next_page:
          type: boolean
          description: Whether more pages are available after this one.
        items:
          type: array
          items:
            $ref: '#/components/schemas/ChangeItem'
          description: Changes on the current page.
    ChangeItem:
      type: object
      properties:
        change_id:
          type: string
          description: Change ID, a MongoDB ObjectID hex string.
        account_id:
          type: integer
          description: Account this change belongs to.
          format: int64
        channel_id:
          type: integer
          description: Collaboration channel this change is routed to.
          format: int64
        channel_name:
          type: string
          description: Name of the collaboration channel.
        channel_status:
          type: string
          description: Status of the collaboration channel.
        integration_id:
          type: integer
          description: Integration that reported this change.
          format: int64
        integration_name:
          type: string
          description: Name of the reporting integration.
        title:
          type: string
          description: Change title.
        description:
          type: string
          description: Change description.
        change_key:
          type: string
          description: Stable key that groups events belonging to the same change.
        change_status:
          type: string
          description: Current lifecycle status of the change.
        start_time:
          type: integer
          format: int64
          description: Unix timestamp in seconds when the change started.
        last_time:
          type: integer
          format: int64
          description: Unix timestamp in seconds of the most recent change activity.
        end_time:
          type: integer
          format: int64
          description: Unix timestamp in seconds when the change ended.
        labels:
          type: object
          additionalProperties:
            type: string
          description: Key-value labels attached to the change.
        link:
          type: string
          description: External link to the source change record.
        events:
          type: array
          items:
            $ref: '#/components/schemas/ChangeEventItem'
          description: Underlying change events, returned only when include_events is true.
    ErrorResponse:
      type: object
      description: Response envelope for errors. `error` is required; `data` is absent.
      properties:
        request_id:
          type: string
          example: 01HK8XQE3Z7JM2NTFQ5YJ8P9R4
        error:
          $ref: '#/components/schemas/DutyError'
      required:
        - request_id
        - error
    ChangeEventItem:
      type: object
      properties:
        event_id:
          type: string
          description: Change event ID, a MongoDB ObjectID hex string.
        account_id:
          type: integer
          description: Account this change event belongs to.
          format: int64
        channel_id:
          type: integer
          description: Collaboration channel this change event is routed to.
          format: int64
        integration_id:
          type: integer
          description: Integration that reported this change event.
          format: int64
        title:
          type: string
          description: Change event title.
        description:
          type: string
          description: Change event description.
        change_key:
          type: string
          description: Stable key that groups events belonging to the same change.
        change_status:
          type: string
          description: Lifecycle status of the change event.
          enum:
            - Planned
            - Ready
            - Processing
            - Canceled
            - Done
        link:
          type: string
          description: External link to the source change record.
        event_time:
          type: integer
          format: int64
          description: Unix timestamp in seconds when the change event occurred.
        labels:
          type: object
          additionalProperties:
            type: string
          description: Key-value labels attached to the change event.
        created_at:
          type: integer
          format: int64
          description: Unix timestamp in seconds when the change event was created.
        updated_at:
          type: integer
          format: int64
          description: Unix timestamp in seconds when the change event was last updated.
        deleted_at:
          type: integer
          format: int64
          description: Unix timestamp in seconds when the change event was deleted.
    DutyError:
      type: object
      description: >-
        Error payload inside the response envelope. Present only on non-2xx
        responses.
      properties:
        code:
          $ref: '#/components/schemas/ErrorCode'
        message:
          type: string
          description: >-
            Human-readable error message, localized by the caller's
            Accept-Language. May contain field names, IDs, or other context from
            the failing request.
          example: The specified parameter template_id is not valid.
      required:
        - code
        - message
    ErrorCode:
      type: string
      description: >-
        Flashduty error code enum. Every failed API response sets `error.code`
        to one of these stable wire strings. HTTP status is informational — the
        authoritative signal is the enum value.


        | Code | HTTP | Meaning |

        |---|---|---|

        | `OK` | 200 | Reserved — not returned on real errors. |

        | `InvalidParameter` | 400 | A required parameter is missing or failed
        validation. |

        | `BadRequest` | 400 | Generic 400 used when no more specific code fits.
        |

        | `InvalidContentType` | 400 | The `Content-Type` header is not
        `application/json`. |

        | `ResourceNotFound` | 400 | The referenced resource does not exist.
        Note: returned as HTTP 400, not 404 (historical choice). |

        | `NoLicense` | 400 | The feature is license-gated and no active license
        was found. |

        | `ReferenceExist` | 400 | Deletion blocked — other entities still
        reference this resource. |

        | `Unauthorized` | 401 | `app_key` is missing, invalid, or expired. |

        | `BalanceNotEnough` | 402 | Billing-gated operation with insufficient
        account balance. |

        | `AccessDenied` | 403 | Authenticated but lacking the permission
        required for this operation. |

        | `RouteNotFound` | 404 | The request URL path is not a known route. |

        | `MethodNotAllowed` | 405 | The HTTP method is not allowed on this
        otherwise-known path. |

        | `UndonedOrderExist` | 409 | An outstanding billing order blocks this
        new one. Wait and retry. |

        | `RequestLocked` | 423 | Operation temporarily locked due to repeated
        failures. |

        | `EntityTooLarge` | 413 | Request body exceeds the configured max size.
        |

        | `RequestTooFrequently` | 429 | Rate limit hit — API-global,
        per-account, or per-integration. |

        | `RequestVerifyRequired` | 428 | Second-factor verification required
        but not supplied. |

        | `DangerousOperation` | 428 | High-risk operation requires MFA
        verification. |

        | `InternalError` | 500 | Unhandled server-side error. Include
        `request_id` in the bug report. |

        | `ServiceUnavailable` | 503 | A backend dependency is unavailable. Try
        again later. |
      enum:
        - OK
        - InvalidParameter
        - BadRequest
        - InvalidContentType
        - ResourceNotFound
        - NoLicense
        - ReferenceExist
        - Unauthorized
        - BalanceNotEnough
        - AccessDenied
        - RouteNotFound
        - MethodNotAllowed
        - UndonedOrderExist
        - RequestLocked
        - EntityTooLarge
        - RequestTooFrequently
        - RequestVerifyRequired
        - DangerousOperation
        - InternalError
        - ServiceUnavailable
      x-enumDescriptions:
        OK: Reserved — not returned on real errors.
        InvalidParameter: A required parameter is missing or failed validation.
        BadRequest: Generic 400 used when no more specific code fits.
        InvalidContentType: The `Content-Type` header is not `application/json`.
        ResourceNotFound: >-
          The referenced resource does not exist. Note: returned as HTTP 400,
          not 404 (historical choice).
        NoLicense: The feature is license-gated and no active license was found.
        ReferenceExist: Deletion blocked — other entities still reference this resource.
        Unauthorized: '`app_key` is missing, invalid, or expired.'
        BalanceNotEnough: Billing-gated operation with insufficient account balance.
        AccessDenied: Authenticated but lacking the permission required for this operation.
        RouteNotFound: The request URL path is not a known route.
        MethodNotAllowed: The HTTP method is not allowed on this otherwise-known path.
        UndonedOrderExist: An outstanding billing order blocks this new one. Wait and retry.
        RequestLocked: Operation temporarily locked due to repeated failures.
        EntityTooLarge: Request body exceeds the configured max size.
        RequestTooFrequently: Rate limit hit — API-global, per-account, or per-integration.
        RequestVerifyRequired: Second-factor verification required but not supplied.
        DangerousOperation: High-risk operation requires MFA verification.
        InternalError: Unhandled server-side error. Include `request_id` in the bug report.
        ServiceUnavailable: A backend dependency is unavailable. Try again later.
      example: InvalidParameter
  responses:
    BadRequest:
      description: Invalid request — usually a missing or malformed parameter.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            missingParameter:
              value:
                request_id: 01HK8XQE3Z7JM2NTFQ5YJ8P9R4
                error:
                  code: InvalidParameter
                  message: The specified parameter is not valid.
    Unauthorized:
      description: Missing or invalid app_key.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            missingAppKey:
              value:
                request_id: 01HK8XQE3Z7JM2NTFQ5YJ8P9R4
                error:
                  code: Unauthorized
                  message: You are unauthorized.
    TooManyRequests:
      description: >-
        Rate limit hit. Either the global API limit, a per-account limit, or a
        per-integration limit.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            rateLimited:
              value:
                request_id: 01HK8XQE3Z7JM2NTFQ5YJ8P9R4
                error:
                  code: RequestTooFrequently
                  message: Request too frequently.
    ServerError:
      description: Unexpected server-side error. Include the request_id when reporting.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            internal:
              value:
                request_id: 01HK8XQE3Z7JM2NTFQ5YJ8P9R4
                error:
                  code: InternalError
                  message: >-
                    We encountered an internal error, and it has been reported.
                    Please try again later.
  securitySchemes:
    AppKeyAuth:
      type: apiKey
      in: query
      name: app_key
      description: >-
        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.

````