API & Webhooks Reference

      • Building Apps
      • Installing Intercom
      • API & Webhooks Reference
      • Canvas Kit Reference
      HomeDocsRecipesAPI ReferenceReferenceLatest updatesDiscussionsPage Not FoundSearch{{ state.current().meta.title }}API Logs
        API Reference
      discard
      Only admins can see thisEnable it for everyone

      Introduction

      • Welcome (V1.0)

      Choose Version

      • Unstable
      • V2.3
      • V2.2
      • V2.1
      • V2.0
      • V1.4
      • V1.3
      • V1.2
      • V1.1
      • V1.0 - Base

      Users

      • Users
      • User Model
      • Create or Update User
      • View a User
      • Updating the 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

      Admins

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

      Teams

      • Teams
      • Teams Model
      • List Teams
      • View a Team

      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

      Data Events

      • Data 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
      • List Conversations
      • Replying to a Conversation
      • Replying to Users Last Conversation
      • Assigning a Conversation to Unassigned
      • Run assignment rules on a conversation
      • 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
      • Closing a conversation

      Webhooks

      • Subscription Model
      • Handling Notifications
      • Notification Model
      • Topics
      • Create a Subscriptions
      • View a Subscription
      • Update a Subscription
      • Delete a Subscription
      • List Subscriptions
      • 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
      About intercom Twitter Developer blog