v1

latestOpenAPI 3.0.12026-07-26222700728.0 KB

Summaries

Query summaries

Query summaries for the authenticated user

post/v6/summaries/query

Request body

cursorstring nullable

Cursor from the previous paginated response

limitinteger

Page size, i.e. number of items to return per page

Example request

{
  "filter": {
    "company": {
      "in": [
        "co_123",
        "co_456"
      ]
    }
  }
}

Response

Success

result'SUCCESS' | 'FAILURE'

The result of the action performed.

Example response

{
  "data": [
    {
      "id": "sum_123456789",
      "summary": "Monthly financial summary for January 2024",
      "date": "2025-01-01",
      "status": "ACTIVE",
      "company": {
        "id": "co_123456",
        "name": "ACME Corp"
      }
    }
  ]
}