Skip to content

Asana: Teams schemas

11 Asana schemas with complete fields and constraints.

← Teams operations · All schemas

Add a user to a team — request body — body data

FieldTypePresenceDescription and constraints
$objectRootA user identification object for specification with the addUser/removeUser endpoints.
userstringOptionalA string identifying a user. This can either be the string "me", an email, or the gid of a user.

Add a user to a team — response body — data

FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand Add a user to a team — response body — data data — sdk__Team Membership Response

Referenced models: Add a user to a team — response body — data data — sdk__Team Membership Response

Add a user to a team — response body — data data team — Team Compact

FieldTypePresenceDescription and constraints
$objectRoot<p><strong style={{ color: "#4573D2" }}>Full object requires scope: </strong><code>teams:read</code></p>

A *team* is used to group related projects and people together within an organization. Each project in an organization is associated with a team.
gidstringOptionalGlobally unique identifier of the resource, as a string.
Read only: true
resource_typestringOptionalThe base type of this resource.
Read only: true
namestringOptionalThe name of the team.

Add a user to a team — response body — data data team — shared_team_674c225d7cda

FieldTypePresenceDescription and constraints
$objectRootA generic Asana Resource, containing a globally unique identifier.A generic Asana Resource, containing a globally unique identifier.
A *team* is used to group related projects and people together within an organization. Each project in an organization is associated with a team.
gidstringOptionalGlobally unique identifier of the resource, as a string.
Read only: true
resource_typestringOptionalThe base type of this resource.
Read only: true
namestringOptionalThe name of the team.

Add a user to a team — response body — data data — Team Membership Compact

FieldTypePresenceDescription and constraints
$objectRootThis object represents a user's connection to a team.
gidstringOptionalGlobally unique identifier of the resource, as a string.
Read only: true
resource_typestringOptionalThe base type of this resource.
Read only: true
userModelOptionalExpand Get users in a team — response body — data data item
teamModelOptionalExpand Add a user to a team — response body — data data team — Team Compact
is_guestbooleanOptionalDescribes if the user is a guest in the team.
is_limited_accessbooleanOptionalDescribes if the user has limited access to the team.
Read only: true
is_adminbooleanOptionalDescribes if the user is a team admin.

Referenced models: Add a user to a team — response body — data data team — Team Compact, Get users in a team — response body — data data item

Add a user to a team — response body — data data — sdk__Team Membership Response

FieldTypePresenceDescription and constraints
$objectRootA generic Asana Resource, containing a globally unique identifier.A generic Asana Resource, containing a globally unique identifier.
This object represents a user's connection to a team.
gidstringOptionalGlobally unique identifier of the resource, as a string.
Read only: true
resource_typestringOptionalThe base type of this resource.
Read only: true
userModelOptionalExpand Get an OOO entry — response body — data data user
teamModelOptionalExpand Add a user to a team — response body — data data team — shared_team_674c225d7cda
is_guestbooleanOptionalDescribes if the user is a guest in the team.
is_limited_accessbooleanOptionalDescribes if the user has limited access to the team.
Read only: true
is_adminbooleanOptionalDescribes if the user is a team admin.

Referenced models: Get an OOO entry — response body — data data user, Add a user to a team — response body — data data team — shared_team_674c225d7cda

Get a team — response body — data

FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand Get a team — response body — data data — sdk__Team Response

Referenced models: Get a team — response body — data data — sdk__Team Response

Get a team — response body — data data organization

FieldTypePresenceDescription and constraints
$objectRootA generic Asana Resource, containing a globally unique identifier.A generic Asana Resource, containing a globally unique identifier.
A *workspace* is the highest-level organizational unit in Asana. All projects and tasks have an associated workspace.A generic Asana Resource, containing a globally unique identifier.A generic Asana Resource, containing a globally unique identifier.
A *workspace* is the highest-level organizational unit in Asana. All projects and tasks have an associated workspace.
The organization/workspace the team belongs to.
gidstringOptionalGlobally unique identifier of the resource, as a string.
Read only: true
resource_typestringOptionalThe base type of this resource.
Read only: true
namestringOptionalThe name of the workspace.

Get a team — response body — data data — Team Response

FieldTypePresenceDescription and constraints
$JSONRoot
$ (allOf 1)ModelAll variants applyExpand Add a user to a team — response body — data data team — Team Compact
$ (allOf 2)objectAll variants apply
$ (allOf 2).descriptionstringOptional[Opt In](/docs/inputoutput-options). The description of the team.
$ (allOf 2).html_descriptionstringOptional[Opt In](/docs/inputoutput-options). The description of the team with formatting as HTML. See [rich text](/docs/rich-text#reading-rich-text).
$ (allOf 2).organizationJSONOptional
$ (allOf 2).organization (allOf 1)ModelAll variants applyExpand Update a workspace — request body — body data
$ (allOf 2).organization (allOf 2)objectAll variants applyThe organization/workspace the team belongs to.
$ (allOf 2).permalink_urlstringOptionalA url that points directly to the object within Asana.
Read only: true
$ (allOf 2).visibilitystringOptionalThe visibility of the team to users in the same organization

Known values: secret, request_to_join, public
$ (allOf 2).edit_team_name_or_description_access_levelstringOptionalControls who can edit team name and description

Known values: all_team_members, only_team_admins
$ (allOf 2).edit_team_visibility_or_trash_team_access_levelstringOptionalControls who can edit team visibility and trash teams

Known values: all_team_members, only_team_admins
$ (allOf 2).member_invite_management_access_levelstringOptionalControls who can accept or deny member invites for a given team

Known values: all_team_members, only_team_admins
$ (allOf 2).guest_invite_management_access_levelstringOptionalControls who can accept or deny guest invites for a given team

Known values: all_team_members, only_team_admins
$ (allOf 2).join_request_management_access_levelstringOptionalControls who can accept or deny join team requests for a Membership by Request team. This field can only be updated when the team's `visibility` field is `request_to_join`.

Known values: all_team_members, only_team_admins
$ (allOf 2).team_member_removal_access_levelstringOptionalControls who can remove team members

Known values: all_team_members, only_team_admins
$ (allOf 2).team_content_management_access_levelstringOptionalControls who can create and share content with the team

Known values: no_restriction, only_team_admins
$ (allOf 2).endorsedbooleanOptionalWhether the team has been endorsed
$ (allOf 2).custom_field_settingsarrayOptionalArray of Custom Field Settings applied to the team.
$ (allOf 2).custom_field_settings[]ModelEach itemExpand Add a custom field to a project — response body — data data — Custom Field Setting Response

Referenced models: Add a custom field to a project — response body — data data — Custom Field Setting Response, Add a user to a team — response body — data data team — Team Compact, Update a workspace — request body — body data

Get a team — response body — data data — sdk__Team Response

FieldTypePresenceDescription and constraints
$objectRootA generic Asana Resource, containing a globally unique identifier.A generic Asana Resource, containing a globally unique identifier.
A *team* is used to group related projects and people together within an organization. Each project in an organization is associated with a team.
gidstringOptionalGlobally unique identifier of the resource, as a string.
Read only: true
resource_typestringOptionalThe base type of this resource.
Read only: true
namestringOptionalThe name of the team.
descriptionstringOptional[Opt In](/docs/inputoutput-options). The description of the team.
html_descriptionstringOptional[Opt In](/docs/inputoutput-options). The description of the team with formatting as HTML. See [rich text](/docs/rich-text#reading-rich-text).
organizationModelOptionalExpand Get a team — response body — data data organization
permalink_urlstringOptionalA url that points directly to the object within Asana.
Read only: true
visibilitystringOptionalThe visibility of the team to users in the same organization

Known values: secret, request_to_join, public
edit_team_name_or_description_access_levelstringOptionalControls who can edit team name and description

Known values: all_team_members, only_team_admins
edit_team_visibility_or_trash_team_access_levelstringOptionalControls who can edit team visibility and trash teams

Known values: all_team_members, only_team_admins
member_invite_management_access_levelstringOptionalControls who can accept or deny member invites for a given team

Known values: all_team_members, only_team_admins
guest_invite_management_access_levelstringOptionalControls who can accept or deny guest invites for a given team

Known values: all_team_members, only_team_admins
join_request_management_access_levelstringOptionalControls who can accept or deny join team requests for a Membership by Request team. This field can only be updated when the team's `visibility` field is `request_to_join`.

Known values: all_team_members, only_team_admins
team_member_removal_access_levelstringOptionalControls who can remove team members

Known values: all_team_members, only_team_admins
team_content_management_access_levelstringOptionalControls who can create and share content with the team

Known values: no_restriction, only_team_admins
endorsedbooleanOptionalWhether the team has been endorsed
custom_field_settingsarrayOptionalArray of Custom Field Settings applied to the team.
custom_field_settings[]ModelEach itemExpand Get a goal — response body — data data custom field settings item

Referenced models: Get a team — response body — data data organization, Get a goal — response body — data data custom field settings item

Get teams for a user — response body — data, next page

FieldTypePresenceDescription and constraints
$objectRoot
dataarrayRequired within parent
data[]ModelEach itemExpand Get a team — response body — data data — sdk__Team Response
next_pageModelOptionalExpand Get goals — response body — data, next page next page

Referenced models: Get goals — response body — data, next page next page, Get a team — response body — data data — sdk__Team Response

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.