Skip to main content
GET
/
counterparties
List counterparties
curl --request GET \
  --url https://api.natural.co/counterparties \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "pty_550e8400e29b41d4a716446655440002",
      "type": "party",
      "attributes": {
        "name": "Acme Supplies",
        "email": "payables@acmesupplies.com",
        "status": "ACTIVE"
      }
    }
  ],
  "meta": {
    "pagination": {
      "hasMore": false,
      "nextCursor": null
    }
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.natural.co/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
X-Agent-ID
string | null

Agent ID (agt_xxx) identifying which agent is making the request.

​
X-Instance-ID
string | null

Required when X-Agent-ID is present. Session or conversation ID for agent observability.

Maximum string length: 1024

Query Parameters

​
direction
enum<string>

Optional filter. When set, only counterparties with activity in that direction are returned, and pagination is scoped to that subset. Omit to return every counterparty.

Available options:
sent,
received
​
cursor
string

Cursor for pagination

​
limit
integer
default:50

Maximum number of results

Required range: 1 <= x <= 100

Response

Successful Response

​
data
CounterpartyResource · object[]
required
​
meta
object
required