Sign in
Customers

List customers

List customers who have authorized an agent to act for them

get/customers

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

Changed in 4 of the 28 revisions of this API.58

  • 359d267dca881See the full diff
    • ○

      deleted the header request parameter X-Agent-ID with deprecation

      request-parameter-removed-with-deprecation

  • b1ad79e918ac1See the full diff
    • ○

      header request parameter X-Agent-ID was deprecated

      request-parameter-deprecated

  • 270e233e401c55See the full diff
    • ●

      for the query request parameter cursor, the maxLength was set to 1024

      request-parameter-max-length-set

    • ●

      added the new ACTIVE enum value to the data/items/attributes/delegation/status response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new EXPIRED enum value to the data/items/attributes/delegation/status response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new REVOKED enum value to the data/items/attributes/delegation/status response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new SUSPENDED enum value to the data/items/attributes/delegation/status response property for the response status 200

      response-property-enum-value-added

    • ○

      added the new optional query request parameter status

      new-optional-request-parameter

    • ○

      added subschema #1: ConnectedAgentLimits to the data/items/attributes/agents/items/limits response property anyOf list for the response status 200

      response-property-any-of-added

    • ○

      removed TransactionLimits from the data/items/attributes/agents/items/limits response property anyOf list for the response status 200

      response-property-any-of-removed

    • ○

      added the required property data/items/attributes/agents/items/handle to the response with the 200 status

      response-required-property-added

    • ○

      added the required property data/items/attributes/delegation/revokedAt to the response with the 200 status

      response-required-property-added

  • 8cc2aed458471See the full diff
    • ○

      added the required property data/items/attributes/avatarUrl to the response with the 200 status

      response-required-property-added