List Contacts ​
Endpoint ​
GET /unified/marketing-automation/contacts
Integrations supported
- ActiveCampaign
- Beehiiv
- Constant Contact
- ConvertKit
- Customer.io
- Flodesk
- GetResponse
- Klaviyo
- Mailchimp
- MailerLite
Query parameters ​
Refer Specifying query parameters in Truto APIs
The ID of the integrated account to use for the request.
62f44730-dd91-461e-bd6a-aedd9e0ad79d
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
.
unified
raw
normalized
unified
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.
id
Ignores the limit
query parameter.
Excludes the remote_data
attribute from the response.
Array of fields to exclude from the response.
truto_exclude_fields[]=id&truto_exclude_fields[]=name
Query parameters to pass to the underlying API without any transformations. Refer this guide to see how to structure the query parameters.
remote_query[foo]=bar
Required in
- GetResponse
Supported in
- Constant Contact
The campaigns that the contact is added to
Supported in
- ConvertKit
The lists that the contact is subscribed to
Supported in
- ConvertKit
- Klaviyo
- MailerLite
The contact's tags
Supported in
- ActiveCampaign
- ConvertKit
The segments that the contact belongs to
Supported in
- ActiveCampaign
- Beehiiv
- Flodesk
- Klaviyo
- MailerLite
The workspace associated with the segment
Required in
- Beehiiv
The workspace's unique identifier
The contact's email
Supported in
- ActiveCampaign
The date and time of the contact's creation
Supported in
- ActiveCampaign
The date and time of the contact's last update
Supported in
- ActiveCampaign
The field to sort the resource by. Should be in format { fieldName: direction }
. The direction can be asc
or desc
.
created_at
email
name
Supported in
- ActiveCampaign
The contact's full name
Supported in
- ActiveCampaign
The contact's subscription status
active
bounced
cleaned
complained
unconfirmed
unsubscribed
Supported in
- Flodesk
Response Body ​
List of Contacts
The contact's unique identifier
Supported in
- ActiveCampaign
- Beehiiv
- Constant Contact
- ConvertKit
- Customer.io
- Flodesk
- GetResponse
- Klaviyo
- Mailchimp
- MailerLite
The contact's first name
Supported in
- ActiveCampaign
- Constant Contact
- ConvertKit
- Flodesk
- Klaviyo
- Mailchimp
- MailerLite
The contact's last name
Supported in
- ActiveCampaign
- Constant Contact
- Flodesk
- Klaviyo
- Mailchimp
- MailerLite
The contact's full name
Supported in
- ActiveCampaign
- Beehiiv
- Constant Contact
- Flodesk
- GetResponse
- Mailchimp
- MailerLite
The contact's email
Supported in
- ActiveCampaign
- Beehiiv
- Constant Contact
- ConvertKit
- Customer.io
- Flodesk
- GetResponse
- Klaviyo
- Mailchimp
- MailerLite
The contact's phone numbers
Supported in
- ActiveCampaign
- Constant Contact
- Klaviyo
- Mailchimp
The phone number
The phone number type
The contact's addresses
Supported in
- Constant Contact
- Klaviyo
- Mailchimp
The contact's first line of street address
The contact's second line of street address
The contact's city
The contact's state
The contact's country
The contact's postal code
The address type
The lists that the contact is subscribed to
Supported in
- Constant Contact
The list's unique identifier
The contact's tags
Supported in
- ActiveCampaign
- Beehiiv
- Constant Contact
- Mailchimp
The tag's unique identifier
The tag's name
The contact's subscription status
Supported in
- Beehiiv
- Constant Contact
- ConvertKit
- Flodesk
- Mailchimp
- MailerLite
The date and time of the contact's last update
Supported in
- ActiveCampaign
- Constant Contact
- Klaviyo
- Mailchimp
- MailerLite
The date and time of the contact's creation
Supported in
- ActiveCampaign
- Beehiiv
- Constant Contact
- ConvertKit
- Flodesk
- GetResponse
- Klaviyo
- MailerLite
Raw data returned from the remote API call.
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.