Skip to content
Home
/
REST API Reference
/
Teams

Intercom API (2.11)

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

Articles

Everything about your Articles

Operations

Companies

Everything about your Companies

Operations

Contacts

Everything about your contacts

Operations

Conversations

Everything about your Conversations

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.

typestringrequired

Value is always "team"

Value"team"
Example: "team"
idstringrequired

The id of the team

Example: "814865"
namestringrequired

The name of the team

Example: "Example Team"
admin_idsArray of integersrequired

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

Example: [493881]
admin_priority_levelobject(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.

Security
bearerAuth
Headers
Intercom-Versionstring(intercom_version)

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

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

Responses

successful

Bodyapplication/json
typestringrequired

The type of the object

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

A list of team objects

teams[].​typestringrequired

Value is always "team"

Value"team"
Example: "team"
teams[].​idstringrequired

The id of the team

Example: "814865"
teams[].​namestringrequired

The name of the team

Example: "Example Team"
teams[].​admin_idsArray of integersrequired

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

Example: [493881]
teams[].​admin_priority_levelobject(Admin Priority Level)

Admin priority levels for the team

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.

Security
bearerAuth
Path
team_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 2.11
Enum"1.0""1.1""1.2""1.3""1.4""2.0""2.1""2.2""2.3""2.4"
Example: 2.11
curl -i -X GET \
  https://api.intercom.io/teams/123 \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Intercom-Version: 2.11'

Responses

successful

Bodyapplication/json
typestringrequired

Value is always "team"

Value"team"
Example: "team"
idstringrequired

The id of the team

Example: "814865"
namestringrequired

The name of the team

Example: "Example Team"
admin_idsArray of integersrequired

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

Example: [493881]
admin_priority_levelobject(Admin Priority Level)

Admin priority levels for the team

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

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