Task templates

Get a task template

Changed on

<b>Required scope: </b><code>task_templates:read</code>

Returns the complete task template record for a single task template.

get/task_templates/{task_template_gid}

Request

  • Base URL: https://app.asana.com/api/1.0
  • URL: https://app.asana.com/api/1.0/task_templates/{task_template_gid}
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://app.asana.com/-/oauth_authorize, token URL https://app.asana.com/-/oauth_token, scopes: task_templates:read)

Query parameters

opt_fieldsstring[]

This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. Properties can include nested fields. To learn more, see the input/output options guide.

Response

Successfully retrieved requested task template

Example response

{
  "data": {
    "gid": "12345",
    "resource_type": "task_template",
    "name": "Bug Report Template",
    "project": {
      "gid": "12345",
      "resource_type": "project",
      "name": "Stuff to buy",
      "resource_subtype": "default_project"
    },
    "template": {
      "name": "Bug Report",
      "task_resource_subtype": "default_task",
      "description": "Please describe the bug you found and how to reproduce it.",
      "html_description": "Please describe the bug you found and how to reproduce it.",
      "memberships": [
        {
          "gid": "12345",
          "resource_type": "project",
          "name": "Stuff to buy",
          "resource_subtype": "default_project"
        }
      ],
      "relative_start_on": 1,
      "relative_due_on": 2,
      "due_time": "13:15:00.000Z",
      "dependencies": [
        {
          "name": "Bug Report",
          "task_resource_subtype": "default_task"
        }
      ],
      "dependents": [
        {
          "name": "Bug Report",
          "task_resource_subtype": "default_task"
        }
      ],
      "followers": [
        {
          "gid": "12345",
          "resource_type": "user",
          "name": "Greg Sanchez"
        }
      ],
      "attachments": [
        {
          "gid": "12345",
          "resource_type": "attachment",
          "name": "Screenshot.png",
          "resource_subtype": "dropbox"
        }
      ],
      "subtasks": [
        {
          "name": "Bug Report",
          "task_resource_subtype": "default_task"
        }
      ],
      "custom_fields": [
        {
          "gid": "12345",
          "resource_type": "custom_field",
          "name": "Status",
          "enum_options": [
            {
              "gid": "12345",
              "resource_type": "enum_option",
              "name": "Low",
              "enabled": true,
              "color": "blue"
            }
          ],
          "enabled": true,
          "representation_type": "number",
          "id_prefix": "ID",
          "input_restrictions": [
            "task"
          ],
          "date_value": {
            "date": "2024-08-23",
            "date_time": "2024-08-23T22:00:00.000Z"
          },
          "enum_value": {
            "gid": "12345",
            "resource_type": "enum_option",
            "name": "Low",
            "enabled": true,
            "color": "blue"
          },
          "multi_enum_values": [
            {
              "gid": "12345",
              "resource_type": "enum_option",
              "name": "Low",
              "enabled": true,
              "color": "blue"
            }
          ],
          "number_value": 5.2,
          "text_value": "Some Value",
          "display_value": "blue"
        }
      ]
    },
    "created_by": {
      "gid": "12345",
      "resource_type": "user",
      "name": "Greg Sanchez"
    },
    "created_at": "2019-01-01T00:00:00.000Z"
  }
}

Changes

  • 2aac685725ecRevision changes
    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property ////////// to the response with the status

  • b3dcd9ce0bf2Revision changes
    • warning

      added the new goal enum value to the /////////// response property for the response status

    • warning

      added the new portfolio enum value to the /////////// response property for the response status

    • warning

      added the new project enum value to the /////////// response property for the response status

    • warning

      added the new reference enum value to the ////////// response property for the response status

    • warning

      added the new reference enum value to the ////////// response property for the response status

    • warning

      added the new task enum value to the /////////// response property for the response status