Skip to content

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

FieldTypePresenceDescription and constraints
$JSONRoot
$ (allOf 1)ModelAll variants applyExpand Update a tag — request body — body data
$ (allOf 2)objectAll variants apply
$ (allOf 2).followersarrayOptionalAn array of strings identifying users. These can either be the string "me", an email, or the gid of a user.
$ (allOf 2).followers[]stringEach item

Referenced models: Update a tag — request body — body data

Create a tag — request body — body data

FieldTypePresenceDescription and constraints
$JSONRoot
$ (allOf 1)ModelAll variants applyExpand Update a tag — request body — body data
$ (allOf 2)objectAll variants apply
$ (allOf 2).followersarrayOptionalAn array of strings identifying users. These can either be the string "me", an email, or the gid of a user.
$ (allOf 2).followers[]stringEach item
$ (allOf 2).workspacestringOptionalGid of an object.

Referenced models: Update a tag — request body — body data

Delete a tag — response body — data

FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand Delete a tag — response body — data data

Referenced models: Delete a tag — response body — data data

Delete a tag — response body — data data

FieldTypePresenceDescription and constraints
$objectRootAn 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

FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand 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

FieldTypePresenceDescription and constraints
$JSONRoot
$ (allOf 1)ModelAll variants applyExpand Get a task's tags — response body — data, next page data item
$ (allOf 2)objectAll variants apply
$ (allOf 2).colorJSONOptional
$ (allOf 2).color (anyOf 1)stringAlternativeColor 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)nullAlternative
$ (allOf 2).notesstringOptionalFree-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

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.
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 tag — response body — data data — Tag Response

FieldTypePresenceDescription and constraints
$JSONRoot
$ (allOf 1)ModelAll variants applyExpand Get a tag — response body — data data color, gid, name, notes, resource type
$ (allOf 2)objectAll variants apply
$ (allOf 2).created_atstringOptionalThe time at which this resource was created.
Format: date-time
Read only: true
$ (allOf 2).followersarrayOptionalArray of users following this tag.
Read only: true
$ (allOf 2).followers[]ModelEach itemExpand Get users in a team — response body — data data item
$ (allOf 2).workspaceModelOptionalExpand Update a workspace — request body — body data
$ (allOf 2).permalink_urlstringOptionalA 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

FieldTypePresenceDescription and constraints
$objectRootA 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.
gidstringOptionalGlobally unique identifier of the resource, as a string.
Read only: true
resource_typestringOptionalThe base type of this resource.
Read only: true
namestringOptionalName 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.
colorJSONOptional
color (anyOf 1)stringAlternativeColor 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)nullAlternative
notesstringOptionalFree-form textual information associated with the tag (i.e. its description).
created_atstringOptionalThe time at which this resource was created.
Format: date-time
Read only: true
followersarrayOptionalArray of users following this tag.
Read only: true
followers[]ModelEach itemExpand Get an OOO entry — response body — data data user
workspaceModelOptionalExpand Get a tag — response body — data data workspace
permalink_urlstringOptionalA 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

FieldTypePresenceDescription and constraints
$objectRoot
dataarrayRequired within parent
data[]ModelEach itemExpand Get a tag — response body — data data — sdk__Tag 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 tag — response body — data data — sdk__Tag Response

Get a task's tags — response body — data, next page data item

FieldTypePresenceDescription and constraints
$objectRootA *tag* is a label that can be attached to any task in Asana. It exists in a single workspace or organization.
gidstringOptionalGlobally unique identifier of the resource, as a string.
Read only: true
resource_typestringOptionalThe base type of this resource.
Read only: true
namestringOptionalName 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

FieldTypePresenceDescription and constraints
$JSONRoot
$ (allOf 1)ModelAll variants applyExpand Get a task's tags — response body — data, next page data item
$ (allOf 2)objectAll variants apply
$ (allOf 2).colorJSONOptional
$ (allOf 2).color (anyOf 1)stringAlternativeColor 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)nullAlternative
$ (allOf 2).notesstringOptionalFree-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

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.