Customers

Get customer by phone number

Retrieves a customer based on their phone number.

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

Legacy RoleEquivalent Permission Set Role
org.user.customer.readorg.permission.customer.read
get/customers/phone={phone}

Request

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

Path parameters

phonestring required
Example:18005551212

Phone number of the customer (E.164 format).

Response

OK

Changes

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