Skip to main content
GET
List statement requests
Retrieve a paginated list of statement requests for a client. Supports filtering by statement type, status, and file format.

Authorizations

x-api-key
string
header
required

An API Key.

Headers

Authorization
string
required

The access token

X-Contact-ID
string

The ID of the contact

Query Parameters

client_id
string
required

The ID of the client

page
integer
default:1

Page number to retrieve

Required range: x >= 1
page_size
integer
default:50

Number of items per page (default 50)

Required range: x >= 1
statement_type
enum<string>

Filter by statement type

Available options:
accounts,
trades,
mt940,
incoming_funds
status
enum<string>

Filter by status

Available options:
pending,
running,
completed,
failed
file_format
enum<string>

Filter by file format

Available options:
pdf,
csv,
xls,
mt940

Response

Returns the list of statement requests

Paginated list of statement requests

data
object[]
required
pagination
object
required

Pagination metadata