API & Webhooks Reference
Building Apps
Installing Intercom
API & Webhooks Reference
Canvas Kit Reference
Home
Docs
Tutorials
API Reference
Reference
Latest updates
Discussions
Page Not Found
Search
{{ state.current().meta.title }}
API Logs
API Reference
{{search.symbol}}K
discard
Save Edits
Submit
Suggested Edits
Only admins can see this
Enable it for everyone
Introduction
Welcome (V2.3)
Choose Version
Unstable
V2.3
V2.2
V2.1
V2.0
V1.4
V1.3
V1.2
V1.1
V1.0 - Base
Common Structures
Object Model
Encoding
Identifiers and URLs
Use of HTTP
Compatibility
Pagination
Pagination (Cursor)
Pagination & Sorting (Search)
Users
Users
Leads
Leads
Contacts
The contact model
Create a contact
Retrieve a contact
Update a contact
Delete a contact
Archive a contact
Unarchive a contact
Merge two contacts
Search for contacts
List all contacts
List attached companies
List attached tags
List attached segments
Visitors
The visitor model
Retrieve a visitor
Update a visitor
Delete a visitor
Convert a visitor
Companies
The company model
Create or update a company
Retrieve a company
Delete a company
List all companies
Scroll over all companies
Attach a contact
Detach a contact
List attached contacts
List attached segments
Data Attributes
The data attribute model
Create a data attribute
Update a data attribute
List all data attributes
Data Events
The data event model
Submit a data event
List all data events
Tags
The tag model
Create or update a tag
Delete a tag
Attach a contact
Attach a conversation
Tag companies
Detach a contact
Detach a conversation
Untag companies
List all tags
Notes
The note model
Create a note
Retrieve a note
List all notes
Segments
The segment model
Retrieve a segment
List all segments
Conversations
The conversation model
Create a conversation
Retrieve a conversation
Update a conversation
Reply to a conversation
Assign a conversation
Snooze a conversation
Close a conversation
Open a conversation
Attach a contact
Detach a contact
Search for conversations
List all conversations
Redact a conversation part
Messages
The message model
Create a message
List all messages
Exports - Message Data
The export job model
Creating an export job
Retrieve a job status
Retrieve the exported data
Admins
The admin model
Retrieve an admin
Set an admin to away
Identify an admin
List all activity logs
List all admins
Teams
The team model
Retrieve a team
List all teams
Counts
App Total Count Model
Conversation Count Model
Admin Conversations Count Model
User Segment/Tag Count Model
Company User/Segment/Tag Count Model
Articles
The article model
Create an article
Retrieve an article
Update an article
Delete an article
List all articles
Help Center
The collection & section models
Create a collection
Retrieve a collection
Update a collection
Delete a collection
List all collections
Create a section
Retrieve a section
Update a section
Delete a section
List all sections
Webhooks
Webhooks and Notifications
Errors
Error Objects
Error Codes
HTTP Responses
Rate Limiting