Customers

List customers who have authorized an agent to act for them

get/customers

Request

  • Base URL
    https://api.natural.com
  • URL
    https://api.natural.com/customers
  • Auth
    HTTP bearer

Query parameters

cursorstring

Cursor from the previous page.

limitinteger

Maximum results per page.

status'active' | 'revoked' | 'all'

Filter by connection state. Active returns any non-revoked connection (including suspended and expired). Revoked returns customers whose access was revoked. All returns both.

Headers

X-Instance-IDstring nullable

Caller-chosen identifier for the agent run, session, or conversation, required when an agent moves money.

Response

Successful Response

Changes