Sign in

v1

latestOpenAPI 3.0.02026-08-04134348905.1 KB
Statements

List statements

Permissions required: Read Statement

List the available statements.

get/statements

Query parameters

afterIdstring

When paginating this is used to provide the starting point for the page to fetch (retrieved from the previous response body)

limitinteger

Maximum number of results to return per query

idsstring[]
typeIdsstring[]
customerIdsstring[]
createdAfterstring date-time
Example:2019-01-02T12:34:56.000Z
createdBeforestring date-time
Example:2019-01-02T12:34:56.000Z
correctedAfterstring date-time
Example:2019-01-02T12:34:56.000Z

Filter for statements corrected at or after this time

correctedBeforestring date-time
Example:2019-01-02T12:34:56.000Z

Filter for statements corrected at or before this time

Response

Statement list

Example response

{
  "data": [
    {
      "correctedAt": "2019-01-02T12:34:56.000Z",
      "createdAt": "2019-01-02T12:34:56.000Z",
      "customerId": "1ac10949bbbf483e8df3c0f8ef97146bc9ce6f5890df40fa8777ea63dc932f7b",
      "displayName": "September 2025 Statement",
      "id": "3486b413-93d3-4447-afce-2b9c9dc34a32",
      "typeId": "058da362-31a7-4e2b-ae3e-77b095389a5f"
    }
  ],
  "page": {
    "next": "<next page url>"
  }
}