GET
/
v1
/
contacts
/
list

Body

limit
string
required

This is the limit of the contacts.

offset
string
required

This is the offset of the contacts.

order_direction
string
required

This is the order direction of the contacts.

Response

id
text

The ID of the contact.

assistant
text

Name or details of the assistant associated with the contact.

assistant_phone
text

Phone number of the assistant.

avatar
text

URL or path to the contact’s avatar image.

birthdate
text

Date of birth of the contact.

controller
text

Name or details of the controller associated with the contact.

created_at
datetime

Date and time when the contact was created.

created_by
text

Name or details of the person who created the contact.

department
text

Department or division associated with the contact.

description
text

Description or additional details about the contact.

do_not_call
boolean

Indicates whether the contact should not be called.

email
text

Email address of the contact.

email_opt_out
boolean

Indicates whether the contact has opted out of email communication.

fax
text

Fax number of the contact.

fax_opt_out
boolean

Indicates whether the contact has opted out of fax communication.

firstName
text

First name of the contact.

handle
text

Handle or username associated with the contact.

invalid_contact
boolean

Indicates whether the contact is marked as invalid.

languages
text

Languages known or spoken by the contact.

lastName
text

Last name of the contact.

last_modified_by
text

Last person who modified the contact.

leadSource
text

Source or origin of the lead/contact.

mailingCity
text

City of the mailing address.

mailingCountry
text

Country of the mailing address.

mailingGeocodeAccuracy
text

Geocoding accuracy of the mailing address.

mailingState
text

State or province of the mailing address.

mailingStreet
text

Street of the mailing address.

owner
text

Name or details of the owner of the contact.

phone
text

Phone number of the contact.

photoUrl
text

URL or path to the contact’s photo.

processor
text

Name or details of the processor associated with the contact.

title
text

Title or position of the contact.