Skip to main content
A customer is a party (pty_*) that connected your agents to act for it. To learn more, see Invite a customer and Manage customer access.

Example

GET /customers/{customerPartyId}
The object is everything inside data. The field names below are relative to it: attributes.name is data.attributes.name in the response.

Fields

string
required
Resource type. Always customer.
string
required
Customer party ID (pty_*).
object
required
The customer’s details.
Events about a customer carry its connection, not this object: connection.activated and connection.revoked (Connections), and agentConnection.revoked when one agent’s access ends (Agent connections).

Events

This resource sends no webhook events.

Errors

See the error codes these endpoints return.

Sandbox simulations