Get Contact
This endpoint gets or creates a new contact.
Body
The ID of the user group to which the contact belongs.
Response
The ID of the contact.
Name or details of the assistant associated with the contact.
Phone number of the assistant.
URL or path to the contact’s avatar image.
Date of birth of the contact.
Name or details of the controller associated with the contact.
Date and time when the contact was created.
Name or details of the person who created the contact.
Department or division associated with the contact.
Description or additional details about the contact.
Indicates whether the contact should not be called.
Email address of the contact.
Indicates whether the contact has opted out of email communication.
Fax number of the contact.
Indicates whether the contact has opted out of fax communication.
First name of the contact.
Handle or username associated with the contact.
Indicates whether the contact is marked as invalid.
Languages known or spoken by the contact.
Last name of the contact.
Last person who modified the contact.
Source or origin of the lead/contact.
City of the mailing address.
Country of the mailing address.
Geocoding accuracy of the mailing address.
State or province of the mailing address.
Street of the mailing address.
Name or details of the owner of the contact.
Phone number of the contact.
URL or path to the contact’s photo.
Name or details of the processor associated with the contact.
Title or position of the contact.
| Name | Type | Description |
|---|---|---|
| id | Text | Unique identifier for 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 | Date/Time | 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 |
| 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 address of the mailing address |
| nextMeeting | Text | Details or date/time of the next scheduled meeting |
| owner | Text | Owner or responsible person for the contact |
| phone | Text | Phone number of the contact |
| photoUrl | Text | URL or path to the contact’s photo/image |
| processor | Text | Name or details of the processor associated with the contact |
| supplier_id | Text | Supplier ID associated with the contact |
| title | Text | Title or job position of the contact |