Asana: Tags schemas
12 Asana schemas with complete fields and constraints.
← Tags operations · All schemas
Create a tag in a workspace — request body — body data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (allOf 1) | Model | All variants apply | Expand Update a tag — request body — body data |
$ (allOf 2) | object | All variants apply | |
$ (allOf 2).followers | array | Optional | An array of strings identifying users. These can either be the string "me", an email, or the gid of a user. |
$ (allOf 2).followers[] | string | Each item |
Referenced models: Update a tag — request body — body data
Create a tag — request body — body data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (allOf 1) | Model | All variants apply | Expand Update a tag — request body — body data |
$ (allOf 2) | object | All variants apply | |
$ (allOf 2).followers | array | Optional | An array of strings identifying users. These can either be the string "me", an email, or the gid of a user. |
$ (allOf 2).followers[] | string | Each item | |
$ (allOf 2).workspace | string | Optional | Gid of an object. |
Referenced models: Update a tag — request body — body data
Delete a tag — response body — data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand Delete a tag — response body — data data |
Referenced models: Delete a tag — response body — data data
Delete a tag — response body — data data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | An empty object. Some endpoints do not return an object on success. The success is conveyed through a 2-- status code and returning an empty object. |
Get a tag — response body — data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand Get a tag — response body — data data — sdk__Tag Response |
Referenced models: Get a tag — response body — data data — sdk__Tag Response
Get a tag — response body — data data color, gid, name, notes, resource type
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (allOf 1) | Model | All variants apply | Expand Get a task's tags — response body — data, next page data item |
$ (allOf 2) | object | All variants apply | |
$ (allOf 2).color | JSON | Optional | |
$ (allOf 2).color (anyOf 1) | string | Alternative | Color of the tag. Known values: dark-pink, dark-green, dark-blue, dark-red, dark-teal, dark-brown, dark-orange, dark-purple, dark-warm-gray, light-pink, light-green, light-blue, light-red, light-teal, light-brown, light-orange, light-purple, light-warm-gray |
$ (allOf 2).color (anyOf 2) | null | Alternative | |
$ (allOf 2).notes | string | Optional | Free-form textual information associated with the tag (i.e. its description). |
Referenced models: Get a task's tags — response body — data, next page data item
Get a tag — response body — data data workspace
| 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. |
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 tag — response body — data data — Tag Response
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (allOf 1) | Model | All variants apply | Expand Get a tag — response body — data data color, gid, name, notes, resource type |
$ (allOf 2) | object | All variants apply | |
$ (allOf 2).created_at | string | Optional | The time at which this resource was created. Format: date-time Read only: true |
$ (allOf 2).followers | array | Optional | Array of users following this tag. Read only: true |
$ (allOf 2).followers[] | Model | Each item | Expand Get users in a team — response body — data data item |
$ (allOf 2).workspace | Model | Optional | Expand Update a workspace — request body — body data |
$ (allOf 2).permalink_url | string | Optional | A url that points directly to the object within Asana. Read only: true |
Referenced models: Get a tag — response body — data data color, gid, name, notes, resource type, Get users in a team — response body — data data item, Update a workspace — request body — body data
Get a tag — response body — data data — sdk__Tag 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 *tag* is a label that can be attached to any task in Asana. It exists in a single workspace or organization. |
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 | Name of the tag. This is generally a short sentence fragment that fits on a line in the UI for maximum readability. However, it can be longer. |
color | JSON | Optional | |
color (anyOf 1) | string | Alternative | Color of the tag. Known values: dark-pink, dark-green, dark-blue, dark-red, dark-teal, dark-brown, dark-orange, dark-purple, dark-warm-gray, light-pink, light-green, light-blue, light-red, light-teal, light-brown, light-orange, light-purple, light-warm-gray |
color (anyOf 2) | null | Alternative | |
notes | string | Optional | Free-form textual information associated with the tag (i.e. its description). |
created_at | string | Optional | The time at which this resource was created. Format: date-time Read only: true |
followers | array | Optional | Array of users following this tag. Read only: true |
followers[] | Model | Each item | Expand Get an OOO entry — response body — data data user |
workspace | Model | Optional | Expand Get a tag — response body — data data workspace |
permalink_url | string | Optional | A url that points directly to the object within Asana. Read only: true |
Referenced models: Get an OOO entry — response body — data data user, Get a tag — response body — data data workspace
Get a task's tags — 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 tag — response body — data data — sdk__Tag 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 tag — response body — data data — sdk__Tag Response
Get a task's tags — response body — data, next page data item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A *tag* is a label that can be attached to any task in Asana. It exists in a single workspace or organization. |
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 | Name of the tag. This is generally a short sentence fragment that fits on a line in the UI for maximum readability. However, it can be longer. |
Update a tag — request body — body data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (allOf 1) | Model | All variants apply | Expand Get a task's tags — response body — data, next page data item |
$ (allOf 2) | object | All variants apply | |
$ (allOf 2).color | JSON | Optional | |
$ (allOf 2).color (anyOf 1) | string | Alternative | Color of the tag. One of: dark-pink, dark-green, dark-blue, dark-red, dark-teal, dark-brown, dark-orange, dark-purple, dark-warm-gray, light-pink, light-green, light-blue, light-red, light-teal, light-brown, light-orange, light-purple, light-warm-gray, null |
$ (allOf 2).color (anyOf 2) | null | Alternative | |
$ (allOf 2).notes | string | Optional | Free-form textual information associated with the tag (i.e. its description). |
Referenced models: Get a task's tags — response body — data, next page data item