v1

latestOpenAPI 3.0.02026-07-2491237338.9 KB

Contacts

List contacts

Returns a paginated list of contacts.

get/contact/contacts

pageinteger

Page number of the results to be returned, 1-based.

limitinteger

A limit on the number of results to be returned, or number of results per page, between 1 and 100, defaults to 10.

includeTotalboolean

Return results inside an object that contains the total result count or not.

filter.tagsstring

Example:tag1,tag2

Comma-separated list of tag names. If any tag does not exist, the request fails with a parameter error.

filter.countryCodestring

Example:US

Two-letter country abbreviation. See ISO 3166-1 alpha-2 country code.

filter.phoneNumberstring

Example:+16315551111

Phone number in E.164 format.

filter.emailstring

Example:support@example.com

The contact's email address.

Successfully retrieved a paginated list of objects.

offsetinteger required

The position of the item this page starts from, zero-based. e.g., the 11th item is at offset 10.

limitinteger required

A limit on the number of items to be returned, between 1 and 100, defaults to 10.

lengthinteger required

The actual number of items in the page.

totalinteger

The total number of items. This field is returned only when the request parameter includeTotal is set to true.

itemsobject[]