Pagination and filters

Pagination is endpoint-specific. Do not reuse a single default across all list APIs.

List operationDefault page sizeRequired?Maximum
FilesSupply explicitlyYes100
DocumentsSupply explicitlyYes100
Renders25No100
Events10No100
Templates10No100
Studio standard listing10No100

Pages are one-based. List results normally contain items and metadata.pagination, including current_page, page_size, page_count, and total_count. Render lists also return next_page and prev_page, which may be null. Event-type listing and template merge-variable listing have different pagination behavior; follow their endpoint schemas.

For renders, sort accepts created_at or -created_at (the default). destination_status accepts failed, in_progress, pending_signature, or completed. start_date and end_date use calendar dates. Filters such as flow_name, flow_id, flows_batch_id, and template_id depend on the endpoint's public filter names; use the reference rather than internal database names.

For events, repeat event_type_name to select multiple names. resource_id, user_id, search, start_date, end_date, and order are supported. Results are filtered by access rights; non-admin users do not see API-key events.

Use bounded pagination and retries. A shorter page or an empty result does not imply unrestricted visibility into the account.


Did this page help you?