Jump to Content

Home Guides and tutorials API reference

Developer blog Guides and tutorials API reference Dashboard

API reference

Developer blog Guides and tutorials API reference Dashboard

Introduction

Welcome
SDKs & Client Libraries
API Summary

Authorization

Access Tokens
Using Access Tokens
OAuth
Using OAuth

Users

Users
User Model
Create or Update User
View a User
Updating the Users Last Seen Time
Incrementing User Sessions
Companies and Users
List Users
List by Tag, Segment, Company
Scroll over all users
Archive a user
Permanently delete a user

Data Attributes

Data Attributes
Data Attribute Model
List Customer Data Attributes
List Company Data Attributes

Leads

Leads
Leads Object
Create Lead
View a Lead
Update Lead
List Leads
List by Email
Delete a Lead
Convert a Lead
Scroll over all leads

Visitors

Visitors
Visitor Object
View a Visitor
Update a Visitor
Delete a visitor
Convert a Visitor to a Lead
Convert a Visitor to a User

Companies

Companies
Company Model
Create or Update Company
View a Company
List Companies
List by Tag or Segment
Delete a Company
List Company Users
Scroll over all companies
Updating the Companies Last Seen Time

Admins

Admins
Admin Model
List Admins
Viewing the current admin and app
View an Admin
Set admin away mode

Tags

Tags
Tag Model
Create and Update Tags
Tag or Untag Users, Companies & Leads (Contacts)
Delete a Tag
List Tags for an App

Segments

Segments
Segment Model
List Segments
View a Segment

Notes

Notes
Note Model
Create a Note
List Notes for a User
View a Note

Events

Events
Submitting Events
Event Model
Event de-duplication
Event Metadata Types
List Events
View User Event Summaries

Counts

Counts
App Total Count Model
Conversation Count Model
Admin Conversations Count Model
User Segment/Tag Count Model
Company User/Segment/Tag Count Model

Conversations

Conversations
Conversation Model
Conversation Rating Model
Conversation Part Model
Admin Initiated Conversation
User or Lead Initiated Conversation
Get a Single Conversation
Replying to a Conversation
Replying to Users Last Conversation
Assigning a Conversation to Unassigned
Marking a Conversation as Read
Adding to group conversations as admin
Adding to group conversations as customer
Deleting from group conversations
Snoozing a conversation
Unsnoozing a conversation
List Conversations
Closing a conversation

Webhooks

Webhooks and Notifications
Subscription Model
Handling Notifications
Notification Model
Topics
Create a Subscriptions
View a Subscription
Update a Subscription
Delete a Subscription
List Subscriptions
Subscription Feeds
Subscription Ping
Event Webhooks
Signed Notifications
Webhook Models

Errors

Error Objects
Error Codes
HTTP Responses
Rate Limiting

Common Structures

Object Model
Encoding
Identifiers and URLs
Pagination
Use of HTTP
Compatibility

Introduction

Welcome
SDKs & Client Libraries
API Summary

Authorization

Access Tokens
Using Access Tokens
OAuth
Using OAuth

Users

Users
User Model
Create or Update User
View a User
Updating the Users Last Seen Time
Incrementing User Sessions
Companies and Users
List Users
List by Tag, Segment, Company
Scroll over all users
Archive a user
Permanently delete a user

Data Attributes

Data Attributes
Data Attribute Model
List Customer Data Attributes
List Company Data Attributes

Leads

Leads
Leads Object
Create Lead
View a Lead
Update Lead
List Leads
List by Email
Delete a Lead
Convert a Lead
Scroll over all leads

Visitors

Visitors
Visitor Object
View a Visitor
Update a Visitor
Delete a visitor
Convert a Visitor to a Lead
Convert a Visitor to a User

Companies

Companies
Company Model
Create or Update Company
View a Company
List Companies
List by Tag or Segment
Delete a Company
List Company Users
Scroll over all companies
Updating the Companies Last Seen Time

Admins

Admins
Admin Model
List Admins
Viewing the current admin and app
View an Admin
Set admin away mode

Tags

Tags
Tag Model
Create and Update Tags
Tag or Untag Users, Companies & Leads (Contacts)
Delete a Tag
List Tags for an App

Segments

Segments
Segment Model
List Segments
View a Segment

Notes

Notes
Note Model
Create a Note
List Notes for a User
View a Note

Events

Events
Submitting Events
Event Model
Event de-duplication
Event Metadata Types
List Events
View User Event Summaries

Counts

Counts
App Total Count Model
Conversation Count Model
Admin Conversations Count Model
User Segment/Tag Count Model
Company User/Segment/Tag Count Model

Conversations

Conversations
Conversation Model
Conversation Rating Model
Conversation Part Model
Admin Initiated Conversation
User or Lead Initiated Conversation
Get a Single Conversation
Replying to a Conversation
Replying to Users Last Conversation
Assigning a Conversation to Unassigned
Marking a Conversation as Read
Adding to group conversations as admin
Adding to group conversations as customer
Deleting from group conversations
Snoozing a conversation
Unsnoozing a conversation
List Conversations
Closing a conversation

Webhooks

Webhooks and Notifications
Subscription Model
Handling Notifications
Notification Model
Topics
Create a Subscriptions
View a Subscription
Update a Subscription
Delete a Subscription
List Subscriptions
Subscription Feeds
Subscription Ping
Event Webhooks
Signed Notifications
Webhook Models

Errors

Error Objects
Error Codes
HTTP Responses
Rate Limiting

Common Structures

Object Model
Encoding
Identifiers and URLs
Pagination
Use of HTTP
Compatibility

Notes

Notes allow you to annotate and comment on your users.

A note can be authored by an admin about a user, and the notes associated with a user can be listed.

About intercom Twitter Developer blog