teams

Returns teams in the workspace.

Changed on

Returns teams in the workspace. The result follows the workspace's team visibility restrictions. <Check title="Required Permissions" icon="key">When team restrictions are applied for the workspace, the user must either be an admin or member of the team to retrieve it.</Check>

get/teams

Request

  • Base URL: https://api.awork.com/api/v1
  • URL: https://api.awork.com/api/v1/teams
  • Auth: HTTP bearer

Query parameters

includeUserIdsboolean

Whether to include the ids of users that are in the team.

includeProjectIdsboolean

Whether to include the ids of projects that are assigned to the team.

pageinteger

Page number for pagination

pageSizeinteger

Number of items per page

orderbystring

The properties to order by

filterbystring

The filter expression to filter by

Response

OK

namestring required

The team name.

iconstring nullable

The icon of the team. Optional. Possible values: 'attach_money', 'poll', 'golf_course', 'all_inclusive', 'portrait', 'timeline', 'transform', 'description', 'folder', 'computer', 'web', 'phone_iphone', 'cloud', 'local_movies', 'shopping_cart', 'brush', 'image', 'camera_alt', 'movie_creation', 'public', 'whatshot', 'extension', 'explore', 'lock', 'settings', 'stars', 'store', 'school', 'local_bar', 'question_answer', 'favorite', 'work', 'flight_takeoff', 'map', 'local_dining'.

colorstring nullable

The color of the team. Optional. Possible values: 'red', 'coral', 'yellow', 'green', 'teal', 'arctic', 'blue', 'azure', 'purple', 'violet'.

idstring uuid

The id of the team.

createdOnstring date-time

The date this team was created.

createdBystring uuid nullable

The id of the user who created this team.

updatedOnstring date-time

The date this team was last modified.

updatedBystring uuid nullable

The id of the user who last updated this team.

userIdsstring[] nullable

The ids of the users in the team.

projectIdsstring[] nullable

The ids of the projects in the team.

Changes