Teams

List all teams

GET/v2/teams

Get team by ID

GET/v2/teams/{id}

Get team workload metrics

GET/v2/teams/{id}/metrics

ModelsExpand Collapse

Team object { id, color, icon, 3 more }

id: string

Unique identifier

color: string

Team color in hex format

icon: object { type, value }

Team icon

type: "emoji" or "predefined" or "external"

Type of icon

One of the following:

"emoji"

"predefined"

"external"

value: string

Icon value

members: array of string

Array of admin IDs who are members of this team

name: string

Team name

object: "team"

Object type identifier

TeamListResponse object { data, object }

data: array of Team { id, color, icon, 3 more }

Array of teams

id: string

Unique identifier

color: string

Team color in hex format

icon: object { type, value }

Team icon

type: "emoji" or "predefined" or "external"

Type of icon

One of the following:

"emoji"

"predefined"

"external"

value: string

Icon value

members: array of string

Array of admin IDs who are members of this team

name: string

Team name

object: "team"

Object type identifier

object: "list"

Object type identifier

TeamRetrieveMetricsResponse object { data, generatedAt, nextCursor, 2 more }

data: array of object { adminId, assignmentLimit, atCapacity, 7 more }

adminId: string

assignmentLimit: number

atCapacity: boolean

away: boolean

idleCount: number

minimum0

object: "team_admin_metrics"

openCount: number

minimum0

paused: boolean

snoozedCount: number

minimum0

waitingCount: number

minimum0

generatedAt: string

formatdate-time

nextCursor: string

object: "team_metrics"

teamId: string