/contacts

Returns a list of Contact objects.

Authentication

AuthorizationBearer

Token-based authentication with required prefix “Bearer”

Headers

X-Account-TokenstringRequired
Token identifying the end user.

Query parameters

company_idstringOptional
If provided, will only return contacts for this company.
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_addressstringOptional
If provided, will only return Contacts that match this email.
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).

is_customerstringOptional
If provided, will only return Contacts that are denoted as customers.
is_supplierstringOptional
If provided, will only return Contacts that are denoted as suppliers.
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.
namestringOptional
If provided, will only return Contacts that match this name.
page_sizeintegerOptional
Number of results to return per page. The maximum limit is 100.
remote_fieldsenumOptional

Deprecated. Use show_enum_origins.

Allowed values:
remote_idstringOptional
The API provider's ID for the given object.
show_enum_originsenumOptional
A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
Allowed values:
statusenumOptional
If provided, will only return Contacts that match this status.
Allowed values:

Response

nextstring or null
previousstring or null
resultslist of objects or null
<MergeSupportedFieldsByIntegrationWidget requestType="GET" data="H4sIAAAAAAAAA9VZa2/iOBT9K8gfKyDTMrQq0mrFo89d0pmWzrY7qixjX4LBsVPbocBo/vvKIRT6mpaSdNiPsex7nXNOzvV1fiBKLARKT1ANEUpVLC2XASqiUDEQqIaaSlpCLSoiEnGfhPBgIh7toCIycRQpbYEdchDMHGvooRryQtABlGLJexyYt1jkcWkh0MRyJY13v7jUS1ajIhJcDoHVZwteDzebXkpHHj0aT3Djth8RY2xfqzjon8NtDOYNkd3eBIQgLRElRizxlqKU9CzMc2PuLRgIsMBaxJIWWKDuddOMfWsjU/O8PoionGQvMxh5ID2iLacCjFet7O/s7VdLaZQk+584EH9sbw1uu6q7t4UDKjCJt9odOvY7J3f+IPjsNz+P/ell1Z8Op/5g+GkLB2Sr3WlXzzrXlbNWffvsmQn4Yvdq/1uj1Tj1t+j0oOIPru/8Dt1ud+iwOz2pnB7Ru9Pjr2N/er3Tbl1W/M5B9fRIbZ81z027ea7a9XIZFdEyq6j2/cfyQCqcpgCiCw2lhubhgpOQBLAEzIwREvFSFHcFp2VTKZOQTJUkd6ZMVeiFwDjxkoA4CYgvbmOiAf+tAlUeRMGcAa7kPfyohg7847rfPGg9VER9RLggXQGoZnUMTySNat8RhIQLTBjTYJLtG0xjY1UIevaUqIUnT9K9bxFpCJUF7Lh7+IQjYvuLoThixALDxAnVkjGWcdgFjW7cjNuYa2BfiCYhWNBuLzc/i8/Be6gB6gFImw24XwSxPaXDngYgLiw2M4iH53bSOtopR/IDUJYjxSmY1UHl7AWAjSU2NusibfoZ6ngRL3cZp9AmiNJYa5B0gopPcIdxBHI2a4mCN2g+IpNwJsGorySkAJsNIa7NqVZG9WyhNZEk5NQUKrvVQiM2XIIxhSZIq4nIhtX7ZHieDFd2q3ieDKfJcFMJpfH++OBwd3cvl6/qAekqjIh0nFMNjFsslX1NDQFIcDu1mkhD6Mzj36kMk4c0lhRRRCOQTGkcxZr2iQGsNHNp1pfKIZdEUigQyQpnEcyLXaZu+4xo0rQYL3J+pEpelsVbSF+H6TxYVRImXa5ZxqzNw+ZOzOsFMkcHfr/x+mAvYm4hG9h9sMZFS08kvwDdr3dOvh28A/JFjxNpNQCa+Na6PppWVazB5cPC1YGHxXbutAJYAHrZcO9n/9qMk2mYWwhXcGg3Hfdi0eNCzD16ni4zVd33d6/WeSLAzL/vpbKfOsAMbpOZJXyNOR0mh69CC8zQqihbb1jEx9AYyMv4Ln/3fp9nP6Z8Aw9wS2SdSbffbLhahC2lTc5lb2e3sbedq7WkzvLYWFa2k43xkcw9YyUp5eYQFySApR5BqJgV6su3ZRko0OXAjWZ93gD+NboaVS4Gv9UqNqXxe79dJMyduCtMmtGtSMJTGnHO1WjEfbNHfodXrHEIeeQajw8lm+Yg63ePbz+APGsuseS3sVsF0rqr4hwN5x8ygrTb5FndRsyPIy42Pu6x8c4n+z9yl5wKyKrEKD1kZJIxI7OguZCxPgGPvsj3NvArAn0FWmWDsotUerVPzEjuq5rwRpXZDz1T/av6KstfQS7e0xv0TbxMXZ36F4ti/i548/M/k4smCCQeAAA=" />