PivolioCustomers

List customers

Returns a paginated list of resolved customers with search, segment and attribute filters, and sorting.

Authentication

X-Workspace-Idstring
API Key authentication via header

Query parameters

limitintegerOptional1-200Defaults to 50
offsetintegerOptional>=0Defaults to 0
qstring or nullOptional<=200 characters

Search name/email/id

identifiedboolean or nullOptional
countrystring or nullOptional
sourcestring or nullOptional
segmentenum or nullOptional

Saved customer segments (filter presets for the customers list).

Allowed values:
sortenumOptional

Server-sortable columns for the customers list.

Allowed values:
orderenumOptional
Allowed values:

Response

Successful Response
itemslist of objects
totalinteger

Errors

422
Unprocessable Entity Error