Skip to content

Asana: Get a task template

Asana taskTemplates.getTaskTemplate: arguments, response, policy and SDK examples.

← Task templates operations · Get started

Operation asana.gettasktemplate

Provider route: GET /task_templates/{task_template_gid}. Alter supplies the connection’s credentials and routing.

Install @alter-ai/sdk @alter-ai/asana with npm, or alter-sdk-asana with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { AsanaIntegration } from "@alter-ai/asana";
async function execute(input: Parameters<AsanaIntegration["taskTemplates"]["getTaskTemplate"]>[0]) {
const app = new App({ apiKey: process.env.ALTER_API_KEY! });
try {
const provider = new AsanaIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
const call = await provider.taskTemplates.getTaskTemplate(input);
const result = await call.wait();
return result.bodyJson();
} finally {
await app.close();
}
}
import os
from alter_sdk import App
from alter_sdk_asana import AsanaIntegration
async def execute(arguments):
async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
provider = AsanaIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
call = await provider.task_templates.get_task_template(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
pathobjectRequired within parentAdditional keys: not allowed
path.task_template_gidstringRequired within parent
queryobjectOptionalAdditional keys: not allowed
query.opt_prettybooleanOptional
query.opt_fieldsarrayOptional
query.opt_fields[]stringEach itemOne of: created_at, created_by, name, project, template

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

FieldTypePresenceDescription and constraints
$JSONRoot
$ (allOf 1)objectAll variants apply
$ (allOf 1).dataModelOptionalExpand Get a task template — response body — data data — Task Template Response
$ (allOf 2)ModelAll variants applyExpand Get a task template — response body — data

Referenced models: Get a task template — response body — data data — Task Template Response, Get a task template — response body — data

13 more schemas are linked from the tables above, on the schema pages.

Get a task template — response body — data data — Task Template Response
FieldTypePresenceDescription and constraints
$JSONRoot
$ (allOf 1)ModelAll variants applyExpand Get a task template — response body — data data gid, name, resource type
$ (allOf 2)objectAll variants apply
$ (allOf 2).namestringOptionalName of the task template.
$ (allOf 2).projectJSONOptional
$ (allOf 2).project (anyOf 1)JSONAlternativeThe project that this task template belongs to.
$ (allOf 2).project (anyOf 1) (allOf 1)ModelAll variants applyExpand Search projects in a workspace — response body — data data item
$ (allOf 2).project (anyOf 2)nullAlternative
$ (allOf 2).templateJSONOptionalThe configuration for the task that will be created from this template.
$ (allOf 2).template (allOf 1)ModelAll variants applyExpand Get a task template — response body — data / data / created_at, created_by, name, project, template / template / task_resource_subtype: default task, milestone task, approval task
$ (allOf 2).created_byJSONOptionalThe user who created this task template.
$ (allOf 2).created_by (allOf 1)ModelAll variants applyExpand Get users in a team — response body — data data item
$ (allOf 2).created_atstringOptionalThe time at which this task template was created.
Format: date-time

Referenced models: Search projects in a workspace — response body — data data item, Get a task template — response body — data data gid, name, resource type, Get a task template — response body — data / data / created_at, created_by, name, project, template / template / task_resource_subtype: default task, milestone task, approval task, Get users in a team — response body — data data item

Get a task template — response body — data
FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand Get a task template — response body — data data — sdk__Task Template Response

Referenced models: Get a task template — response body — data data — sdk__Task Template Response

Search projects in a workspace — response body — data data item
FieldTypePresenceDescription and constraints
$objectRootA *project* represents a prioritized list of tasks in Asana or a board with columns of tasks represented as cards. It exists in a single workspace or organization and is accessible to a subset of users in that workspace or organization, depending on its permissions.
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 project. This is generally a short sentence fragment that fits on a line in the UI for maximum readability. However, it can be longer.
resource_subtypestringOptionalThe subtype of this resource. Different subtypes retain many of the same fields and behavior, but may render differently in Asana or represent resources with different semantic meaning.
Known values: default_project, custom
Get a task template — response body — data data gid, name, resource type
FieldTypePresenceDescription and constraints
$JSONRoot
$ (allOf 1)ModelAll variants applyExpand Get multiple task templates — response body — data, next page data item

Referenced models: Get multiple task templates — response body — data, next page data item

Get a task template — response body — data / data / created_at, created_by, name, project, template / template / task_resource_subtype: default task, milestone task, approval task
FieldTypePresenceDescription and constraints
$JSONRoot
$ (allOf 1)ModelAll variants applyExpand Get a task template — response body — data / data / created_at, created_by, name, project, template / template / task_resource_subtype: default task, milestone task, approval task task resource subtype: default task, milestone task, approval task
$ (allOf 2)objectAll variants apply
$ (allOf 2).descriptionstringOptionalDescription of the task that will be created from this template.
$ (allOf 2).html_descriptionstringOptionalHTML description of the task that will be created from this template. See [rich text](/docs/rich-text#reading-rich-text).
$ (allOf 2).membershipsarrayOptionalArray of projects that the task created from this template will be added to
$ (allOf 2).memberships[]ModelEach itemExpand Search projects in a workspace — response body — data data item
$ (allOf 2).relative_start_onJSONOptional
$ (allOf 2).relative_start_on (anyOf 1)JSONAlternative
$ (allOf 2).relative_start_on (anyOf 1) (anyOf 1)integerAlternativeThe number of days after the task has been instantiated on which that the task will start
$ (allOf 2).relative_start_on (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
$ (allOf 2).relative_start_on (anyOf 2)nullAlternative
$ (allOf 2).relative_due_onJSONOptional
$ (allOf 2).relative_due_on (anyOf 1)JSONAlternative
$ (allOf 2).relative_due_on (anyOf 1) (anyOf 1)integerAlternativeThe number of days after the task has been instantiated on which that the task will be due
$ (allOf 2).relative_due_on (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
$ (allOf 2).relative_due_on (anyOf 2)nullAlternative
$ (allOf 2).due_timeJSONOptional
$ (allOf 2).due_time (anyOf 1)stringAlternativeThe time of day that the task will be due
$ (allOf 2).due_time (anyOf 2)nullAlternative
$ (allOf 2).dependenciesarrayOptionalArray of task templates that the task created from this template will depend on
$ (allOf 2).dependencies[]ModelEach itemExpand Get a task template — response body — data / data / created_at, created_by, name, project, template / template / task_resource_subtype: default task, milestone task, approval task task resource subtype: default task, milestone task, approval task
$ (allOf 2).dependentsarrayOptionalArray of task templates that will depend on the task created from this template
$ (allOf 2).dependents[]ModelEach itemExpand Get a task template — response body — data / data / created_at, created_by, name, project, template / template / task_resource_subtype: default task, milestone task, approval task task resource subtype: default task, milestone task, approval task
$ (allOf 2).followersarrayOptionalArray of users that will be added as followers to the task created from this template
$ (allOf 2).followers[]ModelEach itemExpand Get users in a team — response body — data data item
$ (allOf 2).attachmentsarrayOptionalArray of attachments that will be added to the task created from this template
$ (allOf 2).attachments[]ModelEach itemExpand Get attachments from an object — response body — data, next page data item
$ (allOf 2).subtasksarrayOptionalArray of subtasks that will be added to the task created from this template
$ (allOf 2).subtasks[]ModelEach itemExpand Get a task template — response body — data / data / created_at, created_by, name, project, template / template / task_resource_subtype: default task, milestone task, approval task task resource subtype: default task, milestone task, approval task
$ (allOf 2).custom_fieldsarrayOptionalArray of custom fields that will be added to the task created from this template
$ (allOf 2).custom_fields[]ModelEach itemExpand Get a membership — response body — data / data / access_level: admin, editor, user parent

Referenced models: Get attachments from an object — response body — data, next page data item, Get a membership — response body — data / data / access_level: admin, editor, user parent, Search projects in a workspace — response body — data data item, Get a task template — response body — data / data / created_at, created_by, name, project, template / template / task_resource_subtype: default task, milestone task, approval task task resource subtype: default task, milestone task, approval task, Get users in a team — response body — data data item

Get users in a team — response body — data data item
FieldTypePresenceDescription and constraints
$objectRootA *user* object represents an account in Asana that can be given access to various workspaces, projects, and tasks.
gidstringOptionalGlobally unique identifier of the resource, as a string.
Read only: true
resource_typestringOptionalThe base type of this resource.
Read only: true
namestringOptional*Read-only except when same user as requester*. The user's name.

SDK function policy ID: asana.gettasktemplate. Catalog operation: asana:getTaskTemplate. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Required provider scopes: ["task_templates:read"]

Official provider source

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.