Skip to main content
​
id
string

The contact's unique identifier.

Example:

"con_01HQFQ9QWTNNPY58FZ8CB3FWWK"

​
type
string

The contact's type.

Example:

"referrer"

​
title
string | null

The contact's honorific title.

Example:

"Dr"

​
first_name
string

The contact's given name.

Example:

"John"

​
last_name
string | null

The contact's family name.

Example:

"Smith"

​
preferred_name
string | null

The contact's preferred name.

Example:

"Johnny"

​
profession
string | null

The contact's profession or occupation.

Example:

"General Practitioner"

​
company
string | null

The contact's company or organization.

Example:

"City Medical Centre"

​
email
string | null

The contact's email address.

Example:

"[email protected]"

​
notes
string | null

The contact's notes.

Example:

"Preferred referrer for orthopedic cases."

​
phone_numbers
object[]

A list of the contact's phone numbers.

Example:
[
  {
    "id": "pho_01HQR12PABCD1234EFGH56789",
    "code": "+61",
    "number": "400123456",
    "type": "mobile"
  }
]
​
address
object

The contact's address details.

Example:
{
  "line1": "123 Medical Street",
  "line2": "Suite 4",
  "city": "Sydney",
  "state": "NSW",
  "postal_code": "2000",
  "country_code": "AU"
}
​
created_at
string

The timestamp when the contact was created (ISO 8601).

Example:

"2024-01-01T12:00:00Z"