Appearance

Get Contacts ​

Endpoint ​

http
GET /unified/marketing-automation/contacts/{id}
Integrations supported
  • Beehiiv
  • Constant Contact
  • ConvertKit
  • GetResponse
  • Klaviyo
  • Mailchimp

Path parameters ​

id
string
REQUIRED · 

The ID of the resource.

Example: 23423523

Query parameters ​

Refer Specifying query parameters in Truto APIs

integrated_account_id
string · uuid
REQUIRED · 

The ID of the integrated account to use for the request.

Example: 62f44730-dd91-461e-bd6a-aedd9e0ad79d
truto_response_format
string

The format of the response.

  • unified will return the response with unified mappings applied.
  • raw will return the raw response from the remote API.
  • normalized will apply the unified mappings and return the data in a normalized format.

Defaults to unified.

All possible enum values:
  • unified
  • raw
  • normalized
Example: unified
truto_ignore_remote_data
boolean

Excludes the remote_data attribute from the response.

truto_exclude_fields
array

Array of fields to exclude from the response.

Example: truto_exclude_fields[]=id&truto_exclude_fields[]=name
remote_query
object

Query parameters to pass to the underlying API without any transformations. Refer this guide to see how to structure the query parameters.

Example: remote_query[foo]=bar
workspace
object

The workspace associated with the segment

Required in
  • Beehiiv
id
string

The workspace's unique identifier

Response Body ​

id
string
REQUIRED · 

The contact's unique identifier

Supported in
  • Beehiiv
  • Constant Contact
  • ConvertKit
  • GetResponse
  • Klaviyo
  • Mailchimp
first_name
string

The contact's first name

Supported in
  • Constant Contact
  • ConvertKit
  • GetResponse
  • Klaviyo
  • Mailchimp
last_name
string

The contact's last name

Supported in
  • Constant Contact
  • GetResponse
  • Klaviyo
  • Mailchimp
name
string

The contact's full name

Supported in
  • Beehiiv
email
string

The contact's email

Supported in
  • Beehiiv
  • Constant Contact
  • ConvertKit
  • GetResponse
  • Klaviyo
  • Mailchimp
phones
object[]

The contact's phone numbers

Supported in
  • Constant Contact
  • Klaviyo
  • Mailchimp
phone
string

The phone number

type
string

The phone number type

addresses
object[]

The contact's addresses

Supported in
  • Constant Contact
  • Klaviyo
  • Mailchimp
street_1
string

The contact's first line of street address

street_2
string

The contact's second line of street address

city
string

The contact's city

state
string

The contact's state

country
string

The contact's country

postal_code
string

The contact's postal code

type
string

The address type

lists
object[]

The lists that the contact is subscribed to

Supported in
  • Constant Contact
  • GetResponse
  • Mailchimp
id
string

The list's unique identifier

tags
object[]

The contact's tags

Supported in
  • Beehiiv
  • Constant Contact
  • GetResponse
  • Mailchimp
id
string

The tag's unique identifier

name
string

The tag's name

status
string

The contact's subscription status

Supported in
  • Beehiiv
  • Constant Contact
  • ConvertKit
  • Mailchimp
updated_at
string · date-time

The date and time of the contact's last update

Supported in
  • Constant Contact
  • GetResponse
  • Klaviyo
  • Mailchimp
created_at
string · date-time

The date and time of the contact's creation

Supported in
  • Beehiiv
  • Constant Contact
  • ConvertKit
  • GetResponse
  • Klaviyo
  • Mailchimp
remote_data
object

Raw data returned from the remote API call.