Contact

A contact represents a person or business and serves as a reachable, real-world reference for projects, accounts and other resources.

Attributes

Attribute	Type	Description
id	Integer	The unique id of the Contact.
tenant_id	Integer	The id of the Tenant the Contact belongs to.
owned_by	Integer	The id of the User who "owns" the Contact.
nick_name	String	The Contact nick name.
first_name	String	The Contact first name.
last_name	String	The Contact last name.
prefix	String	The Contact prefix for their professional name.
title	String	The Contact job title.
department	String	The Contact job department.
email	String	The Contact primary email.
email_alt	String	The Contact alternative email.
phone_home	String	The Contact home phone number.
phone_cell	String	The Contact cell phone number.
phone_fax	String	The Contact fax phone number.
phone_work	String	The Contact work phone number.
phone_work_ext	String	The Contact work phone number extension.
address_street	String	The Contact street address.
address_city	String	The Contact city address.
address_state	String	The Contact state address.
address_zip	String	The Contact post code address.
status	Boolean	The Contact status. (0: Inactive, 1: Active)
comment	String	A note or description about the Contact.
created_at	DateTime	The date time of when the Contact was created.
updated_at	DateTime	The date time of when the Contact was last updated.
linked_contact	LinkedContact	Represents the instance of where the Contact is linked to another resource. This attribute will automatically be included in certain endpoints / responses.

Allowed includes

Relation	Type	Description
tenant	Tenant	The Tenant the Contact belongs to.
owner	User	The User who "owns" the Contact.

Allowed filters

Name	Type	Description
id	Integer	Filter Contacts by their id.
status	Boolean	Filter Contacts by their status.
first_name	String	Filter Contacts by their first name.
last_name	String	Filter Contacts by their last name.
email	String	Filter Contacts by their email.
search	String	Filter Contacts by a specific search term.
has_email	Boolean	Filter Contacts that have or don't have an email.
has_attributes	Array | String	Filter Contacts that have values for the specified attributes.
missing_attributes	Array | String	Filter Contacts that don't have values for the specified attributes.

Allowed sorts

Name	Description
first_name	Sort Contacts by their first name.
last_name	Sort Contacts by their last name.
email	Sort Contacts by their email.
address_street	Sort Contacts by their street address.
address_city	Sort Contacts by their city address.
address_state	Sort Contacts by their state address.
address_zip	Sort Contacts by their zip address.
phone_home	Sort Contacts by their home phone number.
phone_work	Sort Contacts by their work phone number.
phone_cell	Sort Contacts by their cell phone number.
status	Sort Contacts by their status.
updated_at	Sort Contacts by when they where last updated.
created_at	Sort Contacts by when they where created.

Notes

📌 Contact Linking: Contacts can be "linked" or associated with other resources. For example a Project or Account might have one or many Contacts linked to it.