GET/teams/{team_id}

Get a team

Retrieves a team and the admins that belong to it. Use the team_id path parameter to specify the team whose details you need.

2 parameters
team_idstringrequired
The unique identifier of the team to retrieve.
Intercom-Versionstringoptional
The Intercom API version to use. Defaults to 2.17 when omitted.
Allowed:1.01.11.21.31.42.02.12.22.32.42.52.6Default:2.17

3 status codes
200Returns a team object with its identifier, name, admin IDs, assignment settings, and distribution method.
typestringoptional
Value is always "team"
idstringoptional
The id of the team
namestringoptional
The name of the team
admin_idsarray<integer>optional
The list of admin IDs that are a part of the team.
admin_priority_levelobjectoptional
Admin priority levels for the team
assignment_limitintegeroptional
The assignment limit for the team. This field is only present when the team's distribution type is load balanced.
distribution_methodstringoptional
Describes how assignments are distributed among the team members
401Returned when the request is unauthorized.

One documented failure

  • unauthorized

    Access Token Invalid

typestringrequired
The type is error.list
request_idstringoptional
errorsarray<object>required
An array of one or more error objects
404Returned when no team exists with the given identifier.

One documented failure

  • team_not_found

    Team not found

typestringrequired
The type is error.list
request_idstringoptional
errorsarray<object>required
An array of one or more error objects

Error handling

A 401 is returned when the request is unauthorized. A 404 is returned when no team exists with the given team_id path parameter. The Intercom-Version header selects the API version and defaults to 2.17 when omitted.