Sign in
Customers

Get customer by external ID

Use when resolving a customer by your app's id (e.g. from your user table). Ideal for integrations that key by external id.

get/customers/external/{external_id}

Path parameters

external_idstring required

Customer External ID

Response

OK

address_citystring

AddressCity is the city of the customer's address

address_countrystring

AddressCountry is the country of the customer's address (ISO 3166-1 alpha-2)

address_line1string

AddressLine1 is the first line of the customer's address

address_line2string

AddressLine2 is the second line of the customer's address

address_postal_codestring

AddressPostalCode is the postal code of the customer's address

address_statestring

AddressState is the state of the customer's address

created_atstring date-time
created_bystring
emailstring

Email is the email of the customer

environment_idstring

EnvironmentID is the environment identifier for the customer

external_idstring

ExternalID is the external identifier for the customer

idstring

ID is the unique identifier for the customer

metadataobject

Metadata

namestring

Name is the name of the customer

status'published' | 'deleted' | 'archived'
tenant_idstring
timezonestring

Timezone is the customer's IANA timezone name (e.g. "Asia/Kolkata"). Defaults to "UTC". Inherited by subscriptions at creation time.

updated_atstring date-time
updated_bystring

Changes

Changed in 4 of the 12 revisions of this API.1415

  • cef2964c102c2See the full diff
    • ○

      added the optional property integrations/items/metadata to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property timezone to the response with the 200 status

      response-optional-property-added

  • f62d8a5fe7cf6See the full diff
    • ●

      removed the optional property details from the response with the 400 status

      response-optional-property-removed

    • ●

      removed the optional property details from the response with the 404 status

      response-optional-property-removed

    • ●

      removed the optional property details from the response with the 500 status

      response-optional-property-removed

    • ●

      added the new too_many_requests enum value to the code response property for the response status 400

      response-property-enum-value-added

    • ●

      added the new too_many_requests enum value to the code response property for the response status 404

      response-property-enum-value-added

    • ●

      added the new too_many_requests enum value to the code response property for the response status 500

      response-property-enum-value-added

    This revision also has 5 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 4ded3711f401812See the full diff
    • ●

      removed the optional property error from the response with the 400 status

      response-optional-property-removed

    • ●

      removed the optional property error from the response with the 404 status

      response-optional-property-removed

    • ●

      removed the optional property error from the response with the 500 status

      response-optional-property-removed

    • ●

      removed the optional property parent_customer from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property parent_customer_id from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property success from the response with the 400 status

      response-optional-property-removed

    • ●

      removed the optional property success from the response with the 404 status

      response-optional-property-removed

    • ●

      removed the optional property success from the response with the 500 status

      response-optional-property-removed

    • ○

      added the optional property code to the response with the 400 status

      response-optional-property-added

    • ○

      added the optional property code to the response with the 404 status

      response-optional-property-added

    • ○

      added the optional property code to the response with the 500 status

      response-optional-property-added

    • ○

      added the optional property details to the response with the 400 status

      response-optional-property-added

    • ○

      added the optional property details to the response with the 404 status

      response-optional-property-added

    • ○

      added the optional property details to the response with the 500 status

      response-optional-property-added

    • ○

      added the optional property http_status_code to the response with the 400 status

      response-optional-property-added

    • ○

      added the optional property http_status_code to the response with the 404 status

      response-optional-property-added

    • ○

      added the optional property http_status_code to the response with the 500 status

      response-optional-property-added

    • ○

      added the optional property message to the response with the 400 status

      response-optional-property-added

    • ○

      added the optional property message to the response with the 404 status

      response-optional-property-added

    • ○

      added the optional property message to the response with the 500 status

      response-optional-property-added

    This revision also has 7 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • d1860fe0ee671See the full diff
    • ○

      added the optional property integrations to the response with the 200 status

      response-optional-property-added

    This revision also has 223 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog