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 '
{
  "teams": "*",
  "with_ancestors": true,
  "with_disabled": true,
  "exclude_instance": true
}
'
[
  {
    "id": "872815618512410358",
    "parent_id": "872815618512410358",
    "name": {
      "en": "Hello",
      "fr": "Bonjour",
      "de": "Guten Tag"
    },
    "short_name": "<string>",
    "color": "<string>"
  }
]

Body

application/json
​
teams
Available options:
*
Example:

"*"

​
with_ancestors
boolean | null
​
with_disabled
boolean | null
​
exclude_instance
boolean | null

Response

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

"872815618512410358"

​
parent_id
string<snowflake>
required
Example:

"872815618512410358"

​
name
object
required
Example:
{
  "en": "Hello",
  "fr": "Bonjour",
  "de": "Guten Tag"
}
​
short_name
string | null
required
​
color
string | null
required