Get all teams
GET {{baseUrl}}/api/v2/team?page[number]=0&page[size]=10&sort=user_count&include=user_team_permissions&include=team_links&filter[keyword]=<string>&filter[me]=<boolean>
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] | string | When true, only returns teams the current user belongs to |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"data":[{"attributes":{"handle":"\u003cstring\u003e","name":"\u003cstring\u003e","avatar":"\u003cstring\u003e","banner":"\u003clong\u003e","created_at":"\u003cdateTime\u003e","description":"\u003cstring\u003e","hidden_modules":["\u003cstring\u003e","\u003cstring\u003e"],"link_count":"\u003cinteger\u003e","modified_at":"\u003cdateTime\u003e","summary":"\u003cstring\u003e","user_count":"\u003cinteger\u003e","visible_modules":["\u003cstring\u003e","\u003cstring\u003e"]},"id":"\u003cstring\u003e","type":"team","relationships":{"team_links":{"data":[{"id":"\u003cstring\u003e","type":"team_links"},{"id":"\u003cstring\u003e","type":"team_links"}],"links":{"related":"\u003cstring\u003e"}},"user_team_permissions":{"data":{"id":"\u003cstring\u003e","type":"user_team_permissions"},"links":{"related":"\u003cstring\u003e"}}}},{"attributes":{"handle":"\u003cstring\u003e","name":"\u003cstring\u003e","avatar":"\u003cstring\u003e","banner":"\u003clong\u003e","created_at":"\u003cdateTime\u003e","description":"\u003cstring\u003e","hidden_modules":["\u003cstring\u003e","\u003cstring\u003e"],"link_count":"\u003cinteger\u003e","modified_at":"\u003cdateTime\u003e","summary":"\u003cstring\u003e","user_count":"\u003cinteger\u003e","visible_modules":["\u003cstring\u003e","\u003cstring\u003e"]},"id":"\u003cstring\u003e","type":"team","relationships":{"team_links":{"data":[{"id":"\u003cstring\u003e","type":"team_links"},{"id":"\u003cstring\u003e","type":"team_links"}],"links":{"related":"\u003cstring\u003e"}},"user_team_permissions":{"data":{"id":"\u003cstring\u003e","type":"user_team_permissions"},"links":{"related":"\u003cstring\u003e"}}}}],"included":[{"attributes":{"created_at":"\u003cdateTime\u003e","disabled":"\u003cboolean\u003e","email":"\u003cstring\u003e","handle":"\u003cstring\u003e","icon":"\u003cstring\u003e","modified_at":"\u003cdateTime\u003e","name":"\u003cstring\u003e","service_account":"\u003cboolean\u003e","status":"\u003cstring\u003e","title":"\u003cstring\u003e","verified":"\u003cboolean\u003e"},"id":"\u003cstring\u003e","relationships":{"org":{"data":{"id":"\u003cstring\u003e","type":"orgs"}},"other_orgs":{"data":[{"id":"\u003cstring\u003e","type":"orgs"},{"id":"\u003cstring\u003e","type":"orgs"}]},"other_users":{"data":[{"id":"\u003cstring\u003e","type":"users"},{"id":"\u003cstring\u003e","type":"users"}]},"roles":{"data":[{"id":"\u003cstring\u003e","type":"roles"},{"id":"\u003cstring\u003e","type":"roles"}]}},"type":"users"},{"attributes":{"created_at":"\u003cdateTime\u003e","disabled":"\u003cboolean\u003e","email":"\u003cstring\u003e","handle":"\u003cstring\u003e","icon":"\u003cstring\u003e","modified_at":"\u003cdateTime\u003e","name":"\u003cstring\u003e","service_account":"\u003cboolean\u003e","status":"\u003cstring\u003e","title":"\u003cstring\u003e","verified":"\u003cboolean\u003e"},"id":"\u003cstring\u003e","relationships":{"org":{"data":{"id":"\u003cstring\u003e","type":"orgs"}},"other_orgs":{"data":[{"id":"\u003cstring\u003e","type":"orgs"},{"id":"\u003cstring\u003e","type":"orgs"}]},"other_users":{"data":[{"id":"\u003cstring\u003e","type":"users"},{"id":"\u003cstring\u003e","type":"users"}]},"roles":{"data":[{"id":"\u003cstring\u003e","type":"roles"},{"id":"\u003cstring\u003e","type":"roles"}]}},"type":"users"}],"links":{"first":"\u003cstring\u003e","last":"\u003cstring\u003e","next":"\u003cstring\u003e","prev":"\u003cstring\u003e","self":"\u003cstring\u003e"},"meta":{"pagination":{"first_offset":"\u003clong\u003e","last_offset":"\u003clong\u003e","limit":"\u003clong\u003e","next_offset":"\u003clong\u003e","offset":"\u003clong\u003e","prev_offset":"\u003clong\u003e","total":"\u003clong\u003e","type":"\u003cstring\u003e"}}}