REST API Reference

Team List

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

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

Teams

Everything about your Teams

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

Tags

A list of tags objects associated with a conversation

typestringrequired

The type of the object

Value"tag.list"

Example: "tag.list"

tagsArray of objects(Tag)required

A list of tags objects associated with the conversation.

tags[].typestringrequired

value is "tag"

Example: "tag"

tags[].idstringrequired

The id of the tag

Example: "123456"

tags[].namestringrequired

The name of the tag

Example: "Test tag"

tags[].applied_atinteger(date-time)required

The time when the tag was applied to the object

Example: 1663597223

tags[].applied_byobject(Reference)required

reference to another object

tags[].applied_by.typestringrequired

Example: "contact"

tags[].applied_by.idstring or null

Example: "1a2b3c"

{
  "type": "tag.list",
  "tags": [
    { … }
  ]
}

Team List

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

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

{
  "type": "team.list",
  "teams": [
    { … }
  ]
}

Team Priority Level

Admin priority levels for teams

primary_team_idsArray of integers or null

The primary team ids for the team

Example: [814865]

secondary_team_idsArray of integers or null

The secondary team ids for the team

Example: [493881]

{
  "primary_team_ids": [
    814865
  ],
  "secondary_team_ids": [
    493881
  ]
}