Skip to main content
GET
cURL

Authorizations

X-API-KEY
string
header
required

Path Parameters

contact_id
integer
required

Query Parameters

structure
enum<string>
default:NESTED

Format of custom fields in response. NESTED returns array of objects with id, field_name, field_value. FLAT returns object with field names as keys.

Available options:
FLAT,
NESTED

Response

OK. The contact was successfully retrieved.

Mix in before ModelSerializer. save() hands email_status to the store, whose trigger sets the column.

id
integer
required
read-only
updated_time
string<date-time>
required
read-only
contact_custom_fields
string
required
read-only
first_campaign_email_sent
string<date-time>
required
read-only
last_campaign_email_sent
string<date-time>
required
read-only
last_reply_received
string<date-time>
required
read-only
previous_status
string | null
required
read-only
status_changed_at
string<date-time> | null
required
read-only
email_statuses
object[]
required
read-only

Each source's result for this email, newest check first. email_status shows the one that wins.

total_linkedin_messages_sent
integer
default:0
required
read-only
first_linkedin_message_sent
string<date-time>
required
read-only
last_linkedin_message_sent
string<date-time>
required
read-only
total_linkedin_message_replies
integer
default:0
required
read-only
last_linkedin_message_reply_received
string<date-time>
required
read-only
interested_linkedin_message_replies
integer
default:0
required
read-only
total_linkedin_inmails_sent
integer
default:0
required
read-only
first_linkedin_inmail_sent
string<date-time>
required
read-only
last_linkedin_inmail_sent
string<date-time>
required
read-only
total_linkedin_inmail_replies
integer
default:0
required
read-only
last_linkedin_inmail_reply_received
string<date-time>
required
read-only
interested_linkedin_inmail_replies
integer
default:0
required
read-only
total_linkedin_connection_requests_sent
integer
default:0
required
read-only
first_linkedin_connection_request_sent
string<date-time>
required
read-only
last_linkedin_connection_request_sent
string<date-time>
required
read-only
total_linkedin_connections_accepted
integer
default:0
required
read-only
first_linkedin_connection_accepted
string<date-time>
required
read-only
last_linkedin_connection_accepted
string<date-time>
required
read-only
email
string | null
linkedin_url
string | null
phone
string | null
phone_type
  • office - Office
  • mobile - Mobile
  • home - Home
  • direct - Direct
  • fax - Fax
  • url - URL
  • other - Other
Available options:
office,
mobile,
home,
direct,
fax,
url,
other
first_name
string
last_name
string
job_title
string | null
company_id
integer | null
origin
string
contact_status
string
do_not_contact
string | null
email_status
  • valid - Valid
  • invalid - Invalid
  • risky - Risky
  • catchall - Catchall
  • unknown - Unknown
  • bounced - Bounced
  • unsubscribed - Unsubscribed
Available options:
valid,
invalid,
risky,
catchall,
unknown,
bounced,
unsubscribed