Skip to main content
GET
/
agents
/
{agentId}
/
customers
List customer invitations
curl --request GET \
  --url https://api.natural.co/agents/{agentId}/customers \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "type": "customerInvitation",
      "id": "pty_4a8c9823f39c42a5b817556766551112",
      "attributes": {
        "name": "Acme Co",
        "email": "ops@example.com",
        "status": "ACTIVE",
        "permissions": [
          "payments.create",
          "payments.read"
        ],
        "limits": {
          "perTransaction": 100000
        },
        "createdAt": "2026-01-11T12:00:00.000Z",
        "updatedAt": "2026-01-11T12:00:00.000Z"
      },
      "relationships": {
        "agent": {
          "data": {
            "type": "agent",
            "id": "agt_3c4d5e6f7a8b9c0d1e2f3a4b5c6d7e8f",
            "attributes": {
              "name": "Carrier Payment Agent"
            }
          }
        }
      }
    }
  ],
  "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

Path Parameters

agentId
string
required

Agent ID

Pattern: ^agt_[0-9a-f]{32}$

Query Parameters

limit
integer
default:50
Required range: 1 <= x <= 100
cursor
string

Response

Successful Response

data
AgentCustomerResource · object[]
required
meta
object
required