Skip to content
GET /unified/marketing-automation/contacts

Query Parameters

Refer Specifying query parameters in Truto APIs

tagsobject[]

The contact's tags

References: Tags → id
5 supported
ActiveCampaign
supported
Beehiiv
supported
Constant Contact
supported
Highlevel
supported
Mailchimp
supported
idstring

The tag's unique identifier

namestring

The tag's name

segmentsobject[]
6 supported4 notes
Beehiiv
supported

The segments that the contact belongs to

Brevo
supported

Either set segment or lists

Klaviyo
supported

The segments that the contact belongs to

MailerLite
supported

The segments that the contact belongs to

ActiveCampaign
supported
Flodesk
supported
idstring

The segment's unique identifier

emailstring

The contact's email

12 supported
ActiveCampaign
supported
Beehiiv
supported
Brevo
supported
Constant Contact
supported
ConvertKit
supported
Customer.io
supported
Flodesk
supported
GetResponse
supported
Highlevel
supported
Klaviyo
supported
Mailchimp
supported
MailerLite
supported
created_atstring · date-time

The date and time of the contact's creation

10 supported
ActiveCampaign
supported
Beehiiv
supported
Brevo
supported
Constant Contact
supported
ConvertKit
supported
Flodesk
supported
GetResponse
supported
Highlevel
supported
Klaviyo
supported
MailerLite
supported
updated_atstring · date-time

The date and time of the contact's last update

7 supported
ActiveCampaign
supported
Brevo
supported
Constant Contact
supported
Highlevel
supported
Klaviyo
supported
Mailchimp
supported
MailerLite
supported
sort_by
Possible values:
created_atemailfirst_namelast_namenameupdated_at
2 supported
ActiveCampaign
supported
created_atnameemail
Highlevel
supported
first_namelast_nameemailupdated_atcreated_at
namestring

The contact's full name

9 supported
ActiveCampaign
supported
Beehiiv
supported
Brevo
supported
Constant Contact
supported
Flodesk
supported
GetResponse
supported
Highlevel
supported
Mailchimp
supported
MailerLite
supported
workspaceobject
2 supported2 required2 notes
Beehiiv
required

The workspace associated with the segment

Highlevel
required

The workspace associated with the contact.

idstring

The workspace's unique identifier

listsobject[]

Either set segment or lists

References: Lists → id
2 supported
Brevo
supported
Constant Contact
supported
idstring

The list's unique identifier

list_id
2 supported1 required
GetResponse
required
Constant Contact
supported
campaignsobject[]

The campaigns that the contact is added to

1 supported
ConvertKit
supported
idstring

The campaign's unique identifier

statusstring

The contact's subscription status

Possible values:
activebouncedcleanedcomplainedunconfirmedunsubscribed
7 supported
Beehiiv
supported
Brevo
supported
Constant Contact
supported
ConvertKit
supported
Flodesk
supported
Mailchimp
supported
MailerLite
supported
first_namestring

The contact's first name

9 supported
ActiveCampaign
supported
Brevo
supported
Constant Contact
supported
ConvertKit
supported
Flodesk
supported
Highlevel
supported
Klaviyo
supported
Mailchimp
supported
MailerLite
supported
last_namestring

The contact's last name

8 supported
ActiveCampaign
supported
Brevo
supported
Constant Contact
supported
Flodesk
supported
Highlevel
supported
Klaviyo
supported
Mailchimp
supported
MailerLite
supported
phonesobject[]

The contact's phone numbers

6 supported
ActiveCampaign
supported
Brevo
supported
Constant Contact
supported
Highlevel
supported
Klaviyo
supported
Mailchimp
supported
phonestring

The phone number

typestring

The phone number type

addressesobject[]

The contact's addresses

4 supported
Constant Contact
supported
Highlevel
supported
Klaviyo
supported
Mailchimp
supported
citystring

The contact's city

countrystring

The contact's country

postal_codestring

The contact's postal code

statestring

The contact's state

street_1string

The contact's first line of street address

street_2string

The contact's second line of street address

typestring

The address type

list
1 supported1 required
Mailchimp
required
id
required
Show Truto-specific parameters
integrated_account_idstring · uuid
required·

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

Example: 62f44730-dd91-461e-bd6a-aedd9e0ad79d
truto_response_formatstring

The format of the response.

  • unified returns the response with unified mappings applied.
  • raw returns the unprocessed, raw response from the remote API.
  • normalized applies the unified mappings and returns the data in a normalized format.
  • stream returns the response as a stream, which is ideal for transmitting large datasets, files, or binary data. Using streaming mode helps to efficiently handle large payloads or real-time data flows without requiring the entire data to be buffered in memory.

Defaults to unified.

Example: unified
Possible values:
unifiedrawnormalizedstream
truto_key_bystring

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_limitboolean

Ignores the limit query parameter.

truto_ignore_remote_databoolean

Excludes the remote_data attribute from the response.

truto_exclude_fieldsstring[]

Array of fields to exclude from the response.

Example: truto_exclude_fields[]=id&truto_exclude_fields[]=name
remote_queryRecord<string, any>

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

Response Body

next_cursorstring

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.

resultobject[]

List of Contacts

idstring
required·

The contact's unique identifier

12 supported
ActiveCampaign
supported
Beehiiv
supported
Brevo
supported
Constant Contact
supported
ConvertKit
supported
Customer.io
supported
Flodesk
supported
GetResponse
supported
Highlevel
supported
Klaviyo
supported
Mailchimp
supported
MailerLite
supported
addressesobject[]

The contact's addresses

4 supported
Constant Contact
supported
Highlevel
supported
Klaviyo
supported
Mailchimp
supported
7 properties
citystring

The contact's city

countrystring

The contact's country

postal_codestring

The contact's postal code

statestring

The contact's state

street_1string

The contact's first line of street address

street_2string

The contact's second line of street address

typestring

The address type

created_atstring · date-time

The date and time of the contact's creation

10 supported
ActiveCampaign
supported
Beehiiv
supported
Brevo
supported
Constant Contact
supported
ConvertKit
supported
Flodesk
supported
GetResponse
supported
Highlevel
supported
Klaviyo
supported
MailerLite
supported
emailstring

The contact's email

12 supported
ActiveCampaign
supported
Beehiiv
supported
Brevo
supported
Constant Contact
supported
ConvertKit
supported
Customer.io
supported
Flodesk
supported
GetResponse
supported
Highlevel
supported
Klaviyo
supported
Mailchimp
supported
MailerLite
supported
first_namestring

The contact's first name

9 supported
ActiveCampaign
supported
Brevo
supported
Constant Contact
supported
ConvertKit
supported
Flodesk
supported
Highlevel
supported
Klaviyo
supported
Mailchimp
supported
MailerLite
supported
last_namestring

The contact's last name

8 supported
ActiveCampaign
supported
Brevo
supported
Constant Contact
supported
Flodesk
supported
Highlevel
supported
Klaviyo
supported
Mailchimp
supported
MailerLite
supported
listsobject[]

The lists that the contact is subscribed to

References: Lists → id
2 supported
Brevo
supported
Constant Contact
supported
1 property
idstring

The list's unique identifier

namestring

The contact's full name

9 supported
ActiveCampaign
supported
Beehiiv
supported
Brevo
supported
Constant Contact
supported
Flodesk
supported
GetResponse
supported
Highlevel
supported
Mailchimp
supported
MailerLite
supported
phonesobject[]

The contact's phone numbers

6 supported
ActiveCampaign
supported
Brevo
supported
Constant Contact
supported
Highlevel
supported
Klaviyo
supported
Mailchimp
supported
2 properties
phonestring

The phone number

typestring

The phone number type

remote_dataRecord<string, any>

Raw data returned from the remote API call.

statusstring

The contact's subscription status

7 supported
Beehiiv
supported
Brevo
supported
Constant Contact
supported
ConvertKit
supported
Flodesk
supported
Mailchimp
supported
MailerLite
supported
tagsobject[]

The contact's tags

References: Tags → id
5 supported
ActiveCampaign
supported
Beehiiv
supported
Constant Contact
supported
Highlevel
supported
Mailchimp
supported
2 properties
idstring

The tag's unique identifier

namestring

The tag's name

updated_atstring · date-time

The date and time of the contact's last update

7 supported
ActiveCampaign
supported
Brevo
supported
Constant Contact
supported
Highlevel
supported
Klaviyo
supported
Mailchimp
supported
MailerLite
supported
curl -X GET 'https://api.truto.one/unified/marketing-automation/contacts?integrated_account_id=<integrated_account_id>' \
  -H 'Authorization: Bearer <your_api_token>' \
  -H 'Content-Type: application/json'
const integratedAccountId = '<integrated_account_id>';

const response = await fetch(`https://api.truto.one/unified/marketing-automation/contacts?integrated_account_id=${integratedAccountId}`, {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer <your_api_token>',
    'Content-Type': 'application/json',
  },
});

const data = await response.json();
console.log(data);
import requests

url = "https://api.truto.one/unified/marketing-automation/contacts"
headers = {
    "Authorization": "Bearer <your_api_token>",
    "Content-Type": "application/json",
}
params = {
    "integrated_account_id": "<integrated_account_id>"
}

response = requests.get(url, headers=headers, params=params)
print(response.json())
import Truto from '@truto/truto-ts-sdk';

const truto = new Truto({
  token: '<your_api_token>',
});

const result = await truto.unifiedApi.list(
  'marketing-automation',
  'contacts',
  { integrated_account_id: '<integrated_account_id>' }
);

console.log(result);
import asyncio
from truto_python_sdk import TrutoApi

truto_api = TrutoApi(token="<your_api_token>")

async def main():
    async for item in truto_api.unified_api.list(
        "marketing-automation",
        "contacts",
        {"integrated_account_id": "<integrated_account_id>"}
    ):
        print(item)

asyncio.run(main())