Attachments4

Audit Logs1

Auth Settings4

Auth Tokens6

Brands5

Business Schedules6

Companies5

Companies (Bulk)2

Conversations9

Conversations (Bulk)2

Conversations (Forwards)2

Conversations (Messages)2

Conversations (Notes)1

Conversations (Tags)2

Conversations (Time)2

Custom Attributes2

Customers9

Customers (Bulk)3

Customers (Conversations)2

Customers (Drafts)2

Customers (Events)4

Customers (KObjects)2

Customers (Merges)3

Customers (Messages)2

Customers (Notes)1

Customers (Unmasking Windows)2

Drafts5

Drafts (Attachments)4

Forwards (Attachments)4

Klasses5

KObjects (Custom Objects)6

KObjects (Custom Objects) (Bulk)3

Media3

Messages7

Messages (Bulk)2

Notes6

Notes (Bulk)2

Notes (Conversations)1

Role Groups6

Satisfaction1

Search2

SLAs1

Spam3

Teams6

Teams (By ID)3

Tracking Events3

Users5

Users (By ID)3

Customers

Get customer by external ID

Retrieves a customer based on their unique external ID.

The externalId is typically the ID of the customer within your database or an external service.

This provides a unique way to create and identify users by mapping a unique customer ID in Kustomer to a unique customer ID in an external system.

Any one of the following roles is required for this endpoint:

Legacy Role	Equivalent Permission Set Role
org.user.customer.read	org.permission.customer.read

get/customers/externalId={externalId}

Request

Base URL: https://api.kustomerapp.com/v1
URL: https://api.kustomerapp.com/v1/customers/externalId={externalId}
Auth: httpBearer (a scheme the document does not define)

Path parameters

externalIdstring required

Example:my-customer-database-id

External ID of the customer.

Response

Changes

No recorded changes to this operation across all 8 revisions of this API.