The intercom API reference.
Intercom API (2.9)
Download OpenAPI description
Overview
URL
License
Languages
Servers
The production API server
https://api.intercom.io/
The european API server
https://api.eu.intercom.io/
The australian API server
https://api.au.intercom.io/
Segment
A segment is a group of your contacts defined by the rules that you set.
Type of the contact: contact (lead) or user.
Enum"contact""user"
Example: "contact"
{ "type": "segment", "id": "56203d253cba154d39010062", "name": "Active", "created_at": 1394621988, "updated_at": 1394622004, "person_type": "contact", "count": 3 }
- The production API server
https://api.intercom.io/contacts/{contact_id}/segments
- The european API server
https://api.eu.intercom.io/contacts/{contact_id}/segments
- The australian API server
https://api.au.intercom.io/contacts/{contact_id}/segments
- curl
- Node.js
- Ruby
- PHP
- Python
- Java
- Go
- C#
- R
curl -i -X GET \
https://api.intercom.io/contacts/63a07ddf05a32042dffac965/segments \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
-H 'Intercom-Version: 2.9'
Response
application/json
{ "type": "list", "data": [ { … } ] }
- The production API server
https://api.intercom.io/segments
- The european API server
https://api.eu.intercom.io/segments
- The australian API server
https://api.au.intercom.io/segments
- curl
- Node.js
- Ruby
- PHP
- Python
- Java
- Go
- C#
- R
curl -i -X GET \
'https://api.intercom.io/segments?include_count=true' \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
-H 'Intercom-Version: 2.9'
Response
application/json
{ "type": "segment.list", "segments": [ { … }, { … } ] }
- The production API server
https://api.intercom.io/segments/{id}
- The european API server
https://api.eu.intercom.io/segments/{id}
- The australian API server
https://api.au.intercom.io/segments/{id}
- curl
- Node.js
- Ruby
- PHP
- Python
- Java
- Go
- C#
- R
curl -i -X GET \
https://api.intercom.io/segments/123 \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
-H 'Intercom-Version: 2.9'
Response
application/json
{ "type": "segment", "id": "6657abc26abd0164c24b0dcf", "name": "John segment", "created_at": 1717021634, "updated_at": 1717021634, "person_type": "user" }