ALaltoviz
Customers

List customers

Changed on
get/v1/customers

Request

Query parameters

PageIndexinteger
PageSizeinteger
OrderBystring
querystring

query (full text search)

Response

OK

activeboolean

Active

cellPhonestring nullable

Cell phone number

companyNamestring nullable

Company name

emailstring nullable

Email

firstNamestring nullable

First name

idinteger

Customer ID

internalIdstring nullable

ID used in information system

internalNotesstring nullable

Internal notes

lastNamestring nullable

Last name

metadataobject nullable

Metadata: free-form key/value pairs carried with the customer, for an integration to keep its own identifiers and flags against it.

Sent as a PATCH, not a replacement: keys you send are added or updated, keys you leave out keep whatever they held, and a key is removed only when you send it as null. Omitting the property entirely leaves the whole bag untouched, and "" stores an empty value rather than removing the key.

namestring nullable

Name

numberstring nullable

Number

phonestring nullable

Phone number

titlestring nullable

Title

type'Business' | 'Consumer' | 'Government'

Changes