Skip to main content
A Contact represents a person or business your organization works with, such as a customer, adjuster, or supplier. Contacts support full CRUD through the Contacts endpoints, and each one carries a list of Contact Notes.
id
integer

The contact's unique identifier.

Example:

4821

tenant_id
integer

The id of your organization's account.

Example:

12

owned_by
integer | null

The id of the user in your organization who owns this contact. Null if the contact has no assigned owner.

Example:

1159

nick_name
string | null

The contact's nickname or preferred name. Null if not set.

first_name
string

The contact's first name.

Example:

"Jane"

last_name
string

The contact's last name.

Example:

"Smith"

prefix
string | null

A name prefix or salutation (for example Ms. or Dr.). Null if not set.

Example:

"Ms."

title
string | null

The contact's job title. Null if not set.

Example:

"Project Manager"

department
string | null

The department the contact belongs to at their organization. Null if not set.

Example:

"Operations"

email
string | null

The contact's primary email address. Null if not provided.

Example:

"jane.smith@example.com"

email_alt
string | null

An alternate email address for the contact. Null if not provided.

phone_home
string | null

The contact's home phone number. Null if not provided.

phone_cell
string | null

The contact's cell phone number. Null if not provided.

Example:

"(555) 201-4477"

phone_fax
string | null

The contact's fax number. Null if not provided.

phone_work
string | null

The contact's work phone number. Null if not provided.

Example:

"(555) 201-4400"

phone_work_ext
string | null

Extension for the contact's work phone number. Null if not applicable.

Example:

"118"

address_street
string | null

The street portion of the contact's address. Null if not provided.

Example:

"482 Birchwood Ave"

address_city
string | null

The city portion of the contact's address. Null if not provided.

Example:

"Madison"

address_state
string | null

The two-letter state or province code for the contact's address. Null if not provided.

Example:

"WI"

address_zip
string | null

The postal code for the contact's address. Null if not provided.

Example:

"53703"

status
boolean

Whether the contact is active. Deleting a contact that has other contacts linked to it deactivates it (sets this to false) instead of permanently removing it.

Example:

true

comment
string | null

Free-form notes about the contact. Null if not set.

merge_status
enum<integer>

The contact's merge designation, used when deduplicating contacts. 0 = no designation, 1 = marked as the contact to keep in a pending merge, 2 = marked to be merged away and removed. Most integrations can ignore it.

Available options:
0,
1,
2
Example:

0

import_name
string | null

The name of the bulk import batch that created this contact, if it was created via import. Null otherwise.

import_id
integer | null

The id of the bulk import batch that created this contact, if it was created via import. Null otherwise.

created_at
string | null

Timestamp when the contact was created, formatted as YYYY-MM-DD HH:MM:SS. Can be null for contacts created before timestamps were tracked.

Example:

"2024-11-02 14:35:09"

updated_at
string | null

Timestamp when the contact was last updated, formatted as YYYY-MM-DD HH:MM:SS. Can be null if the contact has never been updated.

Example:

"2025-01-08 09:12:44"