Skip to main content
GET
/
counterparties
List counterparties
curl --request GET \
  --url https://api.tomorro.com/v2/counterparties \
  --header 'x-api-key: <api-key>'
{
  "data": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "name": "Acme Corporation",
      "status": "active"
    }
  ],
  "pagination": {
    "limit": 20,
    "next_cursor": "eyJpZCI6IjEyMyJ9",
    "prev_cursor": "eyJpZCI6IjEwMCJ9",
    "has_next": true,
    "has_previous": false
  },
  "links": {
    "self": "/counterparties?limit=20",
    "next": "/counterparties?limit=20&after=eyJpZCI6IjEyMyJ9",
    "prev": "/counterparties?limit=20&before=eyJpZCI6IjEwMCJ9"
  }
}

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:
[
  {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "name": "Acme Corporation",
    "status": "active"
  }
]
​
pagination
object
required

Pagination metadata including cursors and navigation flags.

Example:
{
  "limit": 20,
  "next_cursor": "eyJpZCI6IjEyMyJ9",
  "prev_cursor": "eyJpZCI6IjEwMCJ9",
  "has_next": true,
  "has_previous": false
}
​
links
object
required

HATEOAS navigation links for pagination.

Example:
{
  "self": "/counterparties?limit=20",
  "next": "/counterparties?limit=20&after=eyJpZCI6IjEyMyJ9",
  "prev": "/counterparties?limit=20&before=eyJpZCI6IjEwMCJ9"
}