For AI agents: a documentation index is available at the root level at /llms.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Token-based authentication with required prefix “Bearer”
Headers
X-Account-TokenstringRequired
Token identifying the end user.
Query parameters
converted_account_idstringOptional
If provided, will only return leads with this account.
converted_contact_idstringOptional
If provided, will only return leads with this contact.
created_afterdatetimeOptional
If provided, will only return objects created after this datetime.
created_beforedatetimeOptional
If provided, will only return objects created before this datetime.
cursorstringOptional
The pagination cursor value.
email_addressesstringOptional
If provided, will only return contacts matching the email addresses; multiple email_addresses can be separated by commas.
expandlist of enumsOptional
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
Allowed values:
include_deleted_databooleanOptional
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_databooleanOptional
Whether to include the original data Merge fetched from the third-party to produce these models.
include_remote_fieldsbooleanOptional
Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
include_shell_databooleanOptional
Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
modified_afterdatetimeOptional
If provided, only objects synced by Merge after this date time will be returned.
modified_beforedatetimeOptional
If provided, only objects synced by Merge before this date time will be returned.
owner_idstringOptional
If provided, will only return leads with this owner.
page_sizeintegerOptional
Number of results to return per page. The maximum limit is 100.
phone_numbersstringOptional
If provided, will only return contacts matching the phone numbers; multiple phone numbers can be separated by commas.
