Contacts

The contacts resource is used to track persons and organizations.

Contact object

{
  "id": "019eb9a9-f3e4-7c39-8e18-2g499s0a3kk2",
  "tenant": "019eb9a9-f241-77da-82cd-cf2f36b4e25b",
  "name": "Justin Reed",
  "contact_identifier": "10120",
  "is_organization": false,
  "address_street": "123 Main St",
  "address_street_2": null,
  "address_city": "Orlando",
  "address_state": "FL",
  "address_postal_code": "32801",
  "address_region": null,
  "address_country": "US",
  "phone_home": null,
  "phone_mobile": "(407) 555-5398",
  "phone_work": null,
  "fax": null,
  "email": null,
  "url": null,
  "preferred_contact_method": null,
  "preferred_language": null,
  "preferred_pronouns": "He/him",
  "organization": null,
  "title": null,
  "emergency_contact": null,
  "birthdate": "1990-10-26",
  "notes": null,
  "meta": null,
  "archived_at": null,
  "created_at": "2025-08-13 14:31:42",
  "updated_at": "2026-05-03 18:31:04"
}

Fields

• id
  required readonly string
  Unique ID of the record.
• tenant
  required readonly string
  Unique ID of the tenant.
• name
  required string
  Name of the contact.
• contact_identifier
  nullable string
  Unique identifier for the contact within the tenant.
• is_organization
  boolean
  Whether the contact is an organization. The default value is false.
• address_street
  nullable string
  Street address of the contact.
• address_street_2
  nullable string
  Second line of the street address.
• address_city
  nullable string
  City of the contact.
• address_state
  nullable string
  State or province of the contact.
• address_postal_code
  nullable string
  Postal code of the contact.
• address_region
  nullable string
  Region/county of the contact.
• address_country
  nullable string
  Country of the contact.
• phone_home
  nullable string
  Home phone number of the contact.
• phone_mobile
  nullable string
  Mobile phone number of the contact.
• phone_work
  nullable string
  Work phone number of the contact.
• fax
  nullable string
  Fax number of the contact.
• email
  nullable string
  Email address of the contact.
• url
  nullable string
  Website URL of the contact.
• preferred_contact_method
  nullable string
  Preferred contact method of the contact. One of:

  • email
  • mail
  • phone_home
  • phone_mobile
  • phone_work
  • social_media
  • text_message
  • other
• preferred_language
  nullable string
  Preferred language of the contact.
• preferred_pronouns
  nullable string
  Preferred pronouns of the contact.
• organization
  nullable string
  Contact ID of the organization that the contact belongs to.
• title
  nullable string
  Title of the contact.
• emergency_contact
  nullable string
  Contact ID of the emergency contact for the contact.
• birthdate
  nullable string
  Birthdate of the contact in YYYY-MM-DD format.
• notes
  nullable string
  Additional notes about the contact.
• meta
  nullable object
  Additional metadata about the contact.
• archived_at
  nullable string
  UTC timestamp of when the record was archived.
• created_at
  required readonly string
  UTC timestamp of when the record was created.
• updated_at
  nullable readonly string
  UTC timestamp of when the record was last updated.

Create a contact

POST /tenants/{tenantId}/contacts

The request body must include a contact object.

Required permissions

contacts:create

Response

List contacts

GET /tenants/{tenantId}/contacts

Required permissions

contacts:read

Response

Read a contact

GET /tenants/{tenantId}/contacts/{id}

Required permissions

contacts:read

Response

Update a contact

PATCH /tenants/{tenantId}/contacts/{id}

The request body must include parts of a contact object.

Required permissions

contacts:update

Response

Delete a contact

DELETE /tenants/{tenantId}/contacts/{id}

Required permissions

contacts:delete

Response