Kustomer API

Getting access, Developing, Testing

Back to Kustomer

Get Customers

Retrieves all customers in your organization. Results include customer data, such as their phone number, sentiment score, and the last message in a conversation.

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|

Output

type: object properties: meta: type: object properties: pageSize: type: string page: type: string total: type: string totalPages: type: string data: type: array items: type: object properties: type: type: string id: type: string attributes: type: object properties: name: type: string displayName: type: string displayColor: type: string displayIcon: type: string externalIds: type: string sharedExternalIds: type: string emails: type: array items: type: object properties: email: type: string verified: type: string type: type: string sharedEmails: type: string phones: type: array items: type: object properties: phone: type: string verified: type: string type: type: string sharedPhones: type: string socials: type: array items: type: object properties: type: type: string userid: type: string username: type: string url: type: string verified: type: string sharedSocials: type: string urls: type: array items: type: object properties: url: type: string type: type: string locations: type: array items: type: object properties: type: type: string address: type: string activeUsers: type: string watchers: type: string recentLocation: type: object properties: updatedAt: type: string locale: type: string gender: type: string createdAt: type: string updatedAt: type: string modifiedAt: type: string lastActivityAt: type: string lastMessageIn: type: object properties: sentiment: type: string lastConversation: type: object properties: tags: type: string sentiment: type: string conversationCounts: type: object properties: done: type: string open: type: string snoozed: type: string all: type: string preview: type: string tags: type: array items: type: string progressiveStatus: type: string verified: type: string rev: type: string relationships: type: object properties: org: type: object properties: links: type: object properties: self: type: string data: type: object properties: type: type: string id: type: string messages: type: object properties: links: type: object properties: self: type: string createdBy: type: object properties: links: type: object properties: self: type: string data: type: object properties: type: type: string id: type: string modifiedBy: type: object properties: links: type: object properties: self: type: string data: type: object properties: type: type: string id: type: string links: type: object properties: self: type: string links: type: object properties: self: type: string first: type: string prev: type: string next: type: string last: type: string