Skip to main content
Returns the people who have talked to your agents in this project. Customers we hold nothing about beyond their identifier are left out unless includeNoData is true.
Calls GET /v1/customer

Options

integer
integer
string
string
One of call, chat
string
Include customers we hold nothing about beyond their identifier. Defaults to false. One of true, false
string
lastSeenAt (the default), firstSeenAt, conversationCount, voiceCount, chatCount, talkTimeMs or displayName, or field.<key> (for example field.COMPANY) to sort by a field’s value. Field keys come from GET /v1/customer/fields. Customers without a value sort last.
string
One of asc, desc
string
Filter by this field, a key from GET /v1/customer/fields. Use with fieldOperator and, unless checking presence, fieldValue.
string
How fieldValue is compared, ignoring case. NOT_EQUALS includes customers without the field. One of EQUALS, NOT_EQUALS, CONTAINS, STARTS_WITH, IS_SET, IS_NOT_SET
string

Example

Every command also takes the global options and sets one of the exit codes.