Common ModelsLeads

/leads

Returns a list of Lead objects.

Authentication

AuthorizationBearer

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.

expandenumOptional
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
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](https://docs.merge.dev/integrations/hris/supported-features/).
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.

remote_idstringOptional
The API provider's ID for the given object.

Response

nextstring or null
previousstring or null
resultslist of objects or null
<MergeSupportedFieldsByIntegrationWidget requestType="GET" data="H4sIAAAAAAAAA+1abVPiSBD+K9Z8pICcsrgnVVdXLHCr3hE9Zb3ztqxUM2nCyCQTZyagbO1/v0oCEhRf0EQCxSeS7slDz8zTPd2d/CAUNDpC3pEaodIlReIKGzmpkb8QbFIk4DMTXIzV1nCPFIkKfF9IjfYfDLmtDiX2SI0YLkoHS4HHegxtg0rXYJ5GR4JmwlPG/VOlXvQYKRLOvAHadUpF4OlncOJxJYgHPrhVBmdKkyLxQSndlyJw+md4E6B6DjK0hqOLngZeskGDkXi8JOPnF8lCu23kqNFugoYmaqThBCd/1dfaVzXD6CP3y9Hflm0cGugZIDWjHJVRrRzsfT6oliYo0b//bjn8t93C9U1XdD8XLIdyC4JCu0Nvzc7RyLx2PpmNT7fm+FvVHA/G5vXgl4LlQKHdaVdPOpeVk2Z992TBAOt8/9+Diy/NL8dmgY5bFfP6cmR26G67Qwfd8VHl+CsdHR/+fWuOL/fazW8Vs9OqHn8VuyeNM9VunIl2vVwmRZLcR1L7/iMpmJCjTilyMT/2yAUHE2sS7wL4rOQHXc5oWVXK4MJYeDBSZSpcw0WbgXHKQfeEdCHCtNRNABLLvudMl54J737dSY20zMO62Wg15zlQHwLj0OVIaloG+Ii2pPadNM7adduWqFR5yiZSTEop03cPJOEo+UDoC6WBW1TYOK+Q6AqNFrPnxUqDxociiait3YXSvVjacoHxmSGeBjo1eE6F4Y0F8V2sP+0LD83A7aJ8MNWkZh4zqfHDa8uLbkiRiJEX/U7mRyWCRtsCPZOFtJ6/s3zQ/ZkoWpTJdeDbMwDNNEdyFSpvAibRPgUJLmqU4aZd/SwuJqBmQ2yA6wNzvHSIOI85JeK1nwkRU9rcV27hsqvb6zEv9oU01nWClrFrv21Fl1yZBhcK0417EWRWNHs+3k0WwdJ3PmYSCSdRYbFiGiBWGimf1idWZW7Qo6k9pU3ML+V4/Iw2YXVyyCOjn1DGNi/rFML3I7vS9IoIczVusYj8yZ3Jl0tkTf7N5u5h0D33hU6HvIdBV/lCv5w6mPXO0UUrb9TlCLZ6JZvXIVIn5vNeEj8BtTy3JyZjCEaF64N3F115Q5RRShwbNyebmEWKZG7aEUaPSaUtLyRzkXBIXCPYlhKBpJjI4JMmqawy+pAbgXpran/kKeb0NU8p+7yHW2llmV2mleX58PGhf3mXmMnseCGW9Ij81LR/IvjpJlEDBH+NaP/+HGvtOy0vusiSnGozKoUSPb3TvPPAZVTtVParO+fAo9MjRa5N8Sv71Qh9E3m3TIKUm17gNiVa+5TIDLTqI+fpeOwULT899nUM/LmsnZfk1Snz0ZZsmHJH8x527SrglWTZSzNptQn3B+bX96+Osw2vIV8581JrYU7hskyBlt+3/BU8UZ7Y4yBTjj8z3G3/+M156BrVRO/sGD81gtlvI7SIA2DqhA5xn4klmZ2oOSimPuz43bz66FF/LFcF0wed8OeBA7Jx1k7XLVWIGn4nt4GtjnWrtJ7y4kUv56dn4Srb2+/2wvykcR0EN7Qxrfx5hrdJHYo3v/7/yCpz+6HLi0wfCTnYSf0omSJbjbN2xl8e5rJ9kvf3MvmLuheaOWl/dDWMMHP5nWYWmzo7jdf27P0PPRvVYOc8tbcDUy5MkK1fR3qv0/lnm9yud525aYVjym4k+iL9Q30s+uJV5eG2dbOCynDb31nL/s7Vz/8BQtAXqsY4AAA=" />