v1

latestOpenAPI 3.0.02026-07-263403911.5 MB

Contacts

View contact

Find a single contact by ID.

get/v1/Contacts/{id}

idinteger required

Format - int32. ID of the contact to view.

okboolean

contact_idinteger

Primary identifier for this contact.

namestring required

Name of contact. Can be full or partial name.

emailstring

Email address or addresses for which to contact this person. (for multiple emails, separate by comma)

companystring

Name of the company this person works for.

customer_idinteger

Foreign identifier for the account this contact is associated with.

agent_idinteger

Foreign identifier for the agent this contact is associated with.

created_datestring date-time

Date and time this contact was created.

titlestring

A title for which this contact holds.

positionstring

A position for which this contact holds.

faxstring

Telephone number to use for facsimile transmission.

phonestring

Primary phone number that can be used to contact the person.

commentsstring

Comments or notes about the person for internal use.

mobilestring

A mobile telephone number from which the person can be contacted.

contact_type_idinteger

Foreign identifier for the type of contact represented.