Skip to main content
GET
/
customers
/
{customer_id}
Get a customer
curl --request GET \
  --url https://api.operator.xyz/customers/{customer_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Operator-Version: <operator-version>'
{
  "id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "organization_id": "<string>",
  "phone_no": "<string>",
  "email": null,
  "name": null,
  "external_id": null,
  "zendesk_user_id": null,
  "salesforce_lead_id": null,
  "salesforce_contact_id": null,
  "preferred_language": null,
  "extra": null
}

Authorizations

​
Authorization
string
header
required

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

Headers

​
Operator-Version
enum<string>
required

The API version to use.

Available options:
2025-06-19

Path Parameters

​
customer_id
string
required

Unique identifier for the customer, e.g. cus_8qm9JBCiTe7.

Response

Successful response.

​
id
string
required

Unique identifier for the customer, e.g. cus_8qm9JBCiTe7.

​
created_at
string<date-time>
required

When the customer was created.

​
updated_at
string<date-time>
required

When the customer was last updated.

​
organization_id
string
required

Unique identifier for the organization.

​
phone_no
string
required

Customer's phone number.

​
email
string

Customer's email address.

​
name
string

Customer's name.

​
external_id
string

External ID of the customer.

​
zendesk_user_id
string

External Zendesk user ID.

​
salesforce_lead_id
string

External Salesforce lead ID.

​
salesforce_contact_id
string

External Salesforce contact ID.

​
preferred_language
string

Customer's preferred language.

​
extra
object

Additional metadata associated with the customer.