Appearance

List Contacts ​

Endpoint ​

http
GET /unified/marketing-automation/contacts
Integrations supported
  • ActiveCampaign
  • Beehiiv
  • Brevo
  • Constant Contact
  • ConvertKit
  • Customer.io
  • Flodesk
  • GetResponse
  • Highlevel
  • Klaviyo
  • Mailchimp
  • MailerLite

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_key_by
string

By default the result attribute is an array of objects. This parameter allows you to specify a field in each result objects to use as key, which transforms the result array into an object with the array items keyed by the field. This is useful for when you want to use the result as a lookup table.

Example: id
truto_ignore_limit
boolean

Ignores the limit query parameter.

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
list_id
Required in
  • GetResponse
Supported in
  • Constant Contact
campaigns
array

The campaigns that the contact is added to

Supported in
  • ConvertKit
lists
array

Either set segment or lists

Supported in
  • Brevo
  • ConvertKit
  • Klaviyo
  • MailerLite
tags
array

The contact's tags

Supported in
  • ActiveCampaign
  • ConvertKit
  • Highlevel
segments
array
Integration specific notes
  • KlaviyoThe segments that the contact belongs to
  • BeehiivThe segments that the contact belongs to
  • MailerLiteThe segments that the contact belongs to
  • BrevoEither set segment or lists
Supported in
  • ActiveCampaign
  • Beehiiv
  • Brevo
  • Flodesk
  • Klaviyo
  • MailerLite
workspace
object
Integration specific notes
  • BeehiivThe workspace associated with the segment
  • HighlevelThe workspace associated with the contact.
Required in
  • Beehiiv
  • Highlevel
id
string

The workspace's unique identifier

email
string

The contact's email

Supported in
  • ActiveCampaign
  • Highlevel
created_at
string · date-time

The date and time of the contact's creation

Supported in
  • ActiveCampaign
updated_at
string · date-time

The date and time of the contact's last update

Supported in
  • ActiveCampaign
sort_by

The field to sort the resource by. Should be in format { fieldName: direction }. The direction can be asc or desc.

All possible enum values:
  • created_at
  • email
  • first_name
  • last_name
  • name
  • updated_at
Enum support by integration
  • ActiveCampaign
    • created_at
    • name
    • email
  • Highlevel
    • first_name
    • last_name
    • email
    • updated_at
    • created_at
Supported in
  • ActiveCampaign
  • Highlevel
name
string

The contact's full name

Supported in
  • ActiveCampaign
status
string

The contact's subscription status

All possible enum values:
  • active
  • bounced
  • cleaned
  • complained
  • unconfirmed
  • unsubscribed
Supported in
  • Flodesk
first_name
string

The contact's first name

Supported in
  • Highlevel
last_name
string

The contact's last name

Supported in
  • Highlevel
phones
array

The contact's phone numbers

Supported in
  • Highlevel
addresses
array

The contact's addresses

Supported in
  • Highlevel

Response Body ​

result
object[]

List of Contacts

id
string
REQUIRED · 

The contact's unique identifier

Supported in
  • ActiveCampaign
  • Beehiiv
  • Brevo
  • Constant Contact
  • ConvertKit
  • Customer.io
  • Flodesk
  • GetResponse
  • Highlevel
  • Klaviyo
  • Mailchimp
  • MailerLite
first_name
string

The contact's first name

Supported in
  • ActiveCampaign
  • Brevo
  • Constant Contact
  • ConvertKit
  • Flodesk
  • Highlevel
  • Klaviyo
  • Mailchimp
  • MailerLite
last_name
string

The contact's last name

Supported in
  • ActiveCampaign
  • Brevo
  • Constant Contact
  • Flodesk
  • Highlevel
  • Klaviyo
  • Mailchimp
  • MailerLite
name
string

The contact's full name

Supported in
  • ActiveCampaign
  • Beehiiv
  • Brevo
  • Constant Contact
  • Flodesk
  • GetResponse
  • Highlevel
  • Mailchimp
  • MailerLite
email
string

The contact's email

Supported in
  • ActiveCampaign
  • Beehiiv
  • Brevo
  • Constant Contact
  • ConvertKit
  • Customer.io
  • Flodesk
  • GetResponse
  • Highlevel
  • Klaviyo
  • Mailchimp
  • MailerLite
phones
object[]

The contact's phone numbers

Supported in
  • ActiveCampaign
  • Brevo
  • Constant Contact
  • Highlevel
  • Klaviyo
  • Mailchimp
phone
string

The phone number

type
string

The phone number type

addresses
object[]

The contact's addresses

Supported in
  • Constant Contact
  • Highlevel
  • 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
  • Brevo
  • Constant Contact
id
string

The list's unique identifier

tags
object[]

The contact's tags

Supported in
  • ActiveCampaign
  • Beehiiv
  • Constant Contact
  • Highlevel
  • Mailchimp
id
string

The tag's unique identifier

name
string

The tag's name

status
string

The contact's subscription status

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

The date and time of the contact's last update

Supported in
  • ActiveCampaign
  • Brevo
  • Constant Contact
  • Highlevel
  • Klaviyo
  • Mailchimp
  • MailerLite
created_at
string · date-time

The date and time of the contact's creation

Supported in
  • ActiveCampaign
  • Beehiiv
  • Brevo
  • Constant Contact
  • ConvertKit
  • Flodesk
  • GetResponse
  • Highlevel
  • Klaviyo
  • MailerLite
remote_data
object

Raw data returned from the remote API call.

next_cursor
string

The cursor to use for the next page of results. Pass this value as next_cursor in the query parameter in the next request to get the next page of results.