Skip to main content
GET
Get contact

Authorizations

Authorization
string
header
required

Bearer access token issued by Peerlogic.

Path Parameters

id
string
required

Contact ID.

Response

Contact details.

id
string
read-only
Minimum string length: 1
created_at
string<date-time>
read-only
name
string | null
read-only
Minimum string length: 1
name_first
string | null
read-only
Minimum string length: 1
name_last
string | null
read-only
Minimum string length: 1
name_middle
string | null
read-only
Minimum string length: 1
name_preferred
string | null
read-only
Minimum string length: 1
organization
string | null
read-only
Minimum string length: 1
title
string | null
read-only
Minimum string length: 1
email
string<email> | null
read-only
Minimum string length: 1
phone_numbers
object[]
read-only
address_line_1
string | null
read-only
Minimum string length: 1
address_line_2
string | null
read-only
Minimum string length: 1
address_city
string | null
read-only
Minimum string length: 1
address_state
string | null
read-only
Minimum string length: 1
zip_code
string | null
read-only
Minimum string length: 1
date_of_birth
string<date> | null
read-only
gender
enum<string> | null
read-only
Available options:
male,
female
manually_edited_fields
string
read-only

List of field names manually edited by a user. These fields are protected from automatic overwrites during patient sync and contact import.

is_editable
string
read-only
is_deletable
string
read-only
next_appointment_at
string
read-only
next_appointment
string
read-only