Sign in

v1

latestOpenAPI 3.0.02026-07-26868170.3 KB
Contact

List & search contacts

Get the list of contacts and search for contacts

get/data/contacts

Query parameters

per_pageinteger

Number of items displayed per page.

page_numberinteger

Page number.

key'key' | 'firstname' | 'lastname' | 'creation_date' | 'language' | 'email' | 'cellphone' | 'card code'

search fields, in contacts

operator'is' | 'after' | 'before' | 'contains' | 'ends' | 'equal' | 'greater' | 'isnot' | 'lower' | 'notequal' | 'starts'

operator for search operators are limited by the type of value expected

valuestring

Use a combination of the field, the operator and the searched value. It will return contacts matched to your search. fields available on search in contacts are 'unique key', 'firstname', 'lastname', 'creation date', 'language', 'email', 'cellphone', 'custom fields' (using cXX with XX being the custom field ID) and 'card code' (with loyalty option).

Response

the retrieval of contacts search and their subscriptions and loyalty informations.