API v1 ReferenceTeams

Returns the team with the specified id.

<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>

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

teamIdstringRequiredformat: "uuid"
The id of the team.

Query parameters

includeUserIdsbooleanOptionalDefaults to false
Whether to include the ids of users that are in the team.
includeProjectIdsbooleanOptionalDefaults to false
Whether to include the ids of projects that are assigned to the team.

Response

OK
namestring0-255 characters
The team name.
iconstring or null0-25 characters
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 or null0-14 characters

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

idstring or nullformat: "uuid"
The id of the team.
createdOndatetime or null
The date this team was created.
createdBystring or nullformat: "uuid"
The id of the user who created this team.
updatedOndatetime or null
The date this team was last modified.
updatedBystring or nullformat: "uuid"
The id of the user who last updated this team.
userIdslist of strings or null
The ids of the users in the team.
projectIdslist of strings or null
The ids of the projects in the team.

Errors