# Contacts Everything about your contacts ## List attached contacts - [GET /companies/{id}/contacts](https://developers.intercom.com/docs/references/2.10/rest-api/api.intercom.io/companies/listattachedcontacts.md): You can fetch a list of all contacts that belong to a company. ## Attach a Contact to a Company - [POST /contacts/{id}/companies](https://developers.intercom.com/docs/references/2.10/rest-api/api.intercom.io/companies/attachcontacttoacompany.md): You can attach a company to a single contact. ## List attached companies for contact - [GET /contacts/{id}/companies](https://developers.intercom.com/docs/references/2.10/rest-api/api.intercom.io/companies/listcompaniesforacontact.md): You can fetch a list of companies that are associated to a contact. ## Detach a contact from a company - [DELETE /contacts/{contact_id}/companies/{id}](https://developers.intercom.com/docs/references/2.10/rest-api/api.intercom.io/companies/detachcontactfromacompany.md): You can detach a company from a single contact. ## List attached contacts - [GET /companies/{id}/contacts](https://developers.intercom.com/docs/references/2.10/rest-api/api.intercom.io/contacts/listattachedcontacts.md): You can fetch a list of all contacts that belong to a company. ## Attach a Contact to a Company - [POST /contacts/{id}/companies](https://developers.intercom.com/docs/references/2.10/rest-api/api.intercom.io/contacts/attachcontacttoacompany.md): You can attach a company to a single contact. ## List attached companies for contact - [GET /contacts/{id}/companies](https://developers.intercom.com/docs/references/2.10/rest-api/api.intercom.io/contacts/listcompaniesforacontact.md): You can fetch a list of companies that are associated to a contact. ## Detach a contact from a company - [DELETE /contacts/{contact_id}/companies/{id}](https://developers.intercom.com/docs/references/2.10/rest-api/api.intercom.io/contacts/detachcontactfromacompany.md): You can detach a company from a single contact. ## List all notes - [GET /contacts/{id}/notes](https://developers.intercom.com/docs/references/2.10/rest-api/api.intercom.io/contacts/listnotes.md): You can fetch a list of notes that are associated to a contact. ## Create a note - [POST /contacts/{id}/notes](https://developers.intercom.com/docs/references/2.10/rest-api/api.intercom.io/contacts/createnote.md): You can add a note to a single contact. ## List attached segments for contact - [GET /contacts/{contact_id}/segments](https://developers.intercom.com/docs/references/2.10/rest-api/api.intercom.io/contacts/listsegmentsforacontact.md): You can fetch a list of segments that are associated to a contact. ## List subscriptions for a contact - [GET /contacts/{contact_id}/subscriptions](https://developers.intercom.com/docs/references/2.10/rest-api/api.intercom.io/contacts/listsubscriptionsforacontact.md): You can fetch a list of subscription types that are attached to a contact. These can be subscriptions that a user has 'opted-in' to or has 'opted-out' from, depending on the subscription type. This will return a list of Subscription Type objects that the contact is associated with. The data property will show a combined list of: 1.Opt-out subscription types that the user has opted-out from. 2.Opt-in subscription types that the user has opted-in to receiving. ## Add subscription to a contact - [POST /contacts/{contact_id}/subscriptions](https://developers.intercom.com/docs/references/2.10/rest-api/api.intercom.io/contacts/attachsubscriptiontypetocontact.md): You can add a specific subscription to a contact. In Intercom, we have two different subscription types based on user consent - opt-out and opt-in: 1.Attaching a contact to an opt-out subscription type will opt that user out from receiving messages related to that subscription type. 2.Attaching a contact to an opt-in subscription type will opt that user in to receiving messages related to that subscription type. This will return a subscription type model for the subscription type that was added to the contact. ## Remove subscription from a contact - [DELETE /contacts/{contact_id}/subscriptions/{id}](https://developers.intercom.com/docs/references/2.10/rest-api/api.intercom.io/contacts/detachsubscriptiontypetocontact.md): You can remove a specific subscription from a contact. This will return a subscription type model for the subscription type that was removed from the contact. ## List tags attached to a contact - [GET /contacts/{contact_id}/tags](https://developers.intercom.com/docs/references/2.10/rest-api/api.intercom.io/contacts/listtagsforacontact.md): You can fetch a list of all tags that are attached to a specific contact. ## Add tag to a contact - [POST /contacts/{contact_id}/tags](https://developers.intercom.com/docs/references/2.10/rest-api/api.intercom.io/contacts/attachtagtocontact.md): You can tag a specific contact. This will return a tag object for the tag that was added to the contact. ## Remove tag from a contact - [DELETE /contacts/{contact_id}/tags/{id}](https://developers.intercom.com/docs/references/2.10/rest-api/api.intercom.io/contacts/detachtagfromcontact.md): You can remove tag from a specific contact. This will return a tag object for the tag that was removed from the contact. ## Update a contact - [PUT /contacts/{id}](https://developers.intercom.com/docs/references/2.10/rest-api/api.intercom.io/contacts/updatecontact.md): You can update an existing contact (ie. user or lead). ## Get a contact - [GET /contacts/{id}](https://developers.intercom.com/docs/references/2.10/rest-api/api.intercom.io/contacts/showcontact.md): You can fetch the details of a single contact. ## Delete a contact - [DELETE /contacts/{id}](https://developers.intercom.com/docs/references/2.10/rest-api/api.intercom.io/contacts/deletecontact.md): You can delete a single contact. ## Merge a lead and a user - [POST /contacts/merge](https://developers.intercom.com/docs/references/2.10/rest-api/api.intercom.io/contacts/mergecontact.md): You can merge a contact with a of into a contact with a of . ## Search contacts - [POST /contacts/search](https://developers.intercom.com/docs/references/2.10/rest-api/api.intercom.io/contacts/searchcontacts.md): You can search for multiple contacts by the value of their attributes in order to fetch exactly who you want. To search for contacts, you need to send a request to . This will accept a query object in the body which will define your filters in order to search for contacts. {% admonition type="warning" name="Optimizing search queries" %} Search queries can be complex, so optimizing them can help the performance of your search. Use the and operators to combine multiple filters to get the exact results you need and utilize pagination to limit the number of results returned. The default is results per page. See the pagination section for more details on how to use the param. {% /admonition %} ### Contact Creation Delay If a contact has recently been created, there is a possibility that it will not yet be available when searching. This means that it may not appear in the response. This delay can take a few minutes. If you need to be instantly notified it is recommended to use webhooks and iterate to see if they match your search filters. ### Nesting & Limitations You can nest these filters in order to get even more granular insights that pinpoint exactly what you need. Example: (1 OR 2) AND (3 OR 4). There are some limitations to the amount of multiple's there can be: * There's a limit of max 2 nested filters * There's a limit of max 15 filters for each AND or OR group ### Searching for Timestamp Fields All timestamp fields (created_at, updated_at etc.) are indexed as Dates for Contact Search queries; Datetime queries are not currently supported. This means you can only query for timestamp fields by day - not hour, minute or second. For example, if you search for all Contacts with a created_at value greater (>) than 1577869200 (the UNIX timestamp for January 1st, 2020 9:00 AM), that will be interpreted as 1577836800 (January 1st, 2020 12:00 AM). The search results will then include Contacts created from January 2nd, 2020 12:00 AM onwards. If you'd like to get contacts created on January 1st, 2020 you should search with a created_at value equal (=) to 1577836800 (January 1st, 2020 12:00 AM). This behaviour applies only to timestamps used in search queries. The search results will still contain the full UNIX timestamp and be sorted accordingly. ### Accepted Fields Most key listed as part of the Contacts Model are searchable, whether writeable or not. The value you search for has to match the accepted type, otherwise the query will fail (ie. as accepts a date, the cannot be a string such as ). | Field | Type | | ---------------------------------- | ------------------------------ | | id | String | | role | StringAccepts user or lead | | name | String | | avatar | String | | owner_id | Integer | | email | String | | email_domain | String | | phone | String | | external_id | String | | created_at | Date (UNIX Timestamp) | | signed_up_at | Date (UNIX Timestamp) | | updated_at | Date (UNIX Timestamp) | | last_seen_at | Date (UNIX Timestamp) | | last_contacted_at | Date (UNIX Timestamp) | | last_replied_at | Date (UNIX Timestamp) | | last_email_opened_at | Date (UNIX Timestamp) | | last_email_clicked_at | Date (UNIX Timestamp) | | language_override | String | | browser | String | | browser_language | String | | os | String | | location.country | String | | location.region | String | | location.city | String | | unsubscribed_from_emails | Boolean | | marked_email_as_spam | Boolean | | has_hard_bounced | Boolean | | ios_last_seen_at | Date (UNIX Timestamp) | | ios_app_version | String | | ios_device | String | | ios_app_device | String | | ios_os_version | String | | ios_app_name | String | | ios_sdk_version | String | | android_last_seen_at | Date (UNIX Timestamp) | | android_app_version | String | | android_device | String | | android_app_name | String | | andoid_sdk_version | String | | segment_id | String | | tag_id | String | | custom_attributes.{attribute_name} | String | ### Accepted Operators {% admonition type="warning" name="Searching based on " %} You cannot use the operators to search by . {% /admonition %} The table below shows the operators you can use to define how you want to search for the value. The operator should be put in as a string (). The operator has to be compatible with the field's type (eg. you cannot search with for a given string value as it's only compatible for integer's and dates). | Operator | Valid Types | Description | | :------- | :------------------------------- | :--------------------------------------------------------------- | | = | All | Equals | | != | All | Doesn't Equal | | IN | All | InShortcut for queriesValues must be in Array | | NIN | All | Not InShortcut for queriesValues must be in Array | | > | IntegerDate (UNIX Timestamp) | Greater than | | Date (UNIX Timestamp) | Lower than | | ~ | String | Contains | | !~ | String | Doesn't Contain | | ^ | String | Starts With | | $ | String | Ends With | ## List all contacts - [GET /contacts](https://developers.intercom.com/docs/references/2.10/rest-api/api.intercom.io/contacts/listcontacts.md): You can fetch a list of all contacts (ie. users or leads) in your workspace. {% admonition type="warning" name="Pagination" %} You can use pagination to limit the number of results returned. The default is results per page. See the pagination section for more details on how to use the param. {% /admonition %} ## Create contact - [POST /contacts](https://developers.intercom.com/docs/references/2.10/rest-api/api.intercom.io/contacts/createcontact.md): You can create a new contact (ie. user or lead). ## Archive contact - [POST /contacts/{id}/archive](https://developers.intercom.com/docs/references/2.10/rest-api/api.intercom.io/contacts/archivecontact.md): You can archive a single contact. ## Unarchive contact - [POST /contacts/{id}/unarchive](https://developers.intercom.com/docs/references/2.10/rest-api/api.intercom.io/contacts/unarchivecontact.md): You can unarchive a single contact. ## List all notes - [GET /contacts/{id}/notes](https://developers.intercom.com/docs/references/2.10/rest-api/api.intercom.io/notes/listnotes.md): You can fetch a list of notes that are associated to a contact. ## Create a note - [POST /contacts/{id}/notes](https://developers.intercom.com/docs/references/2.10/rest-api/api.intercom.io/notes/createnote.md): You can add a note to a single contact. ## List attached segments for contact - [GET /contacts/{contact_id}/segments](https://developers.intercom.com/docs/references/2.10/rest-api/api.intercom.io/segments/listsegmentsforacontact.md): You can fetch a list of segments that are associated to a contact. ## List subscriptions for a contact - [GET /contacts/{contact_id}/subscriptions](https://developers.intercom.com/docs/references/2.10/rest-api/api.intercom.io/subscription-types/listsubscriptionsforacontact.md): You can fetch a list of subscription types that are attached to a contact. These can be subscriptions that a user has 'opted-in' to or has 'opted-out' from, depending on the subscription type. This will return a list of Subscription Type objects that the contact is associated with. The data property will show a combined list of: 1.Opt-out subscription types that the user has opted-out from. 2.Opt-in subscription types that the user has opted-in to receiving. ## Add subscription to a contact - [POST /contacts/{contact_id}/subscriptions](https://developers.intercom.com/docs/references/2.10/rest-api/api.intercom.io/subscription-types/attachsubscriptiontypetocontact.md): You can add a specific subscription to a contact. In Intercom, we have two different subscription types based on user consent - opt-out and opt-in: 1.Attaching a contact to an opt-out subscription type will opt that user out from receiving messages related to that subscription type. 2.Attaching a contact to an opt-in subscription type will opt that user in to receiving messages related to that subscription type. This will return a subscription type model for the subscription type that was added to the contact. ## Remove subscription from a contact - [DELETE /contacts/{contact_id}/subscriptions/{id}](https://developers.intercom.com/docs/references/2.10/rest-api/api.intercom.io/subscription-types/detachsubscriptiontypetocontact.md): You can remove a specific subscription from a contact. This will return a subscription type model for the subscription type that was removed from the contact. ## List tags attached to a contact - [GET /contacts/{contact_id}/tags](https://developers.intercom.com/docs/references/2.10/rest-api/api.intercom.io/tags/listtagsforacontact.md): You can fetch a list of all tags that are attached to a specific contact. ## Add tag to a contact - [POST /contacts/{contact_id}/tags](https://developers.intercom.com/docs/references/2.10/rest-api/api.intercom.io/tags/attachtagtocontact.md): You can tag a specific contact. This will return a tag object for the tag that was added to the contact. ## Remove tag from a contact - [DELETE /contacts/{contact_id}/tags/{id}](https://developers.intercom.com/docs/references/2.10/rest-api/api.intercom.io/tags/detachtagfromcontact.md): You can remove tag from a specific contact. This will return a tag object for the tag that was removed from the contact.