List Reports

GET/reports

This endpoint allows API users to retrieve a paginated list of reports they requested.

Query Parameters

fromstring

Start date for filtering reports by the date each report was requested (its creation time, not the period the report covers), inclusive, in YYYY-MM-DD format.

tostring

End date for filtering reports by the date each report was requested (its creation time, not the period the report covers), inclusive, in YYYY-MM-DD format.

pageinteger

Specify the page number.

limitinteger

Specify the number of items per page.

sort_bystring

Field to sort results by. Defaults to created_at.

sort_typestring

Sort direction. Defaults to DESC.

Response

OK

idstring<uuid>
typestring
status"pending" | "error" | "completed"
delivery_channel"email" | "webhook"
sent_atstring<date-time>

When the report was delivered via the chosen delivery_channel. Null until delivery has succeeded (a completed report may still have a null sent_at).

created_atstring<date-time>
updated_atstring<date-time>

Error defines errors may be returned from the system.

messagestring
errorsobject[]
Show errors properties
errorCodestring
messagestring

Error defines errors may be returned from the system.

messagestring
errorsobject[]
Show errors properties
errorCodestring
messagestring

Error defines errors may be returned from the system.

messagestring
errorsobject[]
Show errors properties
errorCodestring
messagestring
Request
curl -X GET "https://api.uat.triple-a.io/api/fiat-payout/v1/reports?from=<from>&to=<to>&page=<page>&limit=<limit>&sort_by=<sort_by>&sort_type=<sort_type>" \
  -H "Authorization: Bearer <token>"
Response
[
  {
    "id": "00000000-0000-0000-0000-000000000000",
    "type": "string",
    "status": "pending",
    "delivery_channel": "email",
    "sent_at": "1970-01-01T00:00:00.000Z",
    "created_at": "1970-01-01T00:00:00.000Z",
    "updated_at": "1970-01-01T00:00:00.000Z"
  }
]