Skip to main content
GET
List customer profiles

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

limit
integer
default:20
Required range: 1 <= x <= 50
page
integer
default:1
Required range: x >= 1
Maximum string length: 200
agentId
string<uuid>
modality
enum<string>
Available options:
call,
chat
includeNoData
enum<string>

Include customers we hold nothing about beyond their identifier. Defaults to false.

Available options:
true,
false
sortBy
string

lastSeenAt (the default), firstSeenAt, conversationCount, voiceCount, chatCount, talkTimeMs or displayName, or field. (for example field.COMPANY) to sort by a field's value. Field keys come from GET /v1/customer-profile/fields. Customers without a value sort last.

sortDirection
enum<string>
default:desc
Available options:
asc,
desc
fieldKey
string

Filter by this field, a key from GET /v1/customer-profile/fields. Use with fieldOperator and, unless checking presence, fieldValue.

Required string length: 1 - 100
fieldOperator
enum<string>
default:EQUALS

How fieldValue is compared, ignoring case. NOT_EQUALS includes customers without the field.

Available options:
EQUALS,
NOT_EQUALS,
CONTAINS,
STARTS_WITH,
IS_SET,
IS_NOT_SET
fieldValue
string
Required string length: 1 - 500

Response

Customer profiles

data
object
required