Home
/
REST API Reference
/
Teams
/
Team

Intercom API (Unstable)

The intercom API reference.

Download OpenAPI description
api.intercom.io.json
api.intercom.io.yaml
Overview
URL https://developers.intercom.com
License MIT
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/

Admins

Everything about your Admins

Operations

AI Content

With the AI Content APIs, you can create and manage External Pages and Content Import Sources for your Fin Content Library.

 

External Pages are pages that you want Fin to be able to answer questions about. The API for External Pages is a great way to ingest into your Fin Content Library pages that are not publicly accessible and hence can't be crawled by Intercom.

 

Content Import Sources are the sources of those pages, and they are used to determine the default audience for the pages (configured via the UI). You should create a Content Import Source for each source of External Pages that you want to ingest into your Fin Content Library.

 

You can then iterate through the content from that source via its API and POST it to the External Pages endpoint. That endpoint has an external_id parameter which allows you to specify the identifier from the source. The endpoint will then either create a new External Page or update an existing one as appropriate.",

Operations

Articles

Everything about your Articles

Operations

Companies

Everything about your Companies

Operations

Contacts

Everything about your contacts

Operations

Conversations

Everything about your Conversations

Operations

Custom Object Instances

Everything about your Custom Object instances.

Operations

Data Attributes

Everything about your Data Attributes

Operations

Data Events

Everything about your Data Events

Operations

Data Export

Everything about your Data Exports

Operations

Help Center

Everything about your Help Center

Operations

Messages

Everything about your messages

Operations

News

Everything about your News

Operations

Notes

Everything about your Notes

Operations

Segments

Everything about your Segments

Operations

Subscription Types

Everything about subscription types

Operations

Switch

Everything about Switch

Operations

Tags

Everything about tags

Operations

Teams

Everything about your Teams

Operations

Team

Teams are groups of admins in Intercom.

typestring

Value is always "team"

Example: "team"
idstring

The id of the team

Example: "814865"
namestring

The name of the team

Example: "Example Team"
admin_idsArray of integers

The list of admin IDs that are a part of the team.

Example: [493881]
admin_priority_levelobject or null(Admin Priority Level)

Admin priority levels for the team

{
  "type": "team",
  "id": "814865",
  "name": "Example Team",
  "admin_ids": [
    493881
  ],
  "admin_priority_level": {
    "primary_admin_ids": [ … ],
    "secondary_admin_ids": [ … ]
  }
}

List all teams

Request

This will return a list of team objects for the App.

Headers
Intercom-Versionstring(intercom_version)

Intercom API version.
By default, it's equal to the version set in the app package.

Default Unstable
Enum"1.0""1.1""1.2""1.3""1.4""2.0""2.1""2.2""2.3""2.4"
Example: Unstable
curl -i -X GET \
  https://api.intercom.io/teams \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Intercom-Version: Unstable'

Responses

successful

Bodyapplication/json
typestring

The type of the object

Value"team.list"
Example: "team.list"
teamsArray of objects(Team)

A list of team objects

Response
application/json
{
  "type": "team.list",
  "teams": []
}

Retrieve a team

Request

You can fetch the details of a single team, containing an array of admins that belong to this team.

Path
idstringrequired

The unique identifier of a given team.

Example: 123
Headers
Intercom-Versionstring(intercom_version)

Intercom API version.
By default, it's equal to the version set in the app package.

Default Unstable
Enum"1.0""1.1""1.2""1.3""1.4""2.0""2.1""2.2""2.3""2.4"
Example: Unstable
curl -i -X GET \
  'https://api.intercom.io/teams/{id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Intercom-Version: Unstable'

Responses

successful

Bodyapplication/json
typestring

Value is always "team"

Example: "team"
idstring

The id of the team

Example: "814865"
namestring

The name of the team

Example: "Example Team"
admin_idsArray of integers

The list of admin IDs that are a part of the team.

Example: [493881]
admin_priority_levelobject or null(Admin Priority Level)

Admin priority levels for the team

Response
application/json
{
  "type": "team",
  "id": "991267265",
  "name": "team 1",
  "admin_ids": []
}

Ticket States

Everything about your ticket states

Operations

Ticket Type Attributes

Everything about your ticket type attributes

Operations

Ticket Types

Everything about your ticket types

Operations

Tickets

Everything about your tickets

Operations

Visitors

Everything about your Visitors

Operations

Models