Get all teams
GET {{baseUrl}}/api/v2/team
Get all teams.
Can be used to search for teams using the filter[keyword] and filter[me] query parameters.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
page[number] | number | Specific page number to return. | |
page[size] | number | Size for a given page. The maximum allowed value is 100. | |
sort | string | Specifies the order of the returned teams | |
include | string | Included related resources optionally requested. Allowed enum values: team_links, user_team_permissions | |
include | string | Included related resources optionally requested. Allowed enum values: team_links, user_team_permissions | |
filter[keyword] | string | Search query. Can be team name, team handle, or email of team member | |
filter[me] | boolean | When true, only returns teams the current user belongs to | |
fields[team] | string | List of fields that need to be fetched. |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"data":[{"attributes":{"handle":"example-team","name":"Example Team","avatar":"🥑","banner":-26452719,"created_at":"1984-04-10T06:40:07.216Z","description":"amet laboris Lorem","hidden_modules":["reprehenderit sint ipsum consequat","proident Lorem"],"link_count":1173799117,"modified_at":"1998-08-01T22:42:17.421Z","summary":"irure mollit in ullamco","user_count":1307006134,"visible_modules":["et tempor do quis","ullamco"]},"id":"aeadc05e-98a8-11ec-ac2c-da7ad0900001","type":"team","relationships":{"team_links":{"data":[{"id":"f9bb8444-af7f-11ec-ac2c-da7ad0900001","type":"team_links"},{"id":"f9bb8444-af7f-11ec-ac2c-da7ad0900001","type":"team_links"}],"links":{"related":"/api/v2/team/c75a4a8e-20c7-11ee-a3a5-da7ad0900002/links"}},"user_team_permissions":{"data":{"id":"UserTeamPermissions-aeadc05e-98a8-11ec-ac2c-da7ad0900001-416595","type":"user_team_permissions"},"links":{"related":"/api/v2/team/c75a4a8e-20c7-11ee-a3a5-da7ad0900002/links"}}}},{"attributes":{"handle":"example-team","name":"Example Team","avatar":"🥑","banner":54292428,"created_at":"1974-08-19T22:38:08.357Z","description":"eiusmod Lore","hidden_modules":["nulla pariatur","anim commodo i"],"link_count":1589753318,"modified_at":"1993-02-06T03:25:52.679Z","summary":"ad dolor Duis","user_count":1921112546,"visible_modules":["in nisi aute","officia qui est"]},"id":"aeadc05e-98a8-11ec-ac2c-da7ad0900001","type":"team","relationships":{"team_links":{"data":[{"id":"f9bb8444-af7f-11ec-ac2c-da7ad0900001","type":"team_links"},{"id":"f9bb8444-af7f-11ec-ac2c-da7ad0900001","type":"team_links"}],"links":{"related":"/api/v2/team/c75a4a8e-20c7-11ee-a3a5-da7ad0900002/links"}},"user_team_permissions":{"data":{"id":"UserTeamPermissions-aeadc05e-98a8-11ec-ac2c-da7ad0900001-416595","type":"user_team_permissions"},"links":{"related":"/api/v2/team/c75a4a8e-20c7-11ee-a3a5-da7ad0900002/links"}}}}],"included":[{"attributes":{"created_at":"1975-08-01T23:53:43.357Z","disabled":true,"email":"amet do sint in","handle":"esse laborum id minim","icon":"consequat mollit","modified_at":"1998-08-10T03:42:37.797Z","name":"officia aliquip commodo aliqua","service_account":false,"status":"occaecat eu non","title":"id","verified":false},"id":"laborum eiusm","relationships":{"org":{"data":{"id":"00000000-0000-beef-0000-000000000000","type":"orgs"}},"other_orgs":{"data":[]},"other_users":{"data":[]},"roles":{"data":[{"id":"3653d3c6-0c75-11ea-ad28-fb5701eabc7d","type":"roles"},{"id":"3653d3c6-0c75-11ea-ad28-fb5701eabc7d","type":"roles"}]}},"type":"users"},{"attributes":{"created_at":"1973-11-02T06:26:02.982Z","disabled":false,"email":"nostrud offi","handle":"fugiat dolor ex mollit","icon":"minim irure adipisicing nostrud","modified_at":"2022-02-18T12:01:57.414Z","name":"ad pariatur veniam ullamco laboris","service_account":false,"status":"deserunt eu off","title":"dolore ad","verified":false},"id":"commodo adipisicing labore","relationships":{"org":{"data":{"id":"00000000-0000-beef-0000-000000000000","type":"orgs"}},"other_orgs":{"data":[]},"other_users":{"data":[]},"roles":{"data":[{"id":"3653d3c6-0c75-11ea-ad28-fb5701eabc7d","type":"roles"},{"id":"3653d3c6-0c75-11ea-ad28-fb5701eabc7d","type":"roles"}]}},"type":"users"}],"links":{"first":"commodo elit nostrud","last":"elit Duis exercitation","next":"aliquip dolore elit reprehenderit","prev":"magna dolore ullamc","self":"Duis"},"meta":{"pagination":{"first_offset":-50540452,"last_offset":-27508711,"limit":-86404252,"next_offset":-56761729,"offset":-64815889,"prev_offset":-72739078,"total":-12840076,"type":"fugiat magna dolor est aliqua"}}}