Skip to content

Asana: Get a project template

Asana projectTemplates.getProjectTemplate: arguments, response, policy and SDK examples.

← Project templates operations · Get started

Operation asana.getprojecttemplate

Provider route: GET /project_templates/{project_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["projectTemplates"]["getProjectTemplate"]>[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.projectTemplates.getProjectTemplate(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.project_templates.get_project_template(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
pathobjectRequired within parentAdditional keys: not allowed
path.project_template_gidstringRequired within parent
queryobjectOptionalAdditional keys: not allowed
query.opt_prettybooleanOptional
query.opt_fieldsarrayOptional
query.opt_fields[]stringEach itemOne of: color, description, html_description, name, owner, public, requested_dates, requested_dates.description, requested_dates.name, requested_roles, requested_roles.name, team, team.name

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 project template — response body — data data — Project Template Response
$ (allOf 2)ModelAll variants applyExpand Get a project template — response body — data

Referenced models: Get a project template — response body — data data — Project Template Response, Get a project template — response body — data

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

Get a project template — response body — data data — Project Template Response
FieldTypePresenceDescription and constraints
$JSONRoot
$ (allOf 1)ModelAll variants applyExpand Get a project template — response body — data data color, description, gid, html description, name, owner, public, requested dates, requested roles, resource type, team

Referenced models: Get a project template — response body — data data color, description, gid, html description, name, owner, public, requested dates, requested roles, resource type, team

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

Referenced models: Get a project template — response body — data data — sdk__Project Template Response

Get a project template — response body — data data color, description, gid, html description, name, owner, public, requested dates, requested roles, resource type, team
FieldTypePresenceDescription and constraints
$JSONRoot
$ (allOf 1)ModelAll variants applyExpand Get a team's project templates — response body — data, next page data item
$ (allOf 2)objectAll variants apply
$ (allOf 2).descriptionstringOptionalFree-form textual information associated with the project template
$ (allOf 2).html_descriptionstringOptionalThe description of the project template with formatting as HTML. See [rich text](/docs/rich-text#reading-rich-text).
$ (allOf 2).publicbooleanOptionalTrue if the project template is public to its team.
$ (allOf 2).ownerJSONOptional
$ (allOf 2).owner (anyOf 1)JSONAlternativeThe current owner of the project template, may be null.
$ (allOf 2).owner (anyOf 1) (allOf 1)ModelAll variants applyExpand Get users in a team — response body — data data item
$ (allOf 2).owner (anyOf 1) (allOf 2)objectAll variants apply
$ (allOf 2).owner (anyOf 2)nullAlternative
$ (allOf 2).teamJSONOptional
$ (allOf 2).team (allOf 1)ModelAll variants applyExpand Add a user to a team — response body — data data team — Team Compact
$ (allOf 2).requested_datesarrayOptionalArray of date variables in this project template. Calendar dates must be provided for these variables when instantiating a project.
Read only: true
$ (allOf 2).requested_dates[]ModelEach itemExpand Get a project template — response body — data data color, description, gid, html description, name, owner, public, requested dates, requested roles, resource type, team color, description, html description, owner, public, requested dates, requested roles, team requested dates item
$ (allOf 2).colorJSONOptional
$ (allOf 2).color (anyOf 1)stringAlternativeColor of the project template.
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).requested_rolesarrayOptionalArray of template roles in this project template. User Ids can be provided for these variables when instantiating a project to assign template tasks to the user.
$ (allOf 2).requested_roles[]ModelEach itemExpand Get a project template — response body — data data color, description, gid, html description, name, owner, public, requested dates, requested roles, resource type, team color, description, html description, owner, public, requested dates, requested roles, team requested roles item

Referenced models: Get a project template — response body — data data color, description, gid, html description, name, owner, public, requested dates, requested roles, resource type, team color, description, html description, owner, public, requested dates, requested roles, team requested dates item, Get a team's project templates — response body — data, next page data item, Add a user to a team — response body — data data team — Team Compact, Get a project template — response body — data data color, description, gid, html description, name, owner, public, requested dates, requested roles, resource type, team color, description, html description, owner, public, requested dates, requested roles, team requested roles item, Get users in a team — response body — data data item

Get a project template — response body — data data — sdk__Project Template Response
FieldTypePresenceDescription and constraints
$objectRootA generic Asana Resource, containing a globally unique identifier.A generic Asana Resource, containing a globally unique identifier.
A *project template* is an object that allows new projects to be created with a predefined setup, which may include tasks, sections, Rules, etc. It simplifies the process of running a workflow that involves a similar set of work every time.
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 template.
descriptionstringOptionalFree-form textual information associated with the project template
html_descriptionstringOptionalThe description of the project template with formatting as HTML. See [rich text](/docs/rich-text#reading-rich-text).
publicbooleanOptionalTrue if the project template is public to its team.
ownerJSONOptional
owner (anyOf 1)JSONAlternativeThe current owner of the project template, may be null.
owner (anyOf 1) (allOf 1)ModelAll variants applyExpand Get an OOO entry — response body — data data user
owner (anyOf 1) (allOf 2)objectAll variants apply
owner (anyOf 2)nullAlternative
teamModelOptionalExpand Add a user to a team — response body — data data team — shared_team_674c225d7cda
requested_datesarrayOptionalArray of date variables in this project template. Calendar dates must be provided for these variables when instantiating a project.
Read only: true
requested_dates[]objectEach item
requested_dates[].gidstringOptionalGlobally unique identifier of the date field in the project template. A value of `1` refers to the project start date, while `2` refers to the project due date.
Read only: true
requested_dates[].namestringOptionalThe name of the date variable.
Read only: true
requested_dates[].descriptionstringOptionalThe description of what the date variable is used for when instantiating a project.
Read only: true
colorJSONOptional
color (anyOf 1)stringAlternativeColor of the project template.
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
requested_rolesarrayOptionalArray of template roles in this project template. User Ids can be provided for these variables when instantiating a project to assign template tasks to the user.
requested_roles[]objectEach itemA generic Asana Resource, containing a globally unique identifier.
requested_roles[].gidstringOptionalGlobally unique identifier of the resource, as a string.
Read only: true
requested_roles[].resource_typestringOptionalThe base type of this resource.
Read only: true
requested_roles[].namestringOptionalName of the template role.

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 project template — response body — data data color, description, gid, html description, name, owner, public, requested dates, requested roles, resource type, team color, description, html description, owner, public, requested dates, requested roles, team requested dates item
FieldTypePresenceDescription and constraints
$objectRoot
gidstringOptionalGlobally unique identifier of the date field in the project template. A value of `1` refers to the project start date, while `2` refers to the project due date.
Read only: true
namestringOptionalThe name of the date variable.
Read only: true
descriptionstringOptionalThe description of what the date variable is used for when instantiating a project.
Read only: true
Get a team's project templates — response body — data, next page data item
FieldTypePresenceDescription and constraints
$objectRootA *project template* is an object that allows new projects to be created with a predefined setup, which may include tasks, sections, Rules, etc. It simplifies the process of running a workflow that involves a similar set of work every time.
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 template.

SDK function policy ID: asana.getprojecttemplate. Catalog operation: asana:getProjectTemplate. 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: ["project_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.