A Team represents a group of users. Teams are used with the "auto-assign tickets" feature: you can assign a ticket to a team (manually of via rules), then it will be automatically assigned to someone who is available in the given team.

Team properties

integer

ID of the team.

uri

string

URI of the object (auto-generated)

name

string

Name of the team.

description

string | null

Longer description of the team.

default_email_integration_id

integer | null

Configured default email integration ID for the team. Null means no team preference. Non-null values in create/update requests must reference an active email integration on the same account that can send email; otherwise the request returns HTTP 400. Responses retain the configured ID even if the integration becomes unavailable.

decoration

object | null

Object describing how the team appears on the webpage. Currently only supports emoji field that shows before the team's name.

members

array

The list of users within the team.

created_datetime

ISO 8601 datetime

When the team was created.

Team example object

{
  "id": 123,
  "name": "Warehouse team"
}