Asana API
Getting access, Developing, Testing
Back to Asana
Get A Project Template
Returns the complete project template record for a single project template.
Input
type: object
properties:
parameters:
type: object
properties:
project_template_gid:
type: string
description: Globally unique identifier for the project template.
opt_pretty:
type: boolean
description: >-
Provides “pretty” output.
Provides the response in a “pretty” format. In the case of JSON this
means doing proper line breaking and indentation to make it readable.
This will take extra time and increase the response size so it is
advisable only to use this during debugging.
opt_fields:
type: array
items:
type: string
description: >-
Defines fields to return.
Some requests return *compact* representations of objects in order to
conserve resources and complete the request more efficiently. Other
times requests return more information than you may need. This option
allows you to list the exact set of fields that the API should be sure
to return for the objects. The field names should be provided as
paths, described below.
The id of included objects will always be returned, regardless of the
field options.
required:
- project_template_gid
title: Parameters
Output
type: object
properties:
data:
type: object
properties:
gid:
description: Globally unique identifier of the resource, as a string.
type: string
readOnly: true
example: '12345'
x-insert-after: false
resource_type:
description: The base type of this resource.
type: string
readOnly: true
example: task
x-insert-after: gid
name:
description: Name of the project template.
type: string
example: Packing list
description:
description: Free-form textual information associated with the project template
type: string
example: These are things we need to pack for a trip.
html_description:
description: The description of the project template with formatting as HTML.
type: string
example: <body>These are things we need to pack for a trip.</body>
public:
description: True if the project template is public to its team.
type: boolean
example: false
owner:
type: object
properties:
gid:
description: Globally unique identifier of the resource, as a string.
type: string
readOnly: true
example: '12345'
x-insert-after: false
resource_type:
description: The base type of this resource.
type: string
readOnly: true
example: task
x-insert-after: gid
name:
type: string
description: '*Read-only except when same user as requester*. The user’s name.'
example: Greg Sanchez
team:
type: object
properties:
gid:
description: Globally unique identifier of the resource, as a string.
type: string
readOnly: true
example: '12345'
x-insert-after: false
resource_type:
description: The base type of this resource.
type: string
readOnly: true
example: task
x-insert-after: gid
name:
description: The name of the team.
type: string
example: Marketing
requested_dates:
description: >-
Array of date variables in this project template. Calendar dates must
be provided for these variables when instantiating a project.
type: array
readOnly: true
items:
type: object
properties:
gid:
description: >-
Globally 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.
type: string
readOnly: true
example: '1'
name:
description: The name of the date variable.
type: string
readOnly: true
example: Start Date
description:
description: >-
The description of what the date variable is used for when
instantiating a project.
type: string
readOnly: true
example: Choose a start date for your project.
color:
description: Color of the project template.
type: string
nullable: true
enum:
- 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
example: light-green
requested_roles:
description: >-
Array 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.
type: array
items:
type: object
properties:
gid:
description: Globally unique identifier of the resource, as a string.
type: string
readOnly: true
example: '12345'
x-insert-after: false
resource_type:
description: The base type of this resource.
type: string
readOnly: true
example: task
x-insert-after: gid
name:
type: string
description: Name of the template role.
example: Designer