Sign in
Customers

Retrieve a customer by external id.

get/v2/customers/external-id/{external_id}

Path parameters

external_idstring required

Caller-supplied external identifier.

Example:crm_acme_001

External customer identifier.

Response

Resource found.

idstring uuid required

Customer UUID.

namestring required

Customer name.

external_idstring nullable required

Optional caller-supplied external identifier.

stripe_customer_idstring nullable required

Optional Stripe customer identifier.

quickbooks_customer_idstring uuid nullable required

Optional QuickBooks customer UUID.

created_atinteger required

Unix timestamp in seconds.

updated_atinteger required

Unix timestamp in seconds.

Example response

{
  "id": "018f5f0c-1111-7abc-8def-123456789abc",
  "name": "Acme",
  "external_id": "crm_acme_001",
  "stripe_customer_id": "cus_NffrFeUfNV2Hib",
  "quickbooks_customer_id": "018f5f0c-1111-7abc-8def-123456789abc",
  "created_at": 1767225600,
  "updated_at": 1767225600
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.