Required scope: teams:read

Teams are the most efficient way to manage groups of users in Teams are comprised of one or multiple users, and every user can be a part of multiple teams (or none).

You can use teams at the root of your query or nest them within another query. Querying teams returns one or several teams.

You can learn more about teams here.

query {
    teams {
        users {
let query = "query { teams { name picture_url users { created_at phone } } }";

fetch ("", {
  method: 'post',
  headers: {
    'Content-Type': 'application/json',
    'Authorization' : 'YOUR_API_KEY_HERE'
   body: JSON.stringify({
     query : query
   .then(res => res.json())
   .then(res => console.log(JSON.stringify(res, null, 2)));
curl --location --request POST '' \
--header 'Authorization: YourSuperSecretApiKey' \
--header 'Content-Type: application/json' \
--header 'Cookie: __cfduid=d4512e647bd3dd90706f5673d6041f7c51618840981' \
--data-raw '{"query": "query { teams { name picture_url users { created_at phone } } }"}'


The following teams() argument can reduce the number of teams returned.



ids [Int]

A list of teams' identifiers.


Fields are used to return specific properties in an object. The following fields will determine what information is returned from your teams() query. Some fields will have their own arguments.


Field Description


id !Int

The team's identifier.

name !String

The team's name.

picture_url String

The team's picture url.

users [User]

The users in the team.

ids [Int]
kind UserKind
newest_first Boolean
limit Int


Do you have questions?

Join our developer community! You can share your questions and learn from fellow users and product experts.

Don’t forget to search before opening a new topic!

Did this page help you?