Back to KustomerGet Customer by ID
Retrieves a customer record using the customer's unique ID.
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|
Input
type: object
properties:
parameters:
type: object
properties:
id:
type: string
description: (Required) Unique ID of the customer.
required:
- id
title: Parameters
Output
type: object
properties:
data:
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
externalId:
type: string
externalIds:
type: array
items:
type: object
properties:
externalId:
type: string
verified:
type: string
id:
type: string
sharedExternalIds:
type: string
signedUpAt:
type: string
avatarUrl:
type: string
username:
type: string
emails:
type: array
items:
type: object
properties:
email:
type: string
verified:
type: string
type:
type: string
id:
type: string
sharedEmails:
type: array
items:
type: object
properties:
email:
type: string
verified:
type: string
type:
type: string
id:
type: string
phones:
type: string
sharedPhones:
type: string
socials:
type: string
sharedSocials:
type: string
urls:
type: string
locations:
type: string
activeUsers:
type: string
watchers:
type: string
recentLocation:
type: object
properties:
updatedAt:
type: string
locale:
type: string
timeZone:
type: string
birthdayAt:
type: string
gender:
type: string
presence:
type: string
createdAt:
type: string
updatedAt:
type: string
modifiedAt:
type: string
lastSeenAt:
type: string
lastActivityAt:
type: string
lastCustomerActivityAt:
type: string
lastMessageIn:
type: object
properties:
sentAt:
type: string
sentiment:
type: string
lastConversation:
type: object
properties:
id:
type: string
sentiment:
type: object
properties:
confidence:
type: string
polarity:
type: string
tags:
type: string
conversationCounts:
type: object
properties:
all:
type: string
snoozed:
type: string
open:
type: string
done:
type: string
preview:
type: object
properties:
previewAt:
type: string
type:
type: string
text:
type: string
subject:
type: string
tags:
type: string
sentiment:
type: object
properties:
polarity:
type: string
confidence:
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
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