Skip to main content
GET
List counterparties

Authorizations

x-api-key
string
header
required

API key for authentication. Get your key at https://app.tomorro.com/settings/integrations?integration=api-key

Query Parameters

limit
number
default:20

Number of items per page (1-50)

Required range: 1 <= x <= 50
Example:

20

after
string

Cursor for forward pagination. Use the next_cursor value from a previous response.

Example:

"eyJpZCI6IjEyMyJ9"

before
string

Cursor for backward pagination. Use the prev_cursor value from a previous response.

Example:

"eyJpZCI6IjEwMCJ9"

sort
string

Sort order. Comma-separated list of fields. Prefix with - for descending. Allowed fields: id, name, status, createdAt, updatedAt. Default: -createdAt

Example:

"-createdAt,name"

status
string

Filter by status. Formats: status=active (equality), status=in:active,archived (in list)

Example:

"active"

name
string

Filter by name. Partial match on the counterparty name.

Example:

"Acme"

Response

List of counterparties with pagination info

data
object[]
required

An array of Counterparty objects.

Example:
pagination
object
required

Pagination metadata including cursors and navigation flags.

Example:

HATEOAS navigation links for pagination.

Example: