Lists
The List object is used to represent a list of contacts in the remote system.
Properties
idUUID
Required
remote_idString
Optional
The third-party API ID of the matching object.
created_atDateTime (ISO 8601)
Required
The datetime that this object was created by Merge.
modified_atDateTime (ISO 8601)
Required
The datetime that this object was modified by Merge.
nameString
Optional
The list's name.
typeString
Optional
The list's type.
remote_created_atDateTime (ISO 8601)
Optional
When the list was created in the remote system.
remote_updated_atDateTime (ISO 8601)
Optional
When the list was last updated in the remote system.
remote_was_deletedBoolean
Required
Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. Learn more.
field_mappingsObject
Optional
remote_dataRemoteData[]
Optional
GET
/lists

https://api.merge.dev/api/mktg/v1/lists

US
EU
APAC

Returns a list of List objects.


Query & Path Parameters
created_afterDateTime (ISO 8601)
Optional
If provided, will only return objects created after this datetime.
created_beforeDateTime (ISO 8601)
Optional
If provided, will only return objects created before this datetime.
cursorString
Optional
The pagination cursor value.
include_deleted_dataBoolean
Optional
Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. Learn more.
include_remote_dataBoolean
Optional
Whether to include the original data Merge fetched from the third-party to produce these models.
include_shell_dataBoolean
Optional
Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
modified_afterDateTime (ISO 8601)
Optional
If provided, only objects synced by Merge after this date time will be returned.
modified_beforeDateTime (ISO 8601)
Optional
If provided, only objects synced by Merge before this date time will be returned.
page_sizeInteger
Optional
Number of results to return per page.
remote_idString
Optional
The API provider's ID for the given object.
Field support by integration
See all supported fields
Use the /linked-accounts endpoint to pull platform support information
ActiveCampaign
ActiveCampaign
Customer.io
Customer.io
getResponse
getResponse
Hubspot Marketing Hub
Hubspot Marketing Hub
Klaviyo
Klaviyo
Mailchimp
Mailchimp
MessageBird
MessageBird
SendGrid
SendGrid
Sendinblue
Sendinblue
POST
/lists

https://api.merge.dev/api/mktg/v1/lists

US
EU
APAC

Creates a List object with the given values.


Query & Path Parameters
is_debug_modeBoolean
Optional
Whether to include debug fields (such as log file links) in the response.
run_asyncBoolean
Optional
Whether or not third-party updates should be run asynchronously.
Body Parameters
modelObject
Required
Find available fields below under “Model Parameters”.
Model Parameters
View app-specific writable fields under “Field support by platform” in this section.
nameString
The list's name.
typeString
The list's type.
integration_paramsObject
linked_account_paramsObject
Field support by integration
See all supported fields
Use the /linked-accounts endpoint to pull platform support information
ActiveCampaign
ActiveCampaign
Customer.io
Customer.io
getResponse
getResponse
Hubspot Marketing Hub
Hubspot Marketing Hub
MessageBird
MessageBird
To include the correct model fields when making POST requests, use the GET /lists/meta/post endpoint. Learn more in our /meta guide.
GET
/lists/{id}

https://api.merge.dev/api/mktg/v1/lists/{id}

US
EU
APAC

Returns a List object with the given id.


Query & Path Parameters
idUUID
Required
include_remote_dataBoolean
Optional
Whether to include the original data Merge fetched from the third-party to produce these models.
Field support by integration
See all supported fields
Use the /linked-accounts endpoint to pull platform support information
ActiveCampaign
ActiveCampaign
Customer.io
Customer.io
getResponse
getResponse
Hubspot Marketing Hub
Hubspot Marketing Hub
Klaviyo
Klaviyo
Mailchimp
Mailchimp
MessageBird
MessageBird
SendGrid
SendGrid
Sendinblue
Sendinblue
GET
/lists/{parent_id}/subscribers

https://api.merge.dev/api/mktg/v1/lists/{parent_id}/subscribers

US
EU
APAC

Returns a list of Contact objects.


Query & Path Parameters
cursorString
Optional
The pagination cursor value.
include_deleted_dataBoolean
Optional
Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. Learn more.
include_remote_dataBoolean
Optional
Whether to include the original data Merge fetched from the third-party to produce these models.
include_shell_dataBoolean
Optional
Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
page_sizeInteger
Optional
Number of results to return per page.
parent_idUUID
Required
Field support by integration
See all supported fields
Use the /linked-accounts endpoint to pull platform support information
ActiveCampaign
ActiveCampaign
Customer.io
Customer.io
getResponse
getResponse
Hubspot Marketing Hub
Hubspot Marketing Hub
Klaviyo
Klaviyo
Mailchimp
Mailchimp
MessageBird
MessageBird
SendGrid
SendGrid
Sendinblue
Sendinblue
GET
/lists/meta/post

https://api.merge.dev/api/mktg/v1/lists/meta/post

US
EU
APAC

Returns metadata for MKTGList POSTs.


Field support by integration
See all supported fields
Use the /linked-accounts endpoint to pull platform support information
ActiveCampaign
ActiveCampaign
Customer.io
Customer.io
getResponse
getResponse
Hubspot Marketing Hub
Hubspot Marketing Hub
MessageBird
MessageBird
Previous
Events
Next Up
Messages