Skip to main content
POST
/
api
/
directory
/
teams.list
List teams
curl --request POST \
  --url https://api.example.com/api/directory/teams.list \
  --header 'Content-Type: application/json' \
  --data '
{
  "team_ids": [
    "872815618512410358"
  ],
  "with_ancestors": true,
  "with_disabled": true,
  "exclude_instance": true
}
'
[
  {
    "id": "872815618512410358",
    "parent_id": "872815618512410358",
    "name": "<string>",
    "short_name": "<string>",
    "color": "<string>"
  }
]

Body

application/json
team_ids
string<snowflake>[]
with_ancestors
boolean
with_disabled
boolean
exclude_instance
boolean

Response

200 - application/json
id
string<snowflake>
required
Example:

"872815618512410358"

parent_id
string<snowflake> | null
required
Example:

"872815618512410358"

name
string
required
short_name
string | null
required
color
string | null
required