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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A user identification object for specification with the addUser/removeUser endpoints. |
user | string | Optional | A 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | <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. |
gid | string | Optional | Globally unique identifier of the resource, as a string. Read only: true |
resource_type | string | Optional | The base type of this resource. Read only: true |
name | string | Optional | The name of the team. |
Add a user to a team — response body — data data team — shared_team_674c225d7cda
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A 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. |
gid | string | Optional | Globally unique identifier of the resource, as a string. Read only: true |
resource_type | string | Optional | The base type of this resource. Read only: true |
name | string | Optional | The name of the team. |
Add a user to a team — response body — data data — Team Membership Compact
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | This object represents a user's connection to a team. |
gid | string | Optional | Globally unique identifier of the resource, as a string. Read only: true |
resource_type | string | Optional | The base type of this resource. Read only: true |
user | Model | Optional | Expand Get users in a team — response body — data data item |
team | Model | Optional | Expand Add a user to a team — response body — data data team — Team Compact |
is_guest | boolean | Optional | Describes if the user is a guest in the team. |
is_limited_access | boolean | Optional | Describes if the user has limited access to the team. Read only: true |
is_admin | boolean | Optional | Describes 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A 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. |
gid | string | Optional | Globally unique identifier of the resource, as a string. Read only: true |
resource_type | string | Optional | The base type of this resource. Read only: true |
user | Model | Optional | Expand Get an OOO entry — response body — data data user |
team | Model | Optional | Expand Add a user to a team — response body — data data team — shared_team_674c225d7cda |
is_guest | boolean | Optional | Describes if the user is a guest in the team. |
is_limited_access | boolean | Optional | Describes if the user has limited access to the team. Read only: true |
is_admin | boolean | Optional | Describes 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | 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.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. |
gid | string | Optional | Globally unique identifier of the resource, as a string. Read only: true |
resource_type | string | Optional | The base type of this resource. Read only: true |
name | string | Optional | The name of the workspace. |
Get a team — response body — data data — Team Response
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (allOf 1) | Model | All variants apply | Expand Add a user to a team — response body — data data team — Team Compact |
$ (allOf 2) | object | All variants apply | |
$ (allOf 2).description | string | Optional | [Opt In](/docs/inputoutput-options). The description of the team. |
$ (allOf 2).html_description | string | Optional | [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).organization | JSON | Optional | |
$ (allOf 2).organization (allOf 1) | Model | All variants apply | Expand Update a workspace — request body — body data |
$ (allOf 2).organization (allOf 2) | object | All variants apply | The organization/workspace the team belongs to. |
$ (allOf 2).permalink_url | string | Optional | A url that points directly to the object within Asana. Read only: true |
$ (allOf 2).visibility | string | Optional | The 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_level | string | Optional | Controls who can edit team name and description Known values: all_team_members, only_team_admins |
$ (allOf 2).edit_team_visibility_or_trash_team_access_level | string | Optional | Controls who can edit team visibility and trash teams Known values: all_team_members, only_team_admins |
$ (allOf 2).member_invite_management_access_level | string | Optional | Controls 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_level | string | Optional | Controls 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_level | string | Optional | Controls 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_level | string | Optional | Controls who can remove team members Known values: all_team_members, only_team_admins |
$ (allOf 2).team_content_management_access_level | string | Optional | Controls who can create and share content with the team Known values: no_restriction, only_team_admins |
$ (allOf 2).endorsed | boolean | Optional | Whether the team has been endorsed |
$ (allOf 2).custom_field_settings | array | Optional | Array of Custom Field Settings applied to the team. |
$ (allOf 2).custom_field_settings[] | Model | Each item | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A 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. |
gid | string | Optional | Globally unique identifier of the resource, as a string. Read only: true |
resource_type | string | Optional | The base type of this resource. Read only: true |
name | string | Optional | The name of the team. |
description | string | Optional | [Opt In](/docs/inputoutput-options). The description of the team. |
html_description | string | Optional | [Opt In](/docs/inputoutput-options). The description of the team with formatting as HTML. See [rich text](/docs/rich-text#reading-rich-text). |
organization | Model | Optional | Expand Get a team — response body — data data organization |
permalink_url | string | Optional | A url that points directly to the object within Asana. Read only: true |
visibility | string | Optional | The visibility of the team to users in the same organization Known values: secret, request_to_join, public |
edit_team_name_or_description_access_level | string | Optional | Controls who can edit team name and description Known values: all_team_members, only_team_admins |
edit_team_visibility_or_trash_team_access_level | string | Optional | Controls who can edit team visibility and trash teams Known values: all_team_members, only_team_admins |
member_invite_management_access_level | string | Optional | Controls who can accept or deny member invites for a given team Known values: all_team_members, only_team_admins |
guest_invite_management_access_level | string | Optional | Controls who can accept or deny guest invites for a given team Known values: all_team_members, only_team_admins |
join_request_management_access_level | string | Optional | Controls 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_level | string | Optional | Controls who can remove team members Known values: all_team_members, only_team_admins |
team_content_management_access_level | string | Optional | Controls who can create and share content with the team Known values: no_restriction, only_team_admins |
endorsed | boolean | Optional | Whether the team has been endorsed |
custom_field_settings | array | Optional | Array of Custom Field Settings applied to the team. |
custom_field_settings[] | Model | Each item | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | array | Required within parent | |
data[] | Model | Each item | Expand Get a team — response body — data data — sdk__Team Response |
next_page | Model | Optional | Expand 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