Skip to main content
GET
List advanced customer records

Authorizations

Authorization
string
header
required

Your personal access token where supported, or a scoped API key (hc_…) created inside HueChat at Account → Developer API. Send it as Authorization: Bearer <token>.

Path Parameters

accountId
integer
required

HueChat account ID

Query Parameters

q
string

Search name, email, phone, identifier and company

ids
string

Comma-separated contact IDs; maximum 100

view
enum<string>

Customer view

Available options:
all,
members,
attention
source
string

Source kind

label
string

Label

company
string

Company

location
string

Location

phone
enum<string>

Phone presence

Available options:
all,
present,
missing
email
enum<string>

Email presence

Available options:
all,
present,
missing
sort
string

Sort field

page
integer

Page number

Required range: 1 <= x <= 100000
per_page
integer

Records per page

Required range: 1 <= x <= 100

Response

OK

The response is of type object.