asana
Module asana
API
Definitions
ballerinax/asana Ballerina library
Overview
Asana is a popular project management and team collaboration tool that enables teams to organize, track, and manage their work and projects. It offers features such as task assignments, project milestones, team dashboards, and more, facilitating efficient workflow management.
This Ballerina connector is designed to interface with Asana's REST API, enabling programmatic access to Asana's services. It allows developers to automate tasks, manage projects, tasks, teams, and more, directly from Ballerina applications.
Setup guide
To use the Asana Connector in Ballerina, you must have an Asana account and a Personal Access Token (PAT) or OAuth2 credentials for authentication.
If you already have an Asana account, you can integrate the connector with your existing account. If not, you can create a new Asana account by visiting Asana's Sign Up page and following the registration process. Once you have an Asana account, you can proceed to create a PAT or set up OAuth2.
Step 1: Access Asana developer console
-
Log in to your Asana account.
-
After logging in, navigate to the Asana developer console.
-
Click on the + Create new token button.
Step 2: Create a new access token
-
Provide a name for the token and accept Asana's API terms checkbox after reading them.
-
Click on the Create token button.
-
Copy the generated token and keep it secure. You will need this token to authenticate the Asana connector.
Quickstart
To use the Asana
connector in your Ballerina application, modify the .bal
file as follows:
Step 1: Import the connector
Import the ballerinax/asana
package into your Ballerina project.
import ballerinax/asana;
Step 2: Instantiate a new connector
Create an asana:ConnectionConfig
with the obtained PAT (or OAuth2) credentials and initialize the connector with it.
asana:ConnectionConfig asanaConfig = { auth: { token: authToken } }; asana:Client asana = check new (asanaConfig);
Step 3: Invoke the connector operation
Now, utilize the available connector operations.
Get all projects for the authenticated user
record {asana:ProjectCompact[] data?;} projects = check asana->/projects();
Create a new task in a project
asana:Tasks_body taskReq = { data: { name: "Email Marketing Campaign", notes: "Create a new email marketing campaign for the upcoming product launch.", workspace: "<workspaceId>", projects: ["<projectId>"] } }; record {asana:TaskResponse data?;} taskCreated = check asana->/tasks.post(taskReq);
Examples
The Asana
connector offers practical examples illustrating its use in various scenarios.
Explore these examples, covering the following use cases:
- Employee onboarding process automation - Automate the onboarding process of new employees using Asana projects and tasks.
- Team workload balancer - Evaluate and balance the workload of a given team using Asana tasks and assignments.
Clients
asana: Client
This is the interface for interacting with the Asana Platform. Our API reference is generated from our [OpenAPI spec] (https://raw.githubusercontent.com/Asana/openapi/master/defs/asana_oas.yaml).
Constructor
Gets invoked to initialize the connector
.
init (ConnectionConfig config, string serviceUrl)
- config ConnectionConfig - The configurations to be used when initializing the
connector
- serviceUrl string "https://app.asana.com/api/1.0" - URL of the target service
get attachments/[string attachment_gid]
function get attachments/[string attachment_gid](boolean? opt_pretty, ("connected_to_app"|"created_at"|"download_url"|"host"|"name"|"parent"|"parent.created_by"|"parent.name"|"parent.resource_subtype"|"permanent_url"|"resource_subtype"|"size"|"view_url")[]? opt_fields) returns Inline_response_200|error
Get an attachment
Parameters
- opt_pretty boolean? (default ()) - 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 ("connected_to_app"|"created_at"|"download_url"|"host"|"name"|"parent"|"parent.created_by"|"parent.name"|"parent.resource_subtype"|"permanent_url"|"resource_subtype"|"size"|"view_url")[]? (default ()) - This endpoint returns a compact 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.
Return Type
- Inline_response_200|error - Successfully retrieved the record for a single attachment.
delete attachments/[string attachment_gid]
function delete attachments/[string attachment_gid](boolean? opt_pretty) returns Inline_response_200_1|error
Delete an attachment
Parameters
- opt_pretty boolean? (default ()) - 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.
Return Type
- Inline_response_200_1|error - Successfully deleted the specified attachment.
get attachments
function get attachments(string parent, boolean? opt_pretty, int? 'limit, string? offset, ("connected_to_app"|"created_at"|"download_url"|"host"|"name"|"offset"|"parent"|"parent.created_by"|"parent.name"|"parent.resource_subtype"|"path"|"permanent_url"|"resource_subtype"|"size"|"uri"|"view_url")[]? opt_fields) returns Inline_response_200_2|error
Get attachments from an object
Parameters
- parent string - Globally unique identifier for object to fetch statuses from. Must be a GID for a
project
,project_brief
, ortask
.
- opt_pretty boolean? (default ()) - 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.
- 'limit int? (default ()) - Results per page. The number of objects to return per page. The value must be between 1 and 100.
- offset string? (default ()) - Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.'
- opt_fields ("connected_to_app"|"created_at"|"download_url"|"host"|"name"|"offset"|"parent"|"parent.created_by"|"parent.name"|"parent.resource_subtype"|"path"|"permanent_url"|"resource_subtype"|"size"|"uri"|"view_url")[]? (default ()) - This endpoint returns a compact 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.
Return Type
- Inline_response_200_2|error - Successfully retrieved the specified object's attachments.
post attachments
function post attachments(AttachmentRequest payload, boolean? opt_pretty, ("connected_to_app"|"created_at"|"download_url"|"host"|"name"|"parent"|"parent.created_by"|"parent.name"|"parent.resource_subtype"|"permanent_url"|"resource_subtype"|"size"|"view_url")[]? opt_fields) returns Inline_response_200|error
Upload an attachment
Parameters
- payload AttachmentRequest - The file you want to upload.
- opt_pretty boolean? (default ()) - 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 ("connected_to_app"|"created_at"|"download_url"|"host"|"name"|"parent"|"parent.created_by"|"parent.name"|"parent.resource_subtype"|"permanent_url"|"resource_subtype"|"size"|"view_url")[]? (default ()) - This endpoint returns a compact 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.
Return Type
- Inline_response_200|error - Successfully uploaded the attachment to the parent object.
get workspaces/[string workspace_gid]/audit_log_events
function get workspaces/[string workspace_gid]/audit_log_events(string? start_at, string? end_at, string? event_type, "user"|"asana"|"asana_support"|"anonymous"|"external_administrator"? actor_type, string? actor_gid, string? resource_gid, int? 'limit, string? offset) returns Inline_response_200_3|error
Get audit log events
Parameters
- start_at string? (default ()) - Filter to events created after this time (inclusive).
- end_at string? (default ()) - Filter to events created before this time (exclusive).
- event_type string? (default ()) - Filter to events of this type. Refer to the supported audit log events for a full list of values.
- actor_type "user"|"asana"|"asana_support"|"anonymous"|"external_administrator"? (default ()) - Filter to events with an actor of this type.
This only needs to be included if querying for actor types without an ID. If
actor_gid
is included, this should be excluded.
- actor_gid string? (default ()) - Filter to events triggered by the actor with this ID.
- resource_gid string? (default ()) - Filter to events with this resource ID.
- 'limit int? (default ()) - Results per page. The number of objects to return per page. The value must be between 1 and 100.
- offset string? (default ()) - Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.'
Return Type
- Inline_response_200_3|error - AuditLogEvents were successfully retrieved.
post batch
function post batch(Batch_body payload, boolean? opt_pretty, ("body"|"headers"|"status_code")[]? opt_fields) returns Inline_response_200_4|error
Submit parallel requests
Parameters
- payload Batch_body - The requests to batch together via the Batch API.
- opt_pretty boolean? (default ()) - 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 ("body"|"headers"|"status_code")[]? (default ()) - This endpoint returns a compact 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.
Return Type
- Inline_response_200_4|error - Successfully completed the requested batch API operations.
get projects/[string project_gid]/custom_field_settings
function get projects/[string project_gid]/custom_field_settings(boolean? opt_pretty, int? 'limit, string? offset, ("custom_field"|"custom_field.asana_created_field"|"custom_field.created_by"|"custom_field.created_by.name"|"custom_field.currency_code"|"custom_field.custom_label"|"custom_field.custom_label_position"|"custom_field.date_value"|"custom_field.date_value.date"|"custom_field.date_value.date_time"|"custom_field.description"|"custom_field.display_value"|"custom_field.enabled"|"custom_field.enum_options"|"custom_field.enum_options.color"|"custom_field.enum_options.enabled"|"custom_field.enum_options.name"|"custom_field.enum_value"|"custom_field.enum_value.color"|"custom_field.enum_value.enabled"|"custom_field.enum_value.name"|"custom_field.format"|"custom_field.has_notifications_enabled"|"custom_field.id_prefix"|"custom_field.is_formula_field"|"custom_field.is_global_to_workspace"|"custom_field.is_value_read_only"|"custom_field.multi_enum_values"|"custom_field.multi_enum_values.color"|"custom_field.multi_enum_values.enabled"|"custom_field.multi_enum_values.name"|"custom_field.name"|"custom_field.number_value"|"custom_field.people_value"|"custom_field.people_value.name"|"custom_field.precision"|"custom_field.representation_type"|"custom_field.resource_subtype"|"custom_field.text_value"|"custom_field.type"|"is_important"|"offset"|"parent"|"parent.name"|"path"|"project"|"project.name"|"uri")[]? opt_fields) returns Inline_response_200_5|error
Get a project's custom fields
Parameters
- opt_pretty boolean? (default ()) - 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.
- 'limit int? (default ()) - Results per page. The number of objects to return per page. The value must be between 1 and 100.
- offset string? (default ()) - Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.'
- opt_fields ("custom_field"|"custom_field.asana_created_field"|"custom_field.created_by"|"custom_field.created_by.name"|"custom_field.currency_code"|"custom_field.custom_label"|"custom_field.custom_label_position"|"custom_field.date_value"|"custom_field.date_value.date"|"custom_field.date_value.date_time"|"custom_field.description"|"custom_field.display_value"|"custom_field.enabled"|"custom_field.enum_options"|"custom_field.enum_options.color"|"custom_field.enum_options.enabled"|"custom_field.enum_options.name"|"custom_field.enum_value"|"custom_field.enum_value.color"|"custom_field.enum_value.enabled"|"custom_field.enum_value.name"|"custom_field.format"|"custom_field.has_notifications_enabled"|"custom_field.id_prefix"|"custom_field.is_formula_field"|"custom_field.is_global_to_workspace"|"custom_field.is_value_read_only"|"custom_field.multi_enum_values"|"custom_field.multi_enum_values.color"|"custom_field.multi_enum_values.enabled"|"custom_field.multi_enum_values.name"|"custom_field.name"|"custom_field.number_value"|"custom_field.people_value"|"custom_field.people_value.name"|"custom_field.precision"|"custom_field.representation_type"|"custom_field.resource_subtype"|"custom_field.text_value"|"custom_field.type"|"is_important"|"offset"|"parent"|"parent.name"|"path"|"project"|"project.name"|"uri")[]? (default ()) - This endpoint returns a compact 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.
Return Type
- Inline_response_200_5|error - Successfully retrieved custom field settings objects for a project.
get portfolios/[string portfolio_gid]/custom_field_settings
function get portfolios/[string portfolio_gid]/custom_field_settings(boolean? opt_pretty, int? 'limit, string? offset, ("custom_field"|"custom_field.asana_created_field"|"custom_field.created_by"|"custom_field.created_by.name"|"custom_field.currency_code"|"custom_field.custom_label"|"custom_field.custom_label_position"|"custom_field.date_value"|"custom_field.date_value.date"|"custom_field.date_value.date_time"|"custom_field.description"|"custom_field.display_value"|"custom_field.enabled"|"custom_field.enum_options"|"custom_field.enum_options.color"|"custom_field.enum_options.enabled"|"custom_field.enum_options.name"|"custom_field.enum_value"|"custom_field.enum_value.color"|"custom_field.enum_value.enabled"|"custom_field.enum_value.name"|"custom_field.format"|"custom_field.has_notifications_enabled"|"custom_field.id_prefix"|"custom_field.is_formula_field"|"custom_field.is_global_to_workspace"|"custom_field.is_value_read_only"|"custom_field.multi_enum_values"|"custom_field.multi_enum_values.color"|"custom_field.multi_enum_values.enabled"|"custom_field.multi_enum_values.name"|"custom_field.name"|"custom_field.number_value"|"custom_field.people_value"|"custom_field.people_value.name"|"custom_field.precision"|"custom_field.representation_type"|"custom_field.resource_subtype"|"custom_field.text_value"|"custom_field.type"|"is_important"|"offset"|"parent"|"parent.name"|"path"|"project"|"project.name"|"uri")[]? opt_fields) returns Inline_response_200_5|error
Get a portfolio's custom fields
Parameters
- opt_pretty boolean? (default ()) - 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.
- 'limit int? (default ()) - Results per page. The number of objects to return per page. The value must be between 1 and 100.
- offset string? (default ()) - Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.'
- opt_fields ("custom_field"|"custom_field.asana_created_field"|"custom_field.created_by"|"custom_field.created_by.name"|"custom_field.currency_code"|"custom_field.custom_label"|"custom_field.custom_label_position"|"custom_field.date_value"|"custom_field.date_value.date"|"custom_field.date_value.date_time"|"custom_field.description"|"custom_field.display_value"|"custom_field.enabled"|"custom_field.enum_options"|"custom_field.enum_options.color"|"custom_field.enum_options.enabled"|"custom_field.enum_options.name"|"custom_field.enum_value"|"custom_field.enum_value.color"|"custom_field.enum_value.enabled"|"custom_field.enum_value.name"|"custom_field.format"|"custom_field.has_notifications_enabled"|"custom_field.id_prefix"|"custom_field.is_formula_field"|"custom_field.is_global_to_workspace"|"custom_field.is_value_read_only"|"custom_field.multi_enum_values"|"custom_field.multi_enum_values.color"|"custom_field.multi_enum_values.enabled"|"custom_field.multi_enum_values.name"|"custom_field.name"|"custom_field.number_value"|"custom_field.people_value"|"custom_field.people_value.name"|"custom_field.precision"|"custom_field.representation_type"|"custom_field.resource_subtype"|"custom_field.text_value"|"custom_field.type"|"is_important"|"offset"|"parent"|"parent.name"|"path"|"project"|"project.name"|"uri")[]? (default ()) - This endpoint returns a compact 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.
Return Type
- Inline_response_200_5|error - Successfully retrieved custom field settings objects for a portfolio.
post custom_fields
function post custom_fields(Custom_fields_body payload, boolean? opt_pretty, ("asana_created_field"|"created_by"|"created_by.name"|"currency_code"|"custom_label"|"custom_label_position"|"date_value"|"date_value.date"|"date_value.date_time"|"description"|"display_value"|"enabled"|"enum_options"|"enum_options.color"|"enum_options.enabled"|"enum_options.name"|"enum_value"|"enum_value.color"|"enum_value.enabled"|"enum_value.name"|"format"|"has_notifications_enabled"|"id_prefix"|"is_formula_field"|"is_global_to_workspace"|"is_value_read_only"|"multi_enum_values"|"multi_enum_values.color"|"multi_enum_values.enabled"|"multi_enum_values.name"|"name"|"number_value"|"people_value"|"people_value.name"|"precision"|"representation_type"|"resource_subtype"|"text_value"|"type")[]? opt_fields) returns Inline_response_201|error
Create a custom field
Parameters
- payload Custom_fields_body - The custom field object to create.
- opt_pretty boolean? (default ()) - 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 ("asana_created_field"|"created_by"|"created_by.name"|"currency_code"|"custom_label"|"custom_label_position"|"date_value"|"date_value.date"|"date_value.date_time"|"description"|"display_value"|"enabled"|"enum_options"|"enum_options.color"|"enum_options.enabled"|"enum_options.name"|"enum_value"|"enum_value.color"|"enum_value.enabled"|"enum_value.name"|"format"|"has_notifications_enabled"|"id_prefix"|"is_formula_field"|"is_global_to_workspace"|"is_value_read_only"|"multi_enum_values"|"multi_enum_values.color"|"multi_enum_values.enabled"|"multi_enum_values.name"|"name"|"number_value"|"people_value"|"people_value.name"|"precision"|"representation_type"|"resource_subtype"|"text_value"|"type")[]? (default ()) - This endpoint returns a compact 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.
Return Type
- Inline_response_201|error - Custom field successfully created.
get custom_fields/[string custom_field_gid]
function get custom_fields/[string custom_field_gid](boolean? opt_pretty, ("asana_created_field"|"created_by"|"created_by.name"|"currency_code"|"custom_label"|"custom_label_position"|"date_value"|"date_value.date"|"date_value.date_time"|"description"|"display_value"|"enabled"|"enum_options"|"enum_options.color"|"enum_options.enabled"|"enum_options.name"|"enum_value"|"enum_value.color"|"enum_value.enabled"|"enum_value.name"|"format"|"has_notifications_enabled"|"id_prefix"|"is_formula_field"|"is_global_to_workspace"|"is_value_read_only"|"multi_enum_values"|"multi_enum_values.color"|"multi_enum_values.enabled"|"multi_enum_values.name"|"name"|"number_value"|"people_value"|"people_value.name"|"precision"|"representation_type"|"resource_subtype"|"text_value"|"type")[]? opt_fields) returns Inline_response_201|error
Get a custom field
Parameters
- opt_pretty boolean? (default ()) - 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 ("asana_created_field"|"created_by"|"created_by.name"|"currency_code"|"custom_label"|"custom_label_position"|"date_value"|"date_value.date"|"date_value.date_time"|"description"|"display_value"|"enabled"|"enum_options"|"enum_options.color"|"enum_options.enabled"|"enum_options.name"|"enum_value"|"enum_value.color"|"enum_value.enabled"|"enum_value.name"|"format"|"has_notifications_enabled"|"id_prefix"|"is_formula_field"|"is_global_to_workspace"|"is_value_read_only"|"multi_enum_values"|"multi_enum_values.color"|"multi_enum_values.enabled"|"multi_enum_values.name"|"name"|"number_value"|"people_value"|"people_value.name"|"precision"|"representation_type"|"resource_subtype"|"text_value"|"type")[]? (default ()) - This endpoint returns a compact 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.
Return Type
- Inline_response_201|error - Successfully retrieved the complete definition of a custom field’s metadata.
put custom_fields/[string custom_field_gid]
function put custom_fields/[string custom_field_gid](Custom_fields_custom_field_gid_body payload, boolean? opt_pretty, ("asana_created_field"|"created_by"|"created_by.name"|"currency_code"|"custom_label"|"custom_label_position"|"date_value"|"date_value.date"|"date_value.date_time"|"description"|"display_value"|"enabled"|"enum_options"|"enum_options.color"|"enum_options.enabled"|"enum_options.name"|"enum_value"|"enum_value.color"|"enum_value.enabled"|"enum_value.name"|"format"|"has_notifications_enabled"|"id_prefix"|"is_formula_field"|"is_global_to_workspace"|"is_value_read_only"|"multi_enum_values"|"multi_enum_values.color"|"multi_enum_values.enabled"|"multi_enum_values.name"|"name"|"number_value"|"people_value"|"people_value.name"|"precision"|"representation_type"|"resource_subtype"|"text_value"|"type")[]? opt_fields) returns Inline_response_201|error
Update a custom field
Parameters
- payload Custom_fields_custom_field_gid_body - The custom field object with all updated properties.
- opt_pretty boolean? (default ()) - 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 ("asana_created_field"|"created_by"|"created_by.name"|"currency_code"|"custom_label"|"custom_label_position"|"date_value"|"date_value.date"|"date_value.date_time"|"description"|"display_value"|"enabled"|"enum_options"|"enum_options.color"|"enum_options.enabled"|"enum_options.name"|"enum_value"|"enum_value.color"|"enum_value.enabled"|"enum_value.name"|"format"|"has_notifications_enabled"|"id_prefix"|"is_formula_field"|"is_global_to_workspace"|"is_value_read_only"|"multi_enum_values"|"multi_enum_values.color"|"multi_enum_values.enabled"|"multi_enum_values.name"|"name"|"number_value"|"people_value"|"people_value.name"|"precision"|"representation_type"|"resource_subtype"|"text_value"|"type")[]? (default ()) - This endpoint returns a compact 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.
Return Type
- Inline_response_201|error - The custom field was successfully updated.
delete custom_fields/[string custom_field_gid]
function delete custom_fields/[string custom_field_gid](boolean? opt_pretty) returns Inline_response_200_1|error
Delete a custom field
Parameters
- opt_pretty boolean? (default ()) - 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.
Return Type
- Inline_response_200_1|error - The custom field was successfully deleted.
get workspaces/[string workspace_gid]/custom_fields
function get workspaces/[string workspace_gid]/custom_fields(boolean? opt_pretty, int? 'limit, string? offset, ("asana_created_field"|"created_by"|"created_by.name"|"currency_code"|"custom_label"|"custom_label_position"|"date_value"|"date_value.date"|"date_value.date_time"|"description"|"display_value"|"enabled"|"enum_options"|"enum_options.color"|"enum_options.enabled"|"enum_options.name"|"enum_value"|"enum_value.color"|"enum_value.enabled"|"enum_value.name"|"format"|"has_notifications_enabled"|"id_prefix"|"is_formula_field"|"is_global_to_workspace"|"is_value_read_only"|"multi_enum_values"|"multi_enum_values.color"|"multi_enum_values.enabled"|"multi_enum_values.name"|"name"|"number_value"|"offset"|"path"|"people_value"|"people_value.name"|"precision"|"representation_type"|"resource_subtype"|"text_value"|"type"|"uri")[]? opt_fields) returns Inline_response_200_6|error
Get a workspace's custom fields
Parameters
- opt_pretty boolean? (default ()) - 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.
- 'limit int? (default ()) - Results per page. The number of objects to return per page. The value must be between 1 and 100.
- offset string? (default ()) - Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.'
- opt_fields ("asana_created_field"|"created_by"|"created_by.name"|"currency_code"|"custom_label"|"custom_label_position"|"date_value"|"date_value.date"|"date_value.date_time"|"description"|"display_value"|"enabled"|"enum_options"|"enum_options.color"|"enum_options.enabled"|"enum_options.name"|"enum_value"|"enum_value.color"|"enum_value.enabled"|"enum_value.name"|"format"|"has_notifications_enabled"|"id_prefix"|"is_formula_field"|"is_global_to_workspace"|"is_value_read_only"|"multi_enum_values"|"multi_enum_values.color"|"multi_enum_values.enabled"|"multi_enum_values.name"|"name"|"number_value"|"offset"|"path"|"people_value"|"people_value.name"|"precision"|"representation_type"|"resource_subtype"|"text_value"|"type"|"uri")[]? (default ()) - This endpoint returns a compact 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.
Return Type
- Inline_response_200_6|error - Successfully retrieved all custom fields for the given workspace.
post custom_fields/[string custom_field_gid]/enum_options
function post custom_fields/[string custom_field_gid]/enum_options(Custom_field_gid_enum_options_body payload, boolean? opt_pretty, ("color"|"enabled"|"name")[]? opt_fields) returns Inline_response_201_1|error
Create an enum option
Parameters
- payload Custom_field_gid_enum_options_body - The enum option object to create.
- opt_pretty boolean? (default ()) - 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 ("color"|"enabled"|"name")[]? (default ()) - This endpoint returns a compact 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.
Return Type
- Inline_response_201_1|error - Custom field enum option successfully created.
post custom_fields/[string custom_field_gid]/enum_options/insert
function post custom_fields/[string custom_field_gid]/enum_options/insert(Enum_options_insert_body payload, boolean? opt_pretty, ("color"|"enabled"|"name")[]? opt_fields) returns Inline_response_201_1|error
Reorder a custom field's enum
Parameters
- payload Enum_options_insert_body - The enum option object to create.
- opt_pretty boolean? (default ()) - 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 ("color"|"enabled"|"name")[]? (default ()) - This endpoint returns a compact 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.
Return Type
- Inline_response_201_1|error - Custom field enum option successfully reordered.
put enum_options/[string enum_option_gid]
function put enum_options/[string enum_option_gid](Enum_options_enum_option_gid_body payload, boolean? opt_pretty, ("color"|"enabled"|"name")[]? opt_fields) returns Inline_response_201_1|error
Update an enum option
Parameters
- payload Enum_options_enum_option_gid_body - The enum option object to update
- opt_pretty boolean? (default ()) - 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 ("color"|"enabled"|"name")[]? (default ()) - This endpoint returns a compact 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.
Return Type
- Inline_response_201_1|error - Successfully updated the specified custom field enum.
get events
function get events(string 'resource, string? sync, boolean? opt_pretty, ("action"|"change"|"change.action"|"change.added_value"|"change.field"|"change.new_value"|"change.removed_value"|"created_at"|"parent"|"parent.name"|"resource"|"resource.name"|"type"|"user"|"user.name")[]? opt_fields) returns Inline_response_200_7|error
Get events on a resource
Parameters
- 'resource string - A resource ID to subscribe to. The resource can be a task, project, or goal.
- sync string? (default ()) - A sync token received from the last request, or none on first sync. Events will be returned from the point in time that the sync token was generated.
Note: On your first request, omit the sync token. The response will be the same as for an expired sync token, and will include a new valid sync token.If the sync token is too old (which may happen from time to time) the API will return a
412 Precondition Failed
error, and include a fresh sync token in the response.
- opt_pretty boolean? (default ()) - 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 ("action"|"change"|"change.action"|"change.added_value"|"change.field"|"change.new_value"|"change.removed_value"|"created_at"|"parent"|"parent.name"|"resource"|"resource.name"|"type"|"user"|"user.name")[]? (default ()) - This endpoint returns a compact 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.
Return Type
- Inline_response_200_7|error - Successfully retrieved events.
get goal_relationships/[string goal_relationship_gid]
function get goal_relationships/[string goal_relationship_gid](boolean? opt_pretty, ("contribution_weight"|"resource_subtype"|"supported_goal"|"supported_goal.name"|"supported_goal.owner"|"supported_goal.owner.name"|"supporting_resource"|"supporting_resource.name")[]? opt_fields) returns Inline_response_200_8|error
Get a goal relationship
Parameters
- opt_pretty boolean? (default ()) - 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 ("contribution_weight"|"resource_subtype"|"supported_goal"|"supported_goal.name"|"supported_goal.owner"|"supported_goal.owner.name"|"supporting_resource"|"supporting_resource.name")[]? (default ()) - This endpoint returns a compact 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.
Return Type
- Inline_response_200_8|error - Successfully retrieved the record for the goal relationship.
put goal_relationships/[string goal_relationship_gid]
function put goal_relationships/[string goal_relationship_gid](Goal_relationships_goal_relationship_gid_body payload, boolean? opt_pretty, ("contribution_weight"|"resource_subtype"|"supported_goal"|"supported_goal.name"|"supported_goal.owner"|"supported_goal.owner.name"|"supporting_resource"|"supporting_resource.name")[]? opt_fields) returns Inline_response_200_8|error
Update a goal relationship
Parameters
- payload Goal_relationships_goal_relationship_gid_body - The updated fields for the goal relationship.
- opt_pretty boolean? (default ()) - 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 ("contribution_weight"|"resource_subtype"|"supported_goal"|"supported_goal.name"|"supported_goal.owner"|"supported_goal.owner.name"|"supporting_resource"|"supporting_resource.name")[]? (default ()) - This endpoint returns a compact 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.
Return Type
- Inline_response_200_8|error - Successfully updated the goal relationship.
get goal_relationships
function get goal_relationships(string supported_goal, boolean? opt_pretty, int? 'limit, string? offset, string? resource_subtype, ("contribution_weight"|"offset"|"path"|"resource_subtype"|"supported_goal"|"supported_goal.name"|"supported_goal.owner"|"supported_goal.owner.name"|"supporting_resource"|"supporting_resource.name"|"uri")[]? opt_fields) returns Inline_response_200_9|error
Get goal relationships
Parameters
- supported_goal string - Globally unique identifier for the supported goal in the goal relationship.
- opt_pretty boolean? (default ()) - 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.
- 'limit int? (default ()) - Results per page. The number of objects to return per page. The value must be between 1 and 100.
- offset string? (default ()) - Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.'
- resource_subtype string? (default ()) - If provided, filter to goal relationships with a given resource_subtype.
- opt_fields ("contribution_weight"|"offset"|"path"|"resource_subtype"|"supported_goal"|"supported_goal.name"|"supported_goal.owner"|"supported_goal.owner.name"|"supporting_resource"|"supporting_resource.name"|"uri")[]? (default ()) - This endpoint returns a compact 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.
Return Type
- Inline_response_200_9|error - Successfully retrieved the requested goal relationships.
post goals/[string goal_gid]/addSupportingRelationship
function post goals/[string goal_gid]/addSupportingRelationship(Goal_gid_addSupportingRelationship_body payload, boolean? opt_pretty, ("contribution_weight"|"resource_subtype"|"supported_goal"|"supported_goal.name"|"supported_goal.owner"|"supported_goal.owner.name"|"supporting_resource"|"supporting_resource.name")[]? opt_fields) returns Inline_response_200_8|error
Add a supporting goal relationship
Parameters
- payload Goal_gid_addSupportingRelationship_body - The supporting resource to be added to the goal
- opt_pretty boolean? (default ()) - 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 ("contribution_weight"|"resource_subtype"|"supported_goal"|"supported_goal.name"|"supported_goal.owner"|"supported_goal.owner.name"|"supporting_resource"|"supporting_resource.name")[]? (default ()) - This endpoint returns a compact 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.
Return Type
- Inline_response_200_8|error - Successfully created the goal relationship.
post goals/[string goal_gid]/removeSupportingRelationship
function post goals/[string goal_gid]/removeSupportingRelationship(Goal_gid_removeSupportingRelationship_body payload, boolean? opt_pretty) returns Inline_response_200_1|error
Removes a supporting goal relationship
Parameters
- payload Goal_gid_removeSupportingRelationship_body - The supporting resource to be removed from the goal
- opt_pretty boolean? (default ()) - 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.
Return Type
- Inline_response_200_1|error - Successfully removed the goal relationship.
get goals/[string goal_gid]
function get goals/[string goal_gid](boolean? opt_pretty, ("current_status_update"|"current_status_update.resource_subtype"|"current_status_update.title"|"due_on"|"followers"|"followers.name"|"html_notes"|"is_workspace_level"|"liked"|"likes"|"likes.user"|"likes.user.name"|"metric"|"metric.can_manage"|"metric.currency_code"|"metric.current_display_value"|"metric.current_number_value"|"metric.initial_number_value"|"metric.precision"|"metric.progress_source"|"metric.resource_subtype"|"metric.target_number_value"|"metric.unit"|"name"|"notes"|"num_likes"|"owner"|"owner.name"|"start_on"|"status"|"team"|"team.name"|"time_period"|"time_period.display_name"|"time_period.end_on"|"time_period.period"|"time_period.start_on"|"workspace"|"workspace.name")[]? opt_fields) returns Inline_response_200_10|error
Get a goal
Parameters
- opt_pretty boolean? (default ()) - 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 ("current_status_update"|"current_status_update.resource_subtype"|"current_status_update.title"|"due_on"|"followers"|"followers.name"|"html_notes"|"is_workspace_level"|"liked"|"likes"|"likes.user"|"likes.user.name"|"metric"|"metric.can_manage"|"metric.currency_code"|"metric.current_display_value"|"metric.current_number_value"|"metric.initial_number_value"|"metric.precision"|"metric.progress_source"|"metric.resource_subtype"|"metric.target_number_value"|"metric.unit"|"name"|"notes"|"num_likes"|"owner"|"owner.name"|"start_on"|"status"|"team"|"team.name"|"time_period"|"time_period.display_name"|"time_period.end_on"|"time_period.period"|"time_period.start_on"|"workspace"|"workspace.name")[]? (default ()) - This endpoint returns a compact 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.
Return Type
- Inline_response_200_10|error - Successfully retrieved the record for a single goal.
put goals/[string goal_gid]
function put goals/[string goal_gid](Goals_goal_gid_body payload, boolean? opt_pretty, ("current_status_update"|"current_status_update.resource_subtype"|"current_status_update.title"|"due_on"|"followers"|"followers.name"|"html_notes"|"is_workspace_level"|"liked"|"likes"|"likes.user"|"likes.user.name"|"metric"|"metric.can_manage"|"metric.currency_code"|"metric.current_display_value"|"metric.current_number_value"|"metric.initial_number_value"|"metric.precision"|"metric.progress_source"|"metric.resource_subtype"|"metric.target_number_value"|"metric.unit"|"name"|"notes"|"num_likes"|"owner"|"owner.name"|"start_on"|"status"|"team"|"team.name"|"time_period"|"time_period.display_name"|"time_period.end_on"|"time_period.period"|"time_period.start_on"|"workspace"|"workspace.name")[]? opt_fields) returns Inline_response_200_10|error
Update a goal
Parameters
- payload Goals_goal_gid_body - The updated fields for the goal.
- opt_pretty boolean? (default ()) - 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 ("current_status_update"|"current_status_update.resource_subtype"|"current_status_update.title"|"due_on"|"followers"|"followers.name"|"html_notes"|"is_workspace_level"|"liked"|"likes"|"likes.user"|"likes.user.name"|"metric"|"metric.can_manage"|"metric.currency_code"|"metric.current_display_value"|"metric.current_number_value"|"metric.initial_number_value"|"metric.precision"|"metric.progress_source"|"metric.resource_subtype"|"metric.target_number_value"|"metric.unit"|"name"|"notes"|"num_likes"|"owner"|"owner.name"|"start_on"|"status"|"team"|"team.name"|"time_period"|"time_period.display_name"|"time_period.end_on"|"time_period.period"|"time_period.start_on"|"workspace"|"workspace.name")[]? (default ()) - This endpoint returns a compact 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.
Return Type
- Inline_response_200_10|error - Successfully updated the goal.
delete goals/[string goal_gid]
function delete goals/[string goal_gid](boolean? opt_pretty) returns Inline_response_200_1|error
Delete a goal
Parameters
- opt_pretty boolean? (default ()) - 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.
Return Type
- Inline_response_200_1|error - Successfully deleted the specified goal.
get goals
function get goals(boolean? opt_pretty, string? portfolio, string? project, string? task, boolean? is_workspace_level, string? team, string? workspace, string[]? time_periods, int? 'limit, string? offset, ("current_status_update"|"current_status_update.resource_subtype"|"current_status_update.title"|"due_on"|"followers"|"followers.name"|"html_notes"|"is_workspace_level"|"liked"|"likes"|"likes.user"|"likes.user.name"|"metric"|"metric.can_manage"|"metric.currency_code"|"metric.current_display_value"|"metric.current_number_value"|"metric.initial_number_value"|"metric.precision"|"metric.progress_source"|"metric.resource_subtype"|"metric.target_number_value"|"metric.unit"|"name"|"notes"|"num_likes"|"offset"|"owner"|"owner.name"|"path"|"start_on"|"status"|"team"|"team.name"|"time_period"|"time_period.display_name"|"time_period.end_on"|"time_period.period"|"time_period.start_on"|"uri"|"workspace"|"workspace.name")[]? opt_fields) returns Inline_response_200_11|error
Get goals
Parameters
- opt_pretty boolean? (default ()) - 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.
- portfolio string? (default ()) - Globally unique identifier for supporting portfolio.
- project string? (default ()) - Globally unique identifier for supporting project.
- task string? (default ()) - Globally unique identifier for supporting task.
- is_workspace_level boolean? (default ()) - Filter to goals with is_workspace_level set to query value. Must be used with the workspace parameter.
- team string? (default ()) - Globally unique identifier for the team.
- workspace string? (default ()) - Globally unique identifier for the workspace.
- time_periods string[]? (default ()) - Globally unique identifiers for the time periods.
- 'limit int? (default ()) - Results per page. The number of objects to return per page. The value must be between 1 and 100.
- offset string? (default ()) - Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.'
- opt_fields ("current_status_update"|"current_status_update.resource_subtype"|"current_status_update.title"|"due_on"|"followers"|"followers.name"|"html_notes"|"is_workspace_level"|"liked"|"likes"|"likes.user"|"likes.user.name"|"metric"|"metric.can_manage"|"metric.currency_code"|"metric.current_display_value"|"metric.current_number_value"|"metric.initial_number_value"|"metric.precision"|"metric.progress_source"|"metric.resource_subtype"|"metric.target_number_value"|"metric.unit"|"name"|"notes"|"num_likes"|"offset"|"owner"|"owner.name"|"path"|"start_on"|"status"|"team"|"team.name"|"time_period"|"time_period.display_name"|"time_period.end_on"|"time_period.period"|"time_period.start_on"|"uri"|"workspace"|"workspace.name")[]? (default ()) - This endpoint returns a compact 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.
Return Type
- Inline_response_200_11|error - Successfully retrieved the requested goals.
post goals
function post goals(Goals_body payload, boolean? opt_pretty, ("current_status_update"|"current_status_update.resource_subtype"|"current_status_update.title"|"due_on"|"followers"|"followers.name"|"html_notes"|"is_workspace_level"|"liked"|"likes"|"likes.user"|"likes.user.name"|"metric"|"metric.can_manage"|"metric.currency_code"|"metric.current_display_value"|"metric.current_number_value"|"metric.initial_number_value"|"metric.precision"|"metric.progress_source"|"metric.resource_subtype"|"metric.target_number_value"|"metric.unit"|"name"|"notes"|"num_likes"|"owner"|"owner.name"|"start_on"|"status"|"team"|"team.name"|"time_period"|"time_period.display_name"|"time_period.end_on"|"time_period.period"|"time_period.start_on"|"workspace"|"workspace.name")[]? opt_fields) returns Inline_response_200_10|error
Create a goal
Parameters
- payload Goals_body - The goal to create.
- opt_pretty boolean? (default ()) - 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 ("current_status_update"|"current_status_update.resource_subtype"|"current_status_update.title"|"due_on"|"followers"|"followers.name"|"html_notes"|"is_workspace_level"|"liked"|"likes"|"likes.user"|"likes.user.name"|"metric"|"metric.can_manage"|"metric.currency_code"|"metric.current_display_value"|"metric.current_number_value"|"metric.initial_number_value"|"metric.precision"|"metric.progress_source"|"metric.resource_subtype"|"metric.target_number_value"|"metric.unit"|"name"|"notes"|"num_likes"|"owner"|"owner.name"|"start_on"|"status"|"team"|"team.name"|"time_period"|"time_period.display_name"|"time_period.end_on"|"time_period.period"|"time_period.start_on"|"workspace"|"workspace.name")[]? (default ()) - This endpoint returns a compact 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.
Return Type
- Inline_response_200_10|error - Successfully created a new goal.
post goals/[string goal_gid]/setMetric
function post goals/[string goal_gid]/setMetric(Goal_gid_setMetric_body payload, boolean? opt_pretty, ("current_status_update"|"current_status_update.resource_subtype"|"current_status_update.title"|"due_on"|"followers"|"followers.name"|"html_notes"|"is_workspace_level"|"liked"|"likes"|"likes.user"|"likes.user.name"|"metric"|"metric.can_manage"|"metric.currency_code"|"metric.current_display_value"|"metric.current_number_value"|"metric.initial_number_value"|"metric.precision"|"metric.progress_source"|"metric.resource_subtype"|"metric.target_number_value"|"metric.unit"|"name"|"notes"|"num_likes"|"owner"|"owner.name"|"start_on"|"status"|"team"|"team.name"|"time_period"|"time_period.display_name"|"time_period.end_on"|"time_period.period"|"time_period.start_on"|"workspace"|"workspace.name")[]? opt_fields) returns Inline_response_200_10|error
Create a goal metric
Parameters
- payload Goal_gid_setMetric_body - The goal metric to create.
- opt_pretty boolean? (default ()) - 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 ("current_status_update"|"current_status_update.resource_subtype"|"current_status_update.title"|"due_on"|"followers"|"followers.name"|"html_notes"|"is_workspace_level"|"liked"|"likes"|"likes.user"|"likes.user.name"|"metric"|"metric.can_manage"|"metric.currency_code"|"metric.current_display_value"|"metric.current_number_value"|"metric.initial_number_value"|"metric.precision"|"metric.progress_source"|"metric.resource_subtype"|"metric.target_number_value"|"metric.unit"|"name"|"notes"|"num_likes"|"owner"|"owner.name"|"start_on"|"status"|"team"|"team.name"|"time_period"|"time_period.display_name"|"time_period.end_on"|"time_period.period"|"time_period.start_on"|"workspace"|"workspace.name")[]? (default ()) - This endpoint returns a compact 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.
Return Type
- Inline_response_200_10|error - Successfully created a new goal metric.
post goals/[string goal_gid]/setMetricCurrentValue
function post goals/[string goal_gid]/setMetricCurrentValue(Goal_gid_setMetricCurrentValue_body payload, boolean? opt_pretty, ("current_status_update"|"current_status_update.resource_subtype"|"current_status_update.title"|"due_on"|"followers"|"followers.name"|"html_notes"|"is_workspace_level"|"liked"|"likes"|"likes.user"|"likes.user.name"|"metric"|"metric.can_manage"|"metric.currency_code"|"metric.current_display_value"|"metric.current_number_value"|"metric.initial_number_value"|"metric.precision"|"metric.progress_source"|"metric.resource_subtype"|"metric.target_number_value"|"metric.unit"|"name"|"notes"|"num_likes"|"owner"|"owner.name"|"start_on"|"status"|"team"|"team.name"|"time_period"|"time_period.display_name"|"time_period.end_on"|"time_period.period"|"time_period.start_on"|"workspace"|"workspace.name")[]? opt_fields) returns Inline_response_200_10|error
Update a goal metric
Parameters
- payload Goal_gid_setMetricCurrentValue_body - The updated fields for the goal metric.
- opt_pretty boolean? (default ()) - 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 ("current_status_update"|"current_status_update.resource_subtype"|"current_status_update.title"|"due_on"|"followers"|"followers.name"|"html_notes"|"is_workspace_level"|"liked"|"likes"|"likes.user"|"likes.user.name"|"metric"|"metric.can_manage"|"metric.currency_code"|"metric.current_display_value"|"metric.current_number_value"|"metric.initial_number_value"|"metric.precision"|"metric.progress_source"|"metric.resource_subtype"|"metric.target_number_value"|"metric.unit"|"name"|"notes"|"num_likes"|"owner"|"owner.name"|"start_on"|"status"|"team"|"team.name"|"time_period"|"time_period.display_name"|"time_period.end_on"|"time_period.period"|"time_period.start_on"|"workspace"|"workspace.name")[]? (default ()) - This endpoint returns a compact 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.
Return Type
- Inline_response_200_10|error - Successfully updated the goal metric.
post goals/[string goal_gid]/addFollowers
function post goals/[string goal_gid]/addFollowers(Goal_gid_addFollowers_body payload, boolean? opt_pretty, ("current_status_update"|"current_status_update.resource_subtype"|"current_status_update.title"|"due_on"|"followers"|"followers.name"|"html_notes"|"is_workspace_level"|"liked"|"likes"|"likes.user"|"likes.user.name"|"metric"|"metric.can_manage"|"metric.currency_code"|"metric.current_display_value"|"metric.current_number_value"|"metric.initial_number_value"|"metric.precision"|"metric.progress_source"|"metric.resource_subtype"|"metric.target_number_value"|"metric.unit"|"name"|"notes"|"num_likes"|"owner"|"owner.name"|"start_on"|"status"|"team"|"team.name"|"time_period"|"time_period.display_name"|"time_period.end_on"|"time_period.period"|"time_period.start_on"|"workspace"|"workspace.name")[]? opt_fields) returns Inline_response_200_10|error
Add a collaborator to a goal
Parameters
- payload Goal_gid_addFollowers_body - The followers to be added as collaborators
- opt_pretty boolean? (default ()) - 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 ("current_status_update"|"current_status_update.resource_subtype"|"current_status_update.title"|"due_on"|"followers"|"followers.name"|"html_notes"|"is_workspace_level"|"liked"|"likes"|"likes.user"|"likes.user.name"|"metric"|"metric.can_manage"|"metric.currency_code"|"metric.current_display_value"|"metric.current_number_value"|"metric.initial_number_value"|"metric.precision"|"metric.progress_source"|"metric.resource_subtype"|"metric.target_number_value"|"metric.unit"|"name"|"notes"|"num_likes"|"owner"|"owner.name"|"start_on"|"status"|"team"|"team.name"|"time_period"|"time_period.display_name"|"time_period.end_on"|"time_period.period"|"time_period.start_on"|"workspace"|"workspace.name")[]? (default ()) - This endpoint returns a compact 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.
Return Type
- Inline_response_200_10|error - Successfully added users as collaborators.
post goals/[string goal_gid]/removeFollowers
function post goals/[string goal_gid]/removeFollowers(Goal_gid_removeFollowers_body payload, boolean? opt_pretty, ("current_status_update"|"current_status_update.resource_subtype"|"current_status_update.title"|"due_on"|"followers"|"followers.name"|"html_notes"|"is_workspace_level"|"liked"|"likes"|"likes.user"|"likes.user.name"|"metric"|"metric.can_manage"|"metric.currency_code"|"metric.current_display_value"|"metric.current_number_value"|"metric.initial_number_value"|"metric.precision"|"metric.progress_source"|"metric.resource_subtype"|"metric.target_number_value"|"metric.unit"|"name"|"notes"|"num_likes"|"owner"|"owner.name"|"start_on"|"status"|"team"|"team.name"|"time_period"|"time_period.display_name"|"time_period.end_on"|"time_period.period"|"time_period.start_on"|"workspace"|"workspace.name")[]? opt_fields) returns Inline_response_200_10|error
Remove a collaborator from a goal
Parameters
- payload Goal_gid_removeFollowers_body - The followers to be removed as collaborators
- opt_pretty boolean? (default ()) - 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 ("current_status_update"|"current_status_update.resource_subtype"|"current_status_update.title"|"due_on"|"followers"|"followers.name"|"html_notes"|"is_workspace_level"|"liked"|"likes"|"likes.user"|"likes.user.name"|"metric"|"metric.can_manage"|"metric.currency_code"|"metric.current_display_value"|"metric.current_number_value"|"metric.initial_number_value"|"metric.precision"|"metric.progress_source"|"metric.resource_subtype"|"metric.target_number_value"|"metric.unit"|"name"|"notes"|"num_likes"|"owner"|"owner.name"|"start_on"|"status"|"team"|"team.name"|"time_period"|"time_period.display_name"|"time_period.end_on"|"time_period.period"|"time_period.start_on"|"workspace"|"workspace.name")[]? (default ()) - This endpoint returns a compact 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.
Return Type
- Inline_response_200_10|error - Successfully removed users as collaborators.
get goals/[string goal_gid]/parentGoals
function get goals/[string goal_gid]/parentGoals(boolean? opt_pretty, ("current_status_update"|"current_status_update.resource_subtype"|"current_status_update.title"|"due_on"|"followers"|"followers.name"|"html_notes"|"is_workspace_level"|"liked"|"likes"|"likes.user"|"likes.user.name"|"metric"|"metric.can_manage"|"metric.currency_code"|"metric.current_display_value"|"metric.current_number_value"|"metric.initial_number_value"|"metric.precision"|"metric.progress_source"|"metric.resource_subtype"|"metric.target_number_value"|"metric.unit"|"name"|"notes"|"num_likes"|"owner"|"owner.name"|"start_on"|"status"|"team"|"team.name"|"time_period"|"time_period.display_name"|"time_period.end_on"|"time_period.period"|"time_period.start_on"|"workspace"|"workspace.name")[]? opt_fields) returns Inline_response_200_12|error
Get parent goals from a goal
Parameters
- opt_pretty boolean? (default ()) - 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 ("current_status_update"|"current_status_update.resource_subtype"|"current_status_update.title"|"due_on"|"followers"|"followers.name"|"html_notes"|"is_workspace_level"|"liked"|"likes"|"likes.user"|"likes.user.name"|"metric"|"metric.can_manage"|"metric.currency_code"|"metric.current_display_value"|"metric.current_number_value"|"metric.initial_number_value"|"metric.precision"|"metric.progress_source"|"metric.resource_subtype"|"metric.target_number_value"|"metric.unit"|"name"|"notes"|"num_likes"|"owner"|"owner.name"|"start_on"|"status"|"team"|"team.name"|"time_period"|"time_period.display_name"|"time_period.end_on"|"time_period.period"|"time_period.start_on"|"workspace"|"workspace.name")[]? (default ()) - This endpoint returns a compact 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.
Return Type
- Inline_response_200_12|error - Successfully retrieved the specified goal's parent goals.
get jobs/[string job_gid]
function get jobs/[string job_gid](boolean? opt_pretty, ("new_project"|"new_project.name"|"new_project_template"|"new_project_template.name"|"new_task"|"new_task.created_by"|"new_task.name"|"new_task.resource_subtype"|"new_task_template"|"new_task_template.name"|"resource_subtype"|"status")[]? opt_fields) returns Inline_response_200_13|error
Get a job by id
Parameters
- opt_pretty boolean? (default ()) - 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 ("new_project"|"new_project.name"|"new_project_template"|"new_project_template.name"|"new_task"|"new_task.created_by"|"new_task.name"|"new_task.resource_subtype"|"new_task_template"|"new_task_template.name"|"resource_subtype"|"status")[]? (default ()) - This endpoint returns a compact 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.
Return Type
- Inline_response_200_13|error - Successfully retrieved Job.
get memberships
function get memberships(boolean? opt_pretty, string? parent, string? member, int? 'limit, string? offset, ("offset"|"path"|"uri")[]? opt_fields) returns Inline_response_200_14|error
Get multiple memberships
Parameters
- opt_pretty boolean? (default ()) - 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.
- parent string? (default ()) - Globally unique identifier for
goal
orproject
.
- member string? (default ()) - Globally unique identifier for
team
oruser
.
- 'limit int? (default ()) - Results per page. The number of objects to return per page. The value must be between 1 and 100.
- offset string? (default ()) - Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.'
- opt_fields ("offset"|"path"|"uri")[]? (default ()) - This endpoint returns a compact 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.
Return Type
- Inline_response_200_14|error - Successfully retrieved the requested membership.
post memberships
function post memberships(Memberships_body payload, boolean? opt_pretty) returns Inline_response_201_2|error
Create a membership
Parameters
- payload Memberships_body - The updated fields for the membership.
- opt_pretty boolean? (default ()) - 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.
Return Type
- Inline_response_201_2|error - Successfully created the requested membership.
get memberships/[string membership_gid]
function get memberships/[string membership_gid](boolean? opt_pretty, ("access_level"|"member"|"member.name"|"parent"|"parent.name"|"resource_subtype")[]? opt_fields) returns Inline_response_200_15|error
Get a membership
Parameters
- opt_pretty boolean? (default ()) - 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 ("access_level"|"member"|"member.name"|"parent"|"parent.name"|"resource_subtype")[]? (default ()) - This endpoint returns a compact 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.
Return Type
- Inline_response_200_15|error - Successfully retrieved the record for a single membership.
put memberships/[string membership_gid]
function put memberships/[string membership_gid](Memberships_membership_gid_body payload, boolean? opt_pretty) returns Inline_response_201_2|error
Update a membership
Parameters
- payload Memberships_membership_gid_body - The membership to update.
- opt_pretty boolean? (default ()) - 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.
Return Type
- Inline_response_201_2|error - Successfully updated the requested membership.
delete memberships/[string membership_gid]
function delete memberships/[string membership_gid](boolean? opt_pretty) returns Inline_response_200_1|error
Delete a membership
Parameters
- opt_pretty boolean? (default ()) - 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.
Return Type
- Inline_response_200_1|error - Successfully deleted the requested membership.
post organization_exports
function post organization_exports(Organization_exports_body payload, boolean? opt_pretty, ("created_at"|"download_url"|"organization"|"organization.name"|"state")[]? opt_fields) returns Inline_response_201_3|error
Create an organization export request
Parameters
- payload Organization_exports_body - The organization to export.
- opt_pretty boolean? (default ()) - 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 ("created_at"|"download_url"|"organization"|"organization.name"|"state")[]? (default ()) - This endpoint returns a compact 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.
Return Type
- Inline_response_201_3|error - Successfully created organization export request.
get organization_exports/[string organization_export_gid]
function get organization_exports/[string organization_export_gid](boolean? opt_pretty, ("created_at"|"download_url"|"organization"|"organization.name"|"state")[]? opt_fields) returns Inline_response_201_3|error
Get details on an org export request
Parameters
- opt_pretty boolean? (default ()) - 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 ("created_at"|"download_url"|"organization"|"organization.name"|"state")[]? (default ()) - This endpoint returns a compact 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.
Return Type
- Inline_response_201_3|error - Successfully retrieved organization export object.
get portfolio_memberships
function get portfolio_memberships(string? portfolio, string? workspace, string? user, boolean? opt_pretty, int? 'limit, string? offset, ("offset"|"path"|"portfolio"|"portfolio.name"|"uri"|"user"|"user.name")[]? opt_fields) returns Inline_response_200_16|error
Get multiple portfolio memberships
Parameters
- portfolio string? (default ()) - The portfolio to filter results on.
- workspace string? (default ()) - The workspace to filter results on.
- user string? (default ()) - A string identifying a user. This can either be the string "me", an email, or the gid of a user.
- opt_pretty boolean? (default ()) - 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.
- 'limit int? (default ()) - Results per page. The number of objects to return per page. The value must be between 1 and 100.
- offset string? (default ()) - Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.'
- opt_fields ("offset"|"path"|"portfolio"|"portfolio.name"|"uri"|"user"|"user.name")[]? (default ()) - This endpoint returns a compact 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.
Return Type
- Inline_response_200_16|error - Successfully retrieved portfolio memberships.
get portfolio_memberships/[string portfolio_membership_gid]
function get portfolio_memberships/[string portfolio_membership_gid](boolean? opt_pretty, ("portfolio"|"portfolio.name"|"user"|"user.name")[]? opt_fields) returns Inline_response_200_17|error
Get a portfolio membership
Parameters
- opt_pretty boolean? (default ()) - 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 ("portfolio"|"portfolio.name"|"user"|"user.name")[]? (default ()) - This endpoint returns a compact 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.
Return Type
- Inline_response_200_17|error - Successfully retrieved the requested portfolio membership.
get portfolios/[string portfolio_gid]/portfolio_memberships
function get portfolios/[string portfolio_gid]/portfolio_memberships(string? user, boolean? opt_pretty, int? 'limit, string? offset, ("offset"|"path"|"portfolio"|"portfolio.name"|"uri"|"user"|"user.name")[]? opt_fields) returns Inline_response_200_16|error
Get memberships from a portfolio
Parameters
- user string? (default ()) - A string identifying a user. This can either be the string "me", an email, or the gid of a user.
- opt_pretty boolean? (default ()) - 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.
- 'limit int? (default ()) - Results per page. The number of objects to return per page. The value must be between 1 and 100.
- offset string? (default ()) - Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.'
- opt_fields ("offset"|"path"|"portfolio"|"portfolio.name"|"uri"|"user"|"user.name")[]? (default ()) - This endpoint returns a compact 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.
Return Type
- Inline_response_200_16|error - Successfully retrieved the requested portfolio's memberships.
get portfolios
function get portfolios(string workspace, boolean? opt_pretty, int? 'limit, string? offset, string? owner, ("color"|"created_at"|"created_by"|"created_by.name"|"current_status_update"|"current_status_update.resource_subtype"|"current_status_update.title"|"custom_field_settings"|"custom_field_settings.custom_field"|"custom_field_settings.custom_field.asana_created_field"|"custom_field_settings.custom_field.created_by"|"custom_field_settings.custom_field.created_by.name"|"custom_field_settings.custom_field.currency_code"|"custom_field_settings.custom_field.custom_label"|"custom_field_settings.custom_field.custom_label_position"|"custom_field_settings.custom_field.date_value"|"custom_field_settings.custom_field.date_value.date"|"custom_field_settings.custom_field.date_value.date_time"|"custom_field_settings.custom_field.description"|"custom_field_settings.custom_field.display_value"|"custom_field_settings.custom_field.enabled"|"custom_field_settings.custom_field.enum_options"|"custom_field_settings.custom_field.enum_options.color"|"custom_field_settings.custom_field.enum_options.enabled"|"custom_field_settings.custom_field.enum_options.name"|"custom_field_settings.custom_field.enum_value"|"custom_field_settings.custom_field.enum_value.color"|"custom_field_settings.custom_field.enum_value.enabled"|"custom_field_settings.custom_field.enum_value.name"|"custom_field_settings.custom_field.format"|"custom_field_settings.custom_field.has_notifications_enabled"|"custom_field_settings.custom_field.id_prefix"|"custom_field_settings.custom_field.is_formula_field"|"custom_field_settings.custom_field.is_global_to_workspace"|"custom_field_settings.custom_field.is_value_read_only"|"custom_field_settings.custom_field.multi_enum_values"|"custom_field_settings.custom_field.multi_enum_values.color"|"custom_field_settings.custom_field.multi_enum_values.enabled"|"custom_field_settings.custom_field.multi_enum_values.name"|"custom_field_settings.custom_field.name"|"custom_field_settings.custom_field.number_value"|"custom_field_settings.custom_field.people_value"|"custom_field_settings.custom_field.people_value.name"|"custom_field_settings.custom_field.precision"|"custom_field_settings.custom_field.representation_type"|"custom_field_settings.custom_field.resource_subtype"|"custom_field_settings.custom_field.text_value"|"custom_field_settings.custom_field.type"|"custom_field_settings.is_important"|"custom_field_settings.parent"|"custom_field_settings.parent.name"|"custom_field_settings.project"|"custom_field_settings.project.name"|"custom_fields"|"custom_fields.date_value"|"custom_fields.date_value.date"|"custom_fields.date_value.date_time"|"custom_fields.display_value"|"custom_fields.enabled"|"custom_fields.enum_options"|"custom_fields.enum_options.color"|"custom_fields.enum_options.enabled"|"custom_fields.enum_options.name"|"custom_fields.enum_value"|"custom_fields.enum_value.color"|"custom_fields.enum_value.enabled"|"custom_fields.enum_value.name"|"custom_fields.id_prefix"|"custom_fields.is_formula_field"|"custom_fields.multi_enum_values"|"custom_fields.multi_enum_values.color"|"custom_fields.multi_enum_values.enabled"|"custom_fields.multi_enum_values.name"|"custom_fields.name"|"custom_fields.number_value"|"custom_fields.representation_type"|"custom_fields.resource_subtype"|"custom_fields.text_value"|"custom_fields.type"|"due_on"|"members"|"members.name"|"name"|"offset"|"owner"|"owner.name"|"path"|"permalink_url"|"project_templates"|"project_templates.name"|"public"|"start_on"|"uri"|"workspace"|"workspace.name")[]? opt_fields) returns Inline_response_200_18|error
Get multiple portfolios
Parameters
- workspace string - The workspace or organization to filter portfolios on.
- opt_pretty boolean? (default ()) - 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.
- 'limit int? (default ()) - Results per page. The number of objects to return per page. The value must be between 1 and 100.
- offset string? (default ()) - Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.'
- owner string? (default ()) - The user who owns the portfolio. Currently, API users can only get a list of portfolios that they themselves own, unless the request is made from a Service Account. In the case of a Service Account, if this parameter is specified, then all portfolios owned by this parameter are returned. Otherwise, all portfolios across the workspace are returned.
- opt_fields ("color"|"created_at"|"created_by"|"created_by.name"|"current_status_update"|"current_status_update.resource_subtype"|"current_status_update.title"|"custom_field_settings"|"custom_field_settings.custom_field"|"custom_field_settings.custom_field.asana_created_field"|"custom_field_settings.custom_field.created_by"|"custom_field_settings.custom_field.created_by.name"|"custom_field_settings.custom_field.currency_code"|"custom_field_settings.custom_field.custom_label"|"custom_field_settings.custom_field.custom_label_position"|"custom_field_settings.custom_field.date_value"|"custom_field_settings.custom_field.date_value.date"|"custom_field_settings.custom_field.date_value.date_time"|"custom_field_settings.custom_field.description"|"custom_field_settings.custom_field.display_value"|"custom_field_settings.custom_field.enabled"|"custom_field_settings.custom_field.enum_options"|"custom_field_settings.custom_field.enum_options.color"|"custom_field_settings.custom_field.enum_options.enabled"|"custom_field_settings.custom_field.enum_options.name"|"custom_field_settings.custom_field.enum_value"|"custom_field_settings.custom_field.enum_value.color"|"custom_field_settings.custom_field.enum_value.enabled"|"custom_field_settings.custom_field.enum_value.name"|"custom_field_settings.custom_field.format"|"custom_field_settings.custom_field.has_notifications_enabled"|"custom_field_settings.custom_field.id_prefix"|"custom_field_settings.custom_field.is_formula_field"|"custom_field_settings.custom_field.is_global_to_workspace"|"custom_field_settings.custom_field.is_value_read_only"|"custom_field_settings.custom_field.multi_enum_values"|"custom_field_settings.custom_field.multi_enum_values.color"|"custom_field_settings.custom_field.multi_enum_values.enabled"|"custom_field_settings.custom_field.multi_enum_values.name"|"custom_field_settings.custom_field.name"|"custom_field_settings.custom_field.number_value"|"custom_field_settings.custom_field.people_value"|"custom_field_settings.custom_field.people_value.name"|"custom_field_settings.custom_field.precision"|"custom_field_settings.custom_field.representation_type"|"custom_field_settings.custom_field.resource_subtype"|"custom_field_settings.custom_field.text_value"|"custom_field_settings.custom_field.type"|"custom_field_settings.is_important"|"custom_field_settings.parent"|"custom_field_settings.parent.name"|"custom_field_settings.project"|"custom_field_settings.project.name"|"custom_fields"|"custom_fields.date_value"|"custom_fields.date_value.date"|"custom_fields.date_value.date_time"|"custom_fields.display_value"|"custom_fields.enabled"|"custom_fields.enum_options"|"custom_fields.enum_options.color"|"custom_fields.enum_options.enabled"|"custom_fields.enum_options.name"|"custom_fields.enum_value"|"custom_fields.enum_value.color"|"custom_fields.enum_value.enabled"|"custom_fields.enum_value.name"|"custom_fields.id_prefix"|"custom_fields.is_formula_field"|"custom_fields.multi_enum_values"|"custom_fields.multi_enum_values.color"|"custom_fields.multi_enum_values.enabled"|"custom_fields.multi_enum_values.name"|"custom_fields.name"|"custom_fields.number_value"|"custom_fields.representation_type"|"custom_fields.resource_subtype"|"custom_fields.text_value"|"custom_fields.type"|"due_on"|"members"|"members.name"|"name"|"offset"|"owner"|"owner.name"|"path"|"permalink_url"|"project_templates"|"project_templates.name"|"public"|"start_on"|"uri"|"workspace"|"workspace.name")[]? (default ()) - This endpoint returns a compact 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.
Return Type
- Inline_response_200_18|error - Successfully retrieved portfolios.
post portfolios
function post portfolios(Portfolios_body payload, boolean? opt_pretty, ("color"|"created_at"|"created_by"|"created_by.name"|"current_status_update"|"current_status_update.resource_subtype"|"current_status_update.title"|"custom_field_settings"|"custom_field_settings.custom_field"|"custom_field_settings.custom_field.asana_created_field"|"custom_field_settings.custom_field.created_by"|"custom_field_settings.custom_field.created_by.name"|"custom_field_settings.custom_field.currency_code"|"custom_field_settings.custom_field.custom_label"|"custom_field_settings.custom_field.custom_label_position"|"custom_field_settings.custom_field.date_value"|"custom_field_settings.custom_field.date_value.date"|"custom_field_settings.custom_field.date_value.date_time"|"custom_field_settings.custom_field.description"|"custom_field_settings.custom_field.display_value"|"custom_field_settings.custom_field.enabled"|"custom_field_settings.custom_field.enum_options"|"custom_field_settings.custom_field.enum_options.color"|"custom_field_settings.custom_field.enum_options.enabled"|"custom_field_settings.custom_field.enum_options.name"|"custom_field_settings.custom_field.enum_value"|"custom_field_settings.custom_field.enum_value.color"|"custom_field_settings.custom_field.enum_value.enabled"|"custom_field_settings.custom_field.enum_value.name"|"custom_field_settings.custom_field.format"|"custom_field_settings.custom_field.has_notifications_enabled"|"custom_field_settings.custom_field.id_prefix"|"custom_field_settings.custom_field.is_formula_field"|"custom_field_settings.custom_field.is_global_to_workspace"|"custom_field_settings.custom_field.is_value_read_only"|"custom_field_settings.custom_field.multi_enum_values"|"custom_field_settings.custom_field.multi_enum_values.color"|"custom_field_settings.custom_field.multi_enum_values.enabled"|"custom_field_settings.custom_field.multi_enum_values.name"|"custom_field_settings.custom_field.name"|"custom_field_settings.custom_field.number_value"|"custom_field_settings.custom_field.people_value"|"custom_field_settings.custom_field.people_value.name"|"custom_field_settings.custom_field.precision"|"custom_field_settings.custom_field.representation_type"|"custom_field_settings.custom_field.resource_subtype"|"custom_field_settings.custom_field.text_value"|"custom_field_settings.custom_field.type"|"custom_field_settings.is_important"|"custom_field_settings.parent"|"custom_field_settings.parent.name"|"custom_field_settings.project"|"custom_field_settings.project.name"|"custom_fields"|"custom_fields.date_value"|"custom_fields.date_value.date"|"custom_fields.date_value.date_time"|"custom_fields.display_value"|"custom_fields.enabled"|"custom_fields.enum_options"|"custom_fields.enum_options.color"|"custom_fields.enum_options.enabled"|"custom_fields.enum_options.name"|"custom_fields.enum_value"|"custom_fields.enum_value.color"|"custom_fields.enum_value.enabled"|"custom_fields.enum_value.name"|"custom_fields.id_prefix"|"custom_fields.is_formula_field"|"custom_fields.multi_enum_values"|"custom_fields.multi_enum_values.color"|"custom_fields.multi_enum_values.enabled"|"custom_fields.multi_enum_values.name"|"custom_fields.name"|"custom_fields.number_value"|"custom_fields.representation_type"|"custom_fields.resource_subtype"|"custom_fields.text_value"|"custom_fields.type"|"due_on"|"members"|"members.name"|"name"|"owner"|"owner.name"|"permalink_url"|"project_templates"|"project_templates.name"|"public"|"start_on"|"workspace"|"workspace.name")[]? opt_fields) returns Inline_response_201_4|error
Create a portfolio
Parameters
- payload Portfolios_body - The portfolio to create.
- opt_pretty boolean? (default ()) - 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 ("color"|"created_at"|"created_by"|"created_by.name"|"current_status_update"|"current_status_update.resource_subtype"|"current_status_update.title"|"custom_field_settings"|"custom_field_settings.custom_field"|"custom_field_settings.custom_field.asana_created_field"|"custom_field_settings.custom_field.created_by"|"custom_field_settings.custom_field.created_by.name"|"custom_field_settings.custom_field.currency_code"|"custom_field_settings.custom_field.custom_label"|"custom_field_settings.custom_field.custom_label_position"|"custom_field_settings.custom_field.date_value"|"custom_field_settings.custom_field.date_value.date"|"custom_field_settings.custom_field.date_value.date_time"|"custom_field_settings.custom_field.description"|"custom_field_settings.custom_field.display_value"|"custom_field_settings.custom_field.enabled"|"custom_field_settings.custom_field.enum_options"|"custom_field_settings.custom_field.enum_options.color"|"custom_field_settings.custom_field.enum_options.enabled"|"custom_field_settings.custom_field.enum_options.name"|"custom_field_settings.custom_field.enum_value"|"custom_field_settings.custom_field.enum_value.color"|"custom_field_settings.custom_field.enum_value.enabled"|"custom_field_settings.custom_field.enum_value.name"|"custom_field_settings.custom_field.format"|"custom_field_settings.custom_field.has_notifications_enabled"|"custom_field_settings.custom_field.id_prefix"|"custom_field_settings.custom_field.is_formula_field"|"custom_field_settings.custom_field.is_global_to_workspace"|"custom_field_settings.custom_field.is_value_read_only"|"custom_field_settings.custom_field.multi_enum_values"|"custom_field_settings.custom_field.multi_enum_values.color"|"custom_field_settings.custom_field.multi_enum_values.enabled"|"custom_field_settings.custom_field.multi_enum_values.name"|"custom_field_settings.custom_field.name"|"custom_field_settings.custom_field.number_value"|"custom_field_settings.custom_field.people_value"|"custom_field_settings.custom_field.people_value.name"|"custom_field_settings.custom_field.precision"|"custom_field_settings.custom_field.representation_type"|"custom_field_settings.custom_field.resource_subtype"|"custom_field_settings.custom_field.text_value"|"custom_field_settings.custom_field.type"|"custom_field_settings.is_important"|"custom_field_settings.parent"|"custom_field_settings.parent.name"|"custom_field_settings.project"|"custom_field_settings.project.name"|"custom_fields"|"custom_fields.date_value"|"custom_fields.date_value.date"|"custom_fields.date_value.date_time"|"custom_fields.display_value"|"custom_fields.enabled"|"custom_fields.enum_options"|"custom_fields.enum_options.color"|"custom_fields.enum_options.enabled"|"custom_fields.enum_options.name"|"custom_fields.enum_value"|"custom_fields.enum_value.color"|"custom_fields.enum_value.enabled"|"custom_fields.enum_value.name"|"custom_fields.id_prefix"|"custom_fields.is_formula_field"|"custom_fields.multi_enum_values"|"custom_fields.multi_enum_values.color"|"custom_fields.multi_enum_values.enabled"|"custom_fields.multi_enum_values.name"|"custom_fields.name"|"custom_fields.number_value"|"custom_fields.representation_type"|"custom_fields.resource_subtype"|"custom_fields.text_value"|"custom_fields.type"|"due_on"|"members"|"members.name"|"name"|"owner"|"owner.name"|"permalink_url"|"project_templates"|"project_templates.name"|"public"|"start_on"|"workspace"|"workspace.name")[]? (default ()) - This endpoint returns a compact 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.
Return Type
- Inline_response_201_4|error - Successfully created portfolio.
get portfolios/[string portfolio_gid]
function get portfolios/[string portfolio_gid](boolean? opt_pretty, ("color"|"created_at"|"created_by"|"created_by.name"|"current_status_update"|"current_status_update.resource_subtype"|"current_status_update.title"|"custom_field_settings"|"custom_field_settings.custom_field"|"custom_field_settings.custom_field.asana_created_field"|"custom_field_settings.custom_field.created_by"|"custom_field_settings.custom_field.created_by.name"|"custom_field_settings.custom_field.currency_code"|"custom_field_settings.custom_field.custom_label"|"custom_field_settings.custom_field.custom_label_position"|"custom_field_settings.custom_field.date_value"|"custom_field_settings.custom_field.date_value.date"|"custom_field_settings.custom_field.date_value.date_time"|"custom_field_settings.custom_field.description"|"custom_field_settings.custom_field.display_value"|"custom_field_settings.custom_field.enabled"|"custom_field_settings.custom_field.enum_options"|"custom_field_settings.custom_field.enum_options.color"|"custom_field_settings.custom_field.enum_options.enabled"|"custom_field_settings.custom_field.enum_options.name"|"custom_field_settings.custom_field.enum_value"|"custom_field_settings.custom_field.enum_value.color"|"custom_field_settings.custom_field.enum_value.enabled"|"custom_field_settings.custom_field.enum_value.name"|"custom_field_settings.custom_field.format"|"custom_field_settings.custom_field.has_notifications_enabled"|"custom_field_settings.custom_field.id_prefix"|"custom_field_settings.custom_field.is_formula_field"|"custom_field_settings.custom_field.is_global_to_workspace"|"custom_field_settings.custom_field.is_value_read_only"|"custom_field_settings.custom_field.multi_enum_values"|"custom_field_settings.custom_field.multi_enum_values.color"|"custom_field_settings.custom_field.multi_enum_values.enabled"|"custom_field_settings.custom_field.multi_enum_values.name"|"custom_field_settings.custom_field.name"|"custom_field_settings.custom_field.number_value"|"custom_field_settings.custom_field.people_value"|"custom_field_settings.custom_field.people_value.name"|"custom_field_settings.custom_field.precision"|"custom_field_settings.custom_field.representation_type"|"custom_field_settings.custom_field.resource_subtype"|"custom_field_settings.custom_field.text_value"|"custom_field_settings.custom_field.type"|"custom_field_settings.is_important"|"custom_field_settings.parent"|"custom_field_settings.parent.name"|"custom_field_settings.project"|"custom_field_settings.project.name"|"custom_fields"|"custom_fields.date_value"|"custom_fields.date_value.date"|"custom_fields.date_value.date_time"|"custom_fields.display_value"|"custom_fields.enabled"|"custom_fields.enum_options"|"custom_fields.enum_options.color"|"custom_fields.enum_options.enabled"|"custom_fields.enum_options.name"|"custom_fields.enum_value"|"custom_fields.enum_value.color"|"custom_fields.enum_value.enabled"|"custom_fields.enum_value.name"|"custom_fields.id_prefix"|"custom_fields.is_formula_field"|"custom_fields.multi_enum_values"|"custom_fields.multi_enum_values.color"|"custom_fields.multi_enum_values.enabled"|"custom_fields.multi_enum_values.name"|"custom_fields.name"|"custom_fields.number_value"|"custom_fields.representation_type"|"custom_fields.resource_subtype"|"custom_fields.text_value"|"custom_fields.type"|"due_on"|"members"|"members.name"|"name"|"owner"|"owner.name"|"permalink_url"|"project_templates"|"project_templates.name"|"public"|"start_on"|"workspace"|"workspace.name")[]? opt_fields) returns Inline_response_201_4|error
Get a portfolio
Parameters
- opt_pretty boolean? (default ()) - 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 ("color"|"created_at"|"created_by"|"created_by.name"|"current_status_update"|"current_status_update.resource_subtype"|"current_status_update.title"|"custom_field_settings"|"custom_field_settings.custom_field"|"custom_field_settings.custom_field.asana_created_field"|"custom_field_settings.custom_field.created_by"|"custom_field_settings.custom_field.created_by.name"|"custom_field_settings.custom_field.currency_code"|"custom_field_settings.custom_field.custom_label"|"custom_field_settings.custom_field.custom_label_position"|"custom_field_settings.custom_field.date_value"|"custom_field_settings.custom_field.date_value.date"|"custom_field_settings.custom_field.date_value.date_time"|"custom_field_settings.custom_field.description"|"custom_field_settings.custom_field.display_value"|"custom_field_settings.custom_field.enabled"|"custom_field_settings.custom_field.enum_options"|"custom_field_settings.custom_field.enum_options.color"|"custom_field_settings.custom_field.enum_options.enabled"|"custom_field_settings.custom_field.enum_options.name"|"custom_field_settings.custom_field.enum_value"|"custom_field_settings.custom_field.enum_value.color"|"custom_field_settings.custom_field.enum_value.enabled"|"custom_field_settings.custom_field.enum_value.name"|"custom_field_settings.custom_field.format"|"custom_field_settings.custom_field.has_notifications_enabled"|"custom_field_settings.custom_field.id_prefix"|"custom_field_settings.custom_field.is_formula_field"|"custom_field_settings.custom_field.is_global_to_workspace"|"custom_field_settings.custom_field.is_value_read_only"|"custom_field_settings.custom_field.multi_enum_values"|"custom_field_settings.custom_field.multi_enum_values.color"|"custom_field_settings.custom_field.multi_enum_values.enabled"|"custom_field_settings.custom_field.multi_enum_values.name"|"custom_field_settings.custom_field.name"|"custom_field_settings.custom_field.number_value"|"custom_field_settings.custom_field.people_value"|"custom_field_settings.custom_field.people_value.name"|"custom_field_settings.custom_field.precision"|"custom_field_settings.custom_field.representation_type"|"custom_field_settings.custom_field.resource_subtype"|"custom_field_settings.custom_field.text_value"|"custom_field_settings.custom_field.type"|"custom_field_settings.is_important"|"custom_field_settings.parent"|"custom_field_settings.parent.name"|"custom_field_settings.project"|"custom_field_settings.project.name"|"custom_fields"|"custom_fields.date_value"|"custom_fields.date_value.date"|"custom_fields.date_value.date_time"|"custom_fields.display_value"|"custom_fields.enabled"|"custom_fields.enum_options"|"custom_fields.enum_options.color"|"custom_fields.enum_options.enabled"|"custom_fields.enum_options.name"|"custom_fields.enum_value"|"custom_fields.enum_value.color"|"custom_fields.enum_value.enabled"|"custom_fields.enum_value.name"|"custom_fields.id_prefix"|"custom_fields.is_formula_field"|"custom_fields.multi_enum_values"|"custom_fields.multi_enum_values.color"|"custom_fields.multi_enum_values.enabled"|"custom_fields.multi_enum_values.name"|"custom_fields.name"|"custom_fields.number_value"|"custom_fields.representation_type"|"custom_fields.resource_subtype"|"custom_fields.text_value"|"custom_fields.type"|"due_on"|"members"|"members.name"|"name"|"owner"|"owner.name"|"permalink_url"|"project_templates"|"project_templates.name"|"public"|"start_on"|"workspace"|"workspace.name")[]? (default ()) - This endpoint returns a compact 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.
Return Type
- Inline_response_201_4|error - Successfully retrieved the requested portfolio.
put portfolios/[string portfolio_gid]
function put portfolios/[string portfolio_gid](Portfolios_portfolio_gid_body payload, boolean? opt_pretty, ("color"|"created_at"|"created_by"|"created_by.name"|"current_status_update"|"current_status_update.resource_subtype"|"current_status_update.title"|"custom_field_settings"|"custom_field_settings.custom_field"|"custom_field_settings.custom_field.asana_created_field"|"custom_field_settings.custom_field.created_by"|"custom_field_settings.custom_field.created_by.name"|"custom_field_settings.custom_field.currency_code"|"custom_field_settings.custom_field.custom_label"|"custom_field_settings.custom_field.custom_label_position"|"custom_field_settings.custom_field.date_value"|"custom_field_settings.custom_field.date_value.date"|"custom_field_settings.custom_field.date_value.date_time"|"custom_field_settings.custom_field.description"|"custom_field_settings.custom_field.display_value"|"custom_field_settings.custom_field.enabled"|"custom_field_settings.custom_field.enum_options"|"custom_field_settings.custom_field.enum_options.color"|"custom_field_settings.custom_field.enum_options.enabled"|"custom_field_settings.custom_field.enum_options.name"|"custom_field_settings.custom_field.enum_value"|"custom_field_settings.custom_field.enum_value.color"|"custom_field_settings.custom_field.enum_value.enabled"|"custom_field_settings.custom_field.enum_value.name"|"custom_field_settings.custom_field.format"|"custom_field_settings.custom_field.has_notifications_enabled"|"custom_field_settings.custom_field.id_prefix"|"custom_field_settings.custom_field.is_formula_field"|"custom_field_settings.custom_field.is_global_to_workspace"|"custom_field_settings.custom_field.is_value_read_only"|"custom_field_settings.custom_field.multi_enum_values"|"custom_field_settings.custom_field.multi_enum_values.color"|"custom_field_settings.custom_field.multi_enum_values.enabled"|"custom_field_settings.custom_field.multi_enum_values.name"|"custom_field_settings.custom_field.name"|"custom_field_settings.custom_field.number_value"|"custom_field_settings.custom_field.people_value"|"custom_field_settings.custom_field.people_value.name"|"custom_field_settings.custom_field.precision"|"custom_field_settings.custom_field.representation_type"|"custom_field_settings.custom_field.resource_subtype"|"custom_field_settings.custom_field.text_value"|"custom_field_settings.custom_field.type"|"custom_field_settings.is_important"|"custom_field_settings.parent"|"custom_field_settings.parent.name"|"custom_field_settings.project"|"custom_field_settings.project.name"|"custom_fields"|"custom_fields.date_value"|"custom_fields.date_value.date"|"custom_fields.date_value.date_time"|"custom_fields.display_value"|"custom_fields.enabled"|"custom_fields.enum_options"|"custom_fields.enum_options.color"|"custom_fields.enum_options.enabled"|"custom_fields.enum_options.name"|"custom_fields.enum_value"|"custom_fields.enum_value.color"|"custom_fields.enum_value.enabled"|"custom_fields.enum_value.name"|"custom_fields.id_prefix"|"custom_fields.is_formula_field"|"custom_fields.multi_enum_values"|"custom_fields.multi_enum_values.color"|"custom_fields.multi_enum_values.enabled"|"custom_fields.multi_enum_values.name"|"custom_fields.name"|"custom_fields.number_value"|"custom_fields.representation_type"|"custom_fields.resource_subtype"|"custom_fields.text_value"|"custom_fields.type"|"due_on"|"members"|"members.name"|"name"|"owner"|"owner.name"|"permalink_url"|"project_templates"|"project_templates.name"|"public"|"start_on"|"workspace"|"workspace.name")[]? opt_fields) returns Inline_response_201_4|error
Update a portfolio
Parameters
- payload Portfolios_portfolio_gid_body - The updated fields for the portfolio.
- opt_pretty boolean? (default ()) - 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 ("color"|"created_at"|"created_by"|"created_by.name"|"current_status_update"|"current_status_update.resource_subtype"|"current_status_update.title"|"custom_field_settings"|"custom_field_settings.custom_field"|"custom_field_settings.custom_field.asana_created_field"|"custom_field_settings.custom_field.created_by"|"custom_field_settings.custom_field.created_by.name"|"custom_field_settings.custom_field.currency_code"|"custom_field_settings.custom_field.custom_label"|"custom_field_settings.custom_field.custom_label_position"|"custom_field_settings.custom_field.date_value"|"custom_field_settings.custom_field.date_value.date"|"custom_field_settings.custom_field.date_value.date_time"|"custom_field_settings.custom_field.description"|"custom_field_settings.custom_field.display_value"|"custom_field_settings.custom_field.enabled"|"custom_field_settings.custom_field.enum_options"|"custom_field_settings.custom_field.enum_options.color"|"custom_field_settings.custom_field.enum_options.enabled"|"custom_field_settings.custom_field.enum_options.name"|"custom_field_settings.custom_field.enum_value"|"custom_field_settings.custom_field.enum_value.color"|"custom_field_settings.custom_field.enum_value.enabled"|"custom_field_settings.custom_field.enum_value.name"|"custom_field_settings.custom_field.format"|"custom_field_settings.custom_field.has_notifications_enabled"|"custom_field_settings.custom_field.id_prefix"|"custom_field_settings.custom_field.is_formula_field"|"custom_field_settings.custom_field.is_global_to_workspace"|"custom_field_settings.custom_field.is_value_read_only"|"custom_field_settings.custom_field.multi_enum_values"|"custom_field_settings.custom_field.multi_enum_values.color"|"custom_field_settings.custom_field.multi_enum_values.enabled"|"custom_field_settings.custom_field.multi_enum_values.name"|"custom_field_settings.custom_field.name"|"custom_field_settings.custom_field.number_value"|"custom_field_settings.custom_field.people_value"|"custom_field_settings.custom_field.people_value.name"|"custom_field_settings.custom_field.precision"|"custom_field_settings.custom_field.representation_type"|"custom_field_settings.custom_field.resource_subtype"|"custom_field_settings.custom_field.text_value"|"custom_field_settings.custom_field.type"|"custom_field_settings.is_important"|"custom_field_settings.parent"|"custom_field_settings.parent.name"|"custom_field_settings.project"|"custom_field_settings.project.name"|"custom_fields"|"custom_fields.date_value"|"custom_fields.date_value.date"|"custom_fields.date_value.date_time"|"custom_fields.display_value"|"custom_fields.enabled"|"custom_fields.enum_options"|"custom_fields.enum_options.color"|"custom_fields.enum_options.enabled"|"custom_fields.enum_options.name"|"custom_fields.enum_value"|"custom_fields.enum_value.color"|"custom_fields.enum_value.enabled"|"custom_fields.enum_value.name"|"custom_fields.id_prefix"|"custom_fields.is_formula_field"|"custom_fields.multi_enum_values"|"custom_fields.multi_enum_values.color"|"custom_fields.multi_enum_values.enabled"|"custom_fields.multi_enum_values.name"|"custom_fields.name"|"custom_fields.number_value"|"custom_fields.representation_type"|"custom_fields.resource_subtype"|"custom_fields.text_value"|"custom_fields.type"|"due_on"|"members"|"members.name"|"name"|"owner"|"owner.name"|"permalink_url"|"project_templates"|"project_templates.name"|"public"|"start_on"|"workspace"|"workspace.name")[]? (default ()) - This endpoint returns a compact 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.
Return Type
- Inline_response_201_4|error - Successfully updated the portfolio.
delete portfolios/[string portfolio_gid]
function delete portfolios/[string portfolio_gid](boolean? opt_pretty) returns Inline_response_200_1|error
Delete a portfolio
Parameters
- opt_pretty boolean? (default ()) - 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.
Return Type
- Inline_response_200_1|error - Successfully deleted the specified portfolio.
get portfolios/[string portfolio_gid]/items
function get portfolios/[string portfolio_gid]/items(boolean? opt_pretty, int? 'limit, string? offset, ("archived"|"color"|"completed"|"completed_at"|"completed_by"|"completed_by.name"|"created_at"|"created_from_template"|"created_from_template.name"|"current_status"|"current_status.author"|"current_status.author.name"|"current_status.color"|"current_status.created_at"|"current_status.created_by"|"current_status.created_by.name"|"current_status.html_text"|"current_status.modified_at"|"current_status.text"|"current_status.title"|"current_status_update"|"current_status_update.resource_subtype"|"current_status_update.title"|"custom_field_settings"|"custom_field_settings.custom_field"|"custom_field_settings.custom_field.asana_created_field"|"custom_field_settings.custom_field.created_by"|"custom_field_settings.custom_field.created_by.name"|"custom_field_settings.custom_field.currency_code"|"custom_field_settings.custom_field.custom_label"|"custom_field_settings.custom_field.custom_label_position"|"custom_field_settings.custom_field.date_value"|"custom_field_settings.custom_field.date_value.date"|"custom_field_settings.custom_field.date_value.date_time"|"custom_field_settings.custom_field.description"|"custom_field_settings.custom_field.display_value"|"custom_field_settings.custom_field.enabled"|"custom_field_settings.custom_field.enum_options"|"custom_field_settings.custom_field.enum_options.color"|"custom_field_settings.custom_field.enum_options.enabled"|"custom_field_settings.custom_field.enum_options.name"|"custom_field_settings.custom_field.enum_value"|"custom_field_settings.custom_field.enum_value.color"|"custom_field_settings.custom_field.enum_value.enabled"|"custom_field_settings.custom_field.enum_value.name"|"custom_field_settings.custom_field.format"|"custom_field_settings.custom_field.has_notifications_enabled"|"custom_field_settings.custom_field.id_prefix"|"custom_field_settings.custom_field.is_formula_field"|"custom_field_settings.custom_field.is_global_to_workspace"|"custom_field_settings.custom_field.is_value_read_only"|"custom_field_settings.custom_field.multi_enum_values"|"custom_field_settings.custom_field.multi_enum_values.color"|"custom_field_settings.custom_field.multi_enum_values.enabled"|"custom_field_settings.custom_field.multi_enum_values.name"|"custom_field_settings.custom_field.name"|"custom_field_settings.custom_field.number_value"|"custom_field_settings.custom_field.people_value"|"custom_field_settings.custom_field.people_value.name"|"custom_field_settings.custom_field.precision"|"custom_field_settings.custom_field.representation_type"|"custom_field_settings.custom_field.resource_subtype"|"custom_field_settings.custom_field.text_value"|"custom_field_settings.custom_field.type"|"custom_field_settings.is_important"|"custom_field_settings.parent"|"custom_field_settings.parent.name"|"custom_field_settings.project"|"custom_field_settings.project.name"|"custom_fields"|"custom_fields.date_value"|"custom_fields.date_value.date"|"custom_fields.date_value.date_time"|"custom_fields.display_value"|"custom_fields.enabled"|"custom_fields.enum_options"|"custom_fields.enum_options.color"|"custom_fields.enum_options.enabled"|"custom_fields.enum_options.name"|"custom_fields.enum_value"|"custom_fields.enum_value.color"|"custom_fields.enum_value.enabled"|"custom_fields.enum_value.name"|"custom_fields.id_prefix"|"custom_fields.is_formula_field"|"custom_fields.multi_enum_values"|"custom_fields.multi_enum_values.color"|"custom_fields.multi_enum_values.enabled"|"custom_fields.multi_enum_values.name"|"custom_fields.name"|"custom_fields.number_value"|"custom_fields.representation_type"|"custom_fields.resource_subtype"|"custom_fields.text_value"|"custom_fields.type"|"default_access_level"|"default_view"|"due_date"|"due_on"|"followers"|"followers.name"|"html_notes"|"icon"|"members"|"members.name"|"minimum_access_level_for_customization"|"minimum_access_level_for_sharing"|"modified_at"|"name"|"notes"|"offset"|"owner"|"path"|"permalink_url"|"privacy_setting"|"project_brief"|"public"|"start_on"|"team"|"team.name"|"uri"|"workspace"|"workspace.name")[]? opt_fields) returns Inline_response_200_19|error
Get portfolio items
Parameters
- opt_pretty boolean? (default ()) - 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.
- 'limit int? (default ()) - Results per page. The number of objects to return per page. The value must be between 1 and 100.
- offset string? (default ()) - Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.'
- opt_fields ("archived"|"color"|"completed"|"completed_at"|"completed_by"|"completed_by.name"|"created_at"|"created_from_template"|"created_from_template.name"|"current_status"|"current_status.author"|"current_status.author.name"|"current_status.color"|"current_status.created_at"|"current_status.created_by"|"current_status.created_by.name"|"current_status.html_text"|"current_status.modified_at"|"current_status.text"|"current_status.title"|"current_status_update"|"current_status_update.resource_subtype"|"current_status_update.title"|"custom_field_settings"|"custom_field_settings.custom_field"|"custom_field_settings.custom_field.asana_created_field"|"custom_field_settings.custom_field.created_by"|"custom_field_settings.custom_field.created_by.name"|"custom_field_settings.custom_field.currency_code"|"custom_field_settings.custom_field.custom_label"|"custom_field_settings.custom_field.custom_label_position"|"custom_field_settings.custom_field.date_value"|"custom_field_settings.custom_field.date_value.date"|"custom_field_settings.custom_field.date_value.date_time"|"custom_field_settings.custom_field.description"|"custom_field_settings.custom_field.display_value"|"custom_field_settings.custom_field.enabled"|"custom_field_settings.custom_field.enum_options"|"custom_field_settings.custom_field.enum_options.color"|"custom_field_settings.custom_field.enum_options.enabled"|"custom_field_settings.custom_field.enum_options.name"|"custom_field_settings.custom_field.enum_value"|"custom_field_settings.custom_field.enum_value.color"|"custom_field_settings.custom_field.enum_value.enabled"|"custom_field_settings.custom_field.enum_value.name"|"custom_field_settings.custom_field.format"|"custom_field_settings.custom_field.has_notifications_enabled"|"custom_field_settings.custom_field.id_prefix"|"custom_field_settings.custom_field.is_formula_field"|"custom_field_settings.custom_field.is_global_to_workspace"|"custom_field_settings.custom_field.is_value_read_only"|"custom_field_settings.custom_field.multi_enum_values"|"custom_field_settings.custom_field.multi_enum_values.color"|"custom_field_settings.custom_field.multi_enum_values.enabled"|"custom_field_settings.custom_field.multi_enum_values.name"|"custom_field_settings.custom_field.name"|"custom_field_settings.custom_field.number_value"|"custom_field_settings.custom_field.people_value"|"custom_field_settings.custom_field.people_value.name"|"custom_field_settings.custom_field.precision"|"custom_field_settings.custom_field.representation_type"|"custom_field_settings.custom_field.resource_subtype"|"custom_field_settings.custom_field.text_value"|"custom_field_settings.custom_field.type"|"custom_field_settings.is_important"|"custom_field_settings.parent"|"custom_field_settings.parent.name"|"custom_field_settings.project"|"custom_field_settings.project.name"|"custom_fields"|"custom_fields.date_value"|"custom_fields.date_value.date"|"custom_fields.date_value.date_time"|"custom_fields.display_value"|"custom_fields.enabled"|"custom_fields.enum_options"|"custom_fields.enum_options.color"|"custom_fields.enum_options.enabled"|"custom_fields.enum_options.name"|"custom_fields.enum_value"|"custom_fields.enum_value.color"|"custom_fields.enum_value.enabled"|"custom_fields.enum_value.name"|"custom_fields.id_prefix"|"custom_fields.is_formula_field"|"custom_fields.multi_enum_values"|"custom_fields.multi_enum_values.color"|"custom_fields.multi_enum_values.enabled"|"custom_fields.multi_enum_values.name"|"custom_fields.name"|"custom_fields.number_value"|"custom_fields.representation_type"|"custom_fields.resource_subtype"|"custom_fields.text_value"|"custom_fields.type"|"default_access_level"|"default_view"|"due_date"|"due_on"|"followers"|"followers.name"|"html_notes"|"icon"|"members"|"members.name"|"minimum_access_level_for_customization"|"minimum_access_level_for_sharing"|"modified_at"|"name"|"notes"|"offset"|"owner"|"path"|"permalink_url"|"privacy_setting"|"project_brief"|"public"|"start_on"|"team"|"team.name"|"uri"|"workspace"|"workspace.name")[]? (default ()) - This endpoint returns a compact 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.
Return Type
- Inline_response_200_19|error - Successfully retrieved the requested portfolio's items.
post portfolios/[string portfolio_gid]/addItem
function post portfolios/[string portfolio_gid]/addItem(Portfolio_gid_addItem_body payload, boolean? opt_pretty) returns Inline_response_200_1|error
Add a portfolio item
Parameters
- payload Portfolio_gid_addItem_body - Information about the item being inserted.
- opt_pretty boolean? (default ()) - 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.
Return Type
- Inline_response_200_1|error - Successfully added the item to the portfolio.
post portfolios/[string portfolio_gid]/removeItem
function post portfolios/[string portfolio_gid]/removeItem(Portfolio_gid_removeItem_body payload, boolean? opt_pretty) returns Inline_response_200_1|error
Remove a portfolio item
Parameters
- payload Portfolio_gid_removeItem_body - Information about the item being removed.
- opt_pretty boolean? (default ()) - 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.
Return Type
- Inline_response_200_1|error - Successfully removed the item from the portfolio.
post portfolios/[string portfolio_gid]/addCustomFieldSetting
function post portfolios/[string portfolio_gid]/addCustomFieldSetting(Portfolio_gid_addCustomFieldSetting_body payload, boolean? opt_pretty) returns Inline_response_200_20|error
Add a custom field to a portfolio
Parameters
- payload Portfolio_gid_addCustomFieldSetting_body - Information about the custom field setting.
- opt_pretty boolean? (default ()) - 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.
Return Type
- Inline_response_200_20|error - Successfully added the custom field to the portfolio.
post portfolios/[string portfolio_gid]/removeCustomFieldSetting
function post portfolios/[string portfolio_gid]/removeCustomFieldSetting(Portfolio_gid_removeCustomFieldSetting_body payload, boolean? opt_pretty) returns Inline_response_200_1|error
Remove a custom field from a portfolio
Parameters
- payload Portfolio_gid_removeCustomFieldSetting_body - Information about the custom field setting being removed.
- opt_pretty boolean? (default ()) - 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.
Return Type
- Inline_response_200_1|error - Successfully removed the custom field from the portfolio.
post portfolios/[string portfolio_gid]/addMembers
function post portfolios/[string portfolio_gid]/addMembers(Portfolio_gid_addMembers_body payload, boolean? opt_pretty, ("color"|"created_at"|"created_by"|"created_by.name"|"current_status_update"|"current_status_update.resource_subtype"|"current_status_update.title"|"custom_field_settings"|"custom_field_settings.custom_field"|"custom_field_settings.custom_field.asana_created_field"|"custom_field_settings.custom_field.created_by"|"custom_field_settings.custom_field.created_by.name"|"custom_field_settings.custom_field.currency_code"|"custom_field_settings.custom_field.custom_label"|"custom_field_settings.custom_field.custom_label_position"|"custom_field_settings.custom_field.date_value"|"custom_field_settings.custom_field.date_value.date"|"custom_field_settings.custom_field.date_value.date_time"|"custom_field_settings.custom_field.description"|"custom_field_settings.custom_field.display_value"|"custom_field_settings.custom_field.enabled"|"custom_field_settings.custom_field.enum_options"|"custom_field_settings.custom_field.enum_options.color"|"custom_field_settings.custom_field.enum_options.enabled"|"custom_field_settings.custom_field.enum_options.name"|"custom_field_settings.custom_field.enum_value"|"custom_field_settings.custom_field.enum_value.color"|"custom_field_settings.custom_field.enum_value.enabled"|"custom_field_settings.custom_field.enum_value.name"|"custom_field_settings.custom_field.format"|"custom_field_settings.custom_field.has_notifications_enabled"|"custom_field_settings.custom_field.id_prefix"|"custom_field_settings.custom_field.is_formula_field"|"custom_field_settings.custom_field.is_global_to_workspace"|"custom_field_settings.custom_field.is_value_read_only"|"custom_field_settings.custom_field.multi_enum_values"|"custom_field_settings.custom_field.multi_enum_values.color"|"custom_field_settings.custom_field.multi_enum_values.enabled"|"custom_field_settings.custom_field.multi_enum_values.name"|"custom_field_settings.custom_field.name"|"custom_field_settings.custom_field.number_value"|"custom_field_settings.custom_field.people_value"|"custom_field_settings.custom_field.people_value.name"|"custom_field_settings.custom_field.precision"|"custom_field_settings.custom_field.representation_type"|"custom_field_settings.custom_field.resource_subtype"|"custom_field_settings.custom_field.text_value"|"custom_field_settings.custom_field.type"|"custom_field_settings.is_important"|"custom_field_settings.parent"|"custom_field_settings.parent.name"|"custom_field_settings.project"|"custom_field_settings.project.name"|"custom_fields"|"custom_fields.date_value"|"custom_fields.date_value.date"|"custom_fields.date_value.date_time"|"custom_fields.display_value"|"custom_fields.enabled"|"custom_fields.enum_options"|"custom_fields.enum_options.color"|"custom_fields.enum_options.enabled"|"custom_fields.enum_options.name"|"custom_fields.enum_value"|"custom_fields.enum_value.color"|"custom_fields.enum_value.enabled"|"custom_fields.enum_value.name"|"custom_fields.id_prefix"|"custom_fields.is_formula_field"|"custom_fields.multi_enum_values"|"custom_fields.multi_enum_values.color"|"custom_fields.multi_enum_values.enabled"|"custom_fields.multi_enum_values.name"|"custom_fields.name"|"custom_fields.number_value"|"custom_fields.representation_type"|"custom_fields.resource_subtype"|"custom_fields.text_value"|"custom_fields.type"|"due_on"|"members"|"members.name"|"name"|"owner"|"owner.name"|"permalink_url"|"project_templates"|"project_templates.name"|"public"|"start_on"|"workspace"|"workspace.name")[]? opt_fields) returns Inline_response_201_4|error
Add users to a portfolio
Parameters
- payload Portfolio_gid_addMembers_body - Information about the members being added.
- opt_pretty boolean? (default ()) - 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 ("color"|"created_at"|"created_by"|"created_by.name"|"current_status_update"|"current_status_update.resource_subtype"|"current_status_update.title"|"custom_field_settings"|"custom_field_settings.custom_field"|"custom_field_settings.custom_field.asana_created_field"|"custom_field_settings.custom_field.created_by"|"custom_field_settings.custom_field.created_by.name"|"custom_field_settings.custom_field.currency_code"|"custom_field_settings.custom_field.custom_label"|"custom_field_settings.custom_field.custom_label_position"|"custom_field_settings.custom_field.date_value"|"custom_field_settings.custom_field.date_value.date"|"custom_field_settings.custom_field.date_value.date_time"|"custom_field_settings.custom_field.description"|"custom_field_settings.custom_field.display_value"|"custom_field_settings.custom_field.enabled"|"custom_field_settings.custom_field.enum_options"|"custom_field_settings.custom_field.enum_options.color"|"custom_field_settings.custom_field.enum_options.enabled"|"custom_field_settings.custom_field.enum_options.name"|"custom_field_settings.custom_field.enum_value"|"custom_field_settings.custom_field.enum_value.color"|"custom_field_settings.custom_field.enum_value.enabled"|"custom_field_settings.custom_field.enum_value.name"|"custom_field_settings.custom_field.format"|"custom_field_settings.custom_field.has_notifications_enabled"|"custom_field_settings.custom_field.id_prefix"|"custom_field_settings.custom_field.is_formula_field"|"custom_field_settings.custom_field.is_global_to_workspace"|"custom_field_settings.custom_field.is_value_read_only"|"custom_field_settings.custom_field.multi_enum_values"|"custom_field_settings.custom_field.multi_enum_values.color"|"custom_field_settings.custom_field.multi_enum_values.enabled"|"custom_field_settings.custom_field.multi_enum_values.name"|"custom_field_settings.custom_field.name"|"custom_field_settings.custom_field.number_value"|"custom_field_settings.custom_field.people_value"|"custom_field_settings.custom_field.people_value.name"|"custom_field_settings.custom_field.precision"|"custom_field_settings.custom_field.representation_type"|"custom_field_settings.custom_field.resource_subtype"|"custom_field_settings.custom_field.text_value"|"custom_field_settings.custom_field.type"|"custom_field_settings.is_important"|"custom_field_settings.parent"|"custom_field_settings.parent.name"|"custom_field_settings.project"|"custom_field_settings.project.name"|"custom_fields"|"custom_fields.date_value"|"custom_fields.date_value.date"|"custom_fields.date_value.date_time"|"custom_fields.display_value"|"custom_fields.enabled"|"custom_fields.enum_options"|"custom_fields.enum_options.color"|"custom_fields.enum_options.enabled"|"custom_fields.enum_options.name"|"custom_fields.enum_value"|"custom_fields.enum_value.color"|"custom_fields.enum_value.enabled"|"custom_fields.enum_value.name"|"custom_fields.id_prefix"|"custom_fields.is_formula_field"|"custom_fields.multi_enum_values"|"custom_fields.multi_enum_values.color"|"custom_fields.multi_enum_values.enabled"|"custom_fields.multi_enum_values.name"|"custom_fields.name"|"custom_fields.number_value"|"custom_fields.representation_type"|"custom_fields.resource_subtype"|"custom_fields.text_value"|"custom_fields.type"|"due_on"|"members"|"members.name"|"name"|"owner"|"owner.name"|"permalink_url"|"project_templates"|"project_templates.name"|"public"|"start_on"|"workspace"|"workspace.name")[]? (default ()) - This endpoint returns a compact 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.
Return Type
- Inline_response_201_4|error - Successfully added members to the portfolio.
post portfolios/[string portfolio_gid]/removeMembers
function post portfolios/[string portfolio_gid]/removeMembers(Portfolio_gid_removeMembers_body payload, boolean? opt_pretty, ("color"|"created_at"|"created_by"|"created_by.name"|"current_status_update"|"current_status_update.resource_subtype"|"current_status_update.title"|"custom_field_settings"|"custom_field_settings.custom_field"|"custom_field_settings.custom_field.asana_created_field"|"custom_field_settings.custom_field.created_by"|"custom_field_settings.custom_field.created_by.name"|"custom_field_settings.custom_field.currency_code"|"custom_field_settings.custom_field.custom_label"|"custom_field_settings.custom_field.custom_label_position"|"custom_field_settings.custom_field.date_value"|"custom_field_settings.custom_field.date_value.date"|"custom_field_settings.custom_field.date_value.date_time"|"custom_field_settings.custom_field.description"|"custom_field_settings.custom_field.display_value"|"custom_field_settings.custom_field.enabled"|"custom_field_settings.custom_field.enum_options"|"custom_field_settings.custom_field.enum_options.color"|"custom_field_settings.custom_field.enum_options.enabled"|"custom_field_settings.custom_field.enum_options.name"|"custom_field_settings.custom_field.enum_value"|"custom_field_settings.custom_field.enum_value.color"|"custom_field_settings.custom_field.enum_value.enabled"|"custom_field_settings.custom_field.enum_value.name"|"custom_field_settings.custom_field.format"|"custom_field_settings.custom_field.has_notifications_enabled"|"custom_field_settings.custom_field.id_prefix"|"custom_field_settings.custom_field.is_formula_field"|"custom_field_settings.custom_field.is_global_to_workspace"|"custom_field_settings.custom_field.is_value_read_only"|"custom_field_settings.custom_field.multi_enum_values"|"custom_field_settings.custom_field.multi_enum_values.color"|"custom_field_settings.custom_field.multi_enum_values.enabled"|"custom_field_settings.custom_field.multi_enum_values.name"|"custom_field_settings.custom_field.name"|"custom_field_settings.custom_field.number_value"|"custom_field_settings.custom_field.people_value"|"custom_field_settings.custom_field.people_value.name"|"custom_field_settings.custom_field.precision"|"custom_field_settings.custom_field.representation_type"|"custom_field_settings.custom_field.resource_subtype"|"custom_field_settings.custom_field.text_value"|"custom_field_settings.custom_field.type"|"custom_field_settings.is_important"|"custom_field_settings.parent"|"custom_field_settings.parent.name"|"custom_field_settings.project"|"custom_field_settings.project.name"|"custom_fields"|"custom_fields.date_value"|"custom_fields.date_value.date"|"custom_fields.date_value.date_time"|"custom_fields.display_value"|"custom_fields.enabled"|"custom_fields.enum_options"|"custom_fields.enum_options.color"|"custom_fields.enum_options.enabled"|"custom_fields.enum_options.name"|"custom_fields.enum_value"|"custom_fields.enum_value.color"|"custom_fields.enum_value.enabled"|"custom_fields.enum_value.name"|"custom_fields.id_prefix"|"custom_fields.is_formula_field"|"custom_fields.multi_enum_values"|"custom_fields.multi_enum_values.color"|"custom_fields.multi_enum_values.enabled"|"custom_fields.multi_enum_values.name"|"custom_fields.name"|"custom_fields.number_value"|"custom_fields.representation_type"|"custom_fields.resource_subtype"|"custom_fields.text_value"|"custom_fields.type"|"due_on"|"members"|"members.name"|"name"|"owner"|"owner.name"|"permalink_url"|"project_templates"|"project_templates.name"|"public"|"start_on"|"workspace"|"workspace.name")[]? opt_fields) returns Inline_response_201_4|error
Remove users from a portfolio
Parameters
- payload Portfolio_gid_removeMembers_body - Information about the members being removed.
- opt_pretty boolean? (default ()) - 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 ("color"|"created_at"|"created_by"|"created_by.name"|"current_status_update"|"current_status_update.resource_subtype"|"current_status_update.title"|"custom_field_settings"|"custom_field_settings.custom_field"|"custom_field_settings.custom_field.asana_created_field"|"custom_field_settings.custom_field.created_by"|"custom_field_settings.custom_field.created_by.name"|"custom_field_settings.custom_field.currency_code"|"custom_field_settings.custom_field.custom_label"|"custom_field_settings.custom_field.custom_label_position"|"custom_field_settings.custom_field.date_value"|"custom_field_settings.custom_field.date_value.date"|"custom_field_settings.custom_field.date_value.date_time"|"custom_field_settings.custom_field.description"|"custom_field_settings.custom_field.display_value"|"custom_field_settings.custom_field.enabled"|"custom_field_settings.custom_field.enum_options"|"custom_field_settings.custom_field.enum_options.color"|"custom_field_settings.custom_field.enum_options.enabled"|"custom_field_settings.custom_field.enum_options.name"|"custom_field_settings.custom_field.enum_value"|"custom_field_settings.custom_field.enum_value.color"|"custom_field_settings.custom_field.enum_value.enabled"|"custom_field_settings.custom_field.enum_value.name"|"custom_field_settings.custom_field.format"|"custom_field_settings.custom_field.has_notifications_enabled"|"custom_field_settings.custom_field.id_prefix"|"custom_field_settings.custom_field.is_formula_field"|"custom_field_settings.custom_field.is_global_to_workspace"|"custom_field_settings.custom_field.is_value_read_only"|"custom_field_settings.custom_field.multi_enum_values"|"custom_field_settings.custom_field.multi_enum_values.color"|"custom_field_settings.custom_field.multi_enum_values.enabled"|"custom_field_settings.custom_field.multi_enum_values.name"|"custom_field_settings.custom_field.name"|"custom_field_settings.custom_field.number_value"|"custom_field_settings.custom_field.people_value"|"custom_field_settings.custom_field.people_value.name"|"custom_field_settings.custom_field.precision"|"custom_field_settings.custom_field.representation_type"|"custom_field_settings.custom_field.resource_subtype"|"custom_field_settings.custom_field.text_value"|"custom_field_settings.custom_field.type"|"custom_field_settings.is_important"|"custom_field_settings.parent"|"custom_field_settings.parent.name"|"custom_field_settings.project"|"custom_field_settings.project.name"|"custom_fields"|"custom_fields.date_value"|"custom_fields.date_value.date"|"custom_fields.date_value.date_time"|"custom_fields.display_value"|"custom_fields.enabled"|"custom_fields.enum_options"|"custom_fields.enum_options.color"|"custom_fields.enum_options.enabled"|"custom_fields.enum_options.name"|"custom_fields.enum_value"|"custom_fields.enum_value.color"|"custom_fields.enum_value.enabled"|"custom_fields.enum_value.name"|"custom_fields.id_prefix"|"custom_fields.is_formula_field"|"custom_fields.multi_enum_values"|"custom_fields.multi_enum_values.color"|"custom_fields.multi_enum_values.enabled"|"custom_fields.multi_enum_values.name"|"custom_fields.name"|"custom_fields.number_value"|"custom_fields.representation_type"|"custom_fields.resource_subtype"|"custom_fields.text_value"|"custom_fields.type"|"due_on"|"members"|"members.name"|"name"|"owner"|"owner.name"|"permalink_url"|"project_templates"|"project_templates.name"|"public"|"start_on"|"workspace"|"workspace.name")[]? (default ()) - This endpoint returns a compact 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.
Return Type
- Inline_response_201_4|error - Successfully removed the members from the portfolio.
get project_briefs/[string project_brief_gid]
function get project_briefs/[string project_brief_gid](boolean? opt_pretty, ("html_text"|"permalink_url"|"project"|"project.name"|"text"|"title")[]? opt_fields) returns Inline_response_200_21|error
Get a project brief
Parameters
- opt_pretty boolean? (default ()) - 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 ("html_text"|"permalink_url"|"project"|"project.name"|"text"|"title")[]? (default ()) - This endpoint returns a compact 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.
Return Type
- Inline_response_200_21|error - Successfully retrieved the record for a project brief.
put project_briefs/[string project_brief_gid]
function put project_briefs/[string project_brief_gid](Project_briefs_project_brief_gid_body payload, boolean? opt_pretty, ("html_text"|"permalink_url"|"project"|"project.name"|"text"|"title")[]? opt_fields) returns Inline_response_200_21|error
Update a project brief
Parameters
- payload Project_briefs_project_brief_gid_body - The updated fields for the project brief.
- opt_pretty boolean? (default ()) - 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 ("html_text"|"permalink_url"|"project"|"project.name"|"text"|"title")[]? (default ()) - This endpoint returns a compact 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.
Return Type
- Inline_response_200_21|error - Successfully updated the project brief.
delete project_briefs/[string project_brief_gid]
function delete project_briefs/[string project_brief_gid](boolean? opt_pretty) returns Inline_response_200_1|error
Delete a project brief
Parameters
- opt_pretty boolean? (default ()) - 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.
Return Type
- Inline_response_200_1|error - Successfully deleted the specified project brief.
post projects/[string project_gid]/project_briefs
function post projects/[string project_gid]/project_briefs(Project_gid_project_briefs_body payload, boolean? opt_pretty, ("html_text"|"permalink_url"|"project"|"project.name"|"text"|"title")[]? opt_fields) returns Inline_response_200_21|error
Create a project brief
Parameters
- payload Project_gid_project_briefs_body - The project brief to create.
- opt_pretty boolean? (default ()) - 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 ("html_text"|"permalink_url"|"project"|"project.name"|"text"|"title")[]? (default ()) - This endpoint returns a compact 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.
Return Type
- Inline_response_200_21|error - Successfully created a new project brief.
get project_memberships/[string project_membership_gid]
function get project_memberships/[string project_membership_gid](boolean? opt_pretty, ("access_level"|"member"|"member.name"|"parent"|"parent.name"|"project"|"project.name"|"user"|"user.name"|"write_access")[]? opt_fields) returns Inline_response_200_22|error
Get a project membership
Parameters
- opt_pretty boolean? (default ()) - 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 ("access_level"|"member"|"member.name"|"parent"|"parent.name"|"project"|"project.name"|"user"|"user.name"|"write_access")[]? (default ()) - This endpoint returns a compact 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.
Return Type
- Inline_response_200_22|error - Successfully retrieved the requested project membership.
get projects/[string project_gid]/project_memberships
function get projects/[string project_gid]/project_memberships(string? user, boolean? opt_pretty, int? 'limit, string? offset, ("access_level"|"member"|"member.name"|"offset"|"parent"|"parent.name"|"path"|"uri")[]? opt_fields) returns Inline_response_200_23|error
Get memberships from a project
Parameters
- user string? (default ()) - A string identifying a user. This can either be the string "me", an email, or the gid of a user.
- opt_pretty boolean? (default ()) - 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.
- 'limit int? (default ()) - Results per page. The number of objects to return per page. The value must be between 1 and 100.
- offset string? (default ()) - Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.'
- opt_fields ("access_level"|"member"|"member.name"|"offset"|"parent"|"parent.name"|"path"|"uri")[]? (default ()) - This endpoint returns a compact 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.
Return Type
- Inline_response_200_23|error - Successfully retrieved the requested project's memberships.
get project_statuses/[string project_status_gid]
function get project_statuses/[string project_status_gid](boolean? opt_pretty, ("author"|"author.name"|"color"|"created_at"|"created_by"|"created_by.name"|"html_text"|"modified_at"|"text"|"title")[]? opt_fields) returns Inline_response_200_24|error
Get a project status
Parameters
- opt_pretty boolean? (default ()) - 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 ("author"|"author.name"|"color"|"created_at"|"created_by"|"created_by.name"|"html_text"|"modified_at"|"text"|"title")[]? (default ()) - This endpoint returns a compact 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.
Return Type
- Inline_response_200_24|error - Successfully retrieved the specified project's status updates.
delete project_statuses/[string project_status_gid]
function delete project_statuses/[string project_status_gid](boolean? opt_pretty) returns Inline_response_200_1|error
Delete a project status
Parameters
- opt_pretty boolean? (default ()) - 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.
Return Type
- Inline_response_200_1|error - Successfully deleted the specified project status.
get projects/[string project_gid]/project_statuses
function get projects/[string project_gid]/project_statuses(boolean? opt_pretty, int? 'limit, string? offset, ("author"|"author.name"|"color"|"created_at"|"created_by"|"created_by.name"|"html_text"|"modified_at"|"offset"|"path"|"text"|"title"|"uri")[]? opt_fields) returns Inline_response_200_25|error
Get statuses from a project
Parameters
- opt_pretty boolean? (default ()) - 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.
- 'limit int? (default ()) - Results per page. The number of objects to return per page. The value must be between 1 and 100.
- offset string? (default ()) - Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.'
- opt_fields ("author"|"author.name"|"color"|"created_at"|"created_by"|"created_by.name"|"html_text"|"modified_at"|"offset"|"path"|"text"|"title"|"uri")[]? (default ()) - This endpoint returns a compact 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.
Return Type
- Inline_response_200_25|error - Successfully retrieved the specified project's status updates.
post projects/[string project_gid]/project_statuses
function post projects/[string project_gid]/project_statuses(Project_gid_project_statuses_body payload, boolean? opt_pretty, ("author"|"author.name"|"color"|"created_at"|"created_by"|"created_by.name"|"html_text"|"modified_at"|"text"|"title")[]? opt_fields) returns Inline_response_200_24|error
Create a project status
Parameters
- payload Project_gid_project_statuses_body - The project status to create.
- opt_pretty boolean? (default ()) - 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 ("author"|"author.name"|"color"|"created_at"|"created_by"|"created_by.name"|"html_text"|"modified_at"|"text"|"title")[]? (default ()) - This endpoint returns a compact 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.
Return Type
- Inline_response_200_24|error - Successfully created a new story.
get project_templates/[string project_template_gid]
function get project_templates/[string project_template_gid](boolean? opt_pretty, ("color"|"description"|"html_description"|"name"|"owner"|"public"|"requested_dates"|"requested_dates.description"|"requested_dates.name"|"requested_roles"|"requested_roles.name"|"team"|"team.name")[]? opt_fields) returns Inline_response_200_26|error
Get a project template
Parameters
- opt_pretty boolean? (default ()) - 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 ("color"|"description"|"html_description"|"name"|"owner"|"public"|"requested_dates"|"requested_dates.description"|"requested_dates.name"|"requested_roles"|"requested_roles.name"|"team"|"team.name")[]? (default ()) - This endpoint returns a compact 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.
Return Type
- Inline_response_200_26|error - Successfully retrieved the requested project template.
delete project_templates/[string project_template_gid]
function delete project_templates/[string project_template_gid](boolean? opt_pretty) returns Inline_response_200_1|error
Delete a project template
Parameters
- opt_pretty boolean? (default ()) - 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.
Return Type
- Inline_response_200_1|error - Successfully deleted the specified project template.
get project_templates
function get project_templates(boolean? opt_pretty, string? workspace, string? team, int? 'limit, string? offset, ("color"|"description"|"html_description"|"name"|"offset"|"owner"|"path"|"public"|"requested_dates"|"requested_dates.description"|"requested_dates.name"|"requested_roles"|"requested_roles.name"|"team"|"team.name"|"uri")[]? opt_fields) returns Inline_response_200_27|error
Get multiple project templates
Parameters
- opt_pretty boolean? (default ()) - 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.
- workspace string? (default ()) - The workspace to filter results on.
- team string? (default ()) - The team to filter projects on.
- 'limit int? (default ()) - Results per page. The number of objects to return per page. The value must be between 1 and 100.
- offset string? (default ()) - Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.'
- opt_fields ("color"|"description"|"html_description"|"name"|"offset"|"owner"|"path"|"public"|"requested_dates"|"requested_dates.description"|"requested_dates.name"|"requested_roles"|"requested_roles.name"|"team"|"team.name"|"uri")[]? (default ()) - This endpoint returns a compact 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.
Return Type
- Inline_response_200_27|error - Successfully retrieved the requested team's or workspace's project templates.
get teams/[string team_gid]/project_templates
function get teams/[string team_gid]/project_templates(boolean? opt_pretty, int? 'limit, string? offset, ("color"|"description"|"html_description"|"name"|"offset"|"owner"|"path"|"public"|"requested_dates"|"requested_dates.description"|"requested_dates.name"|"requested_roles"|"requested_roles.name"|"team"|"team.name"|"uri")[]? opt_fields) returns Inline_response_200_27|error
Get a team's project templates
Parameters
- opt_pretty boolean? (default ()) - 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.
- 'limit int? (default ()) - Results per page. The number of objects to return per page. The value must be between 1 and 100.
- offset string? (default ()) - Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.'
- opt_fields ("color"|"description"|"html_description"|"name"|"offset"|"owner"|"path"|"public"|"requested_dates"|"requested_dates.description"|"requested_dates.name"|"requested_roles"|"requested_roles.name"|"team"|"team.name"|"uri")[]? (default ()) - This endpoint returns a compact 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.
Return Type
- Inline_response_200_27|error - Successfully retrieved the requested team's project templates.
post project_templates/[string project_template_gid]/instantiateProject
function post project_templates/[string project_template_gid]/instantiateProject(Project_template_gid_instantiateProject_body payload, boolean? opt_pretty, ("new_project"|"new_project.name"|"new_project_template"|"new_project_template.name"|"new_task"|"new_task.created_by"|"new_task.name"|"new_task.resource_subtype"|"new_task_template"|"new_task_template.name"|"resource_subtype"|"status")[]? opt_fields) returns Inline_response_200_13|error
Instantiate a project from a project template
Parameters
- payload Project_template_gid_instantiateProject_body - Describes the inputs used for instantiating a project, such as the resulting project's name, which team it should be created in, and values for date variables.
- opt_pretty boolean? (default ()) - 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 ("new_project"|"new_project.name"|"new_project_template"|"new_project_template.name"|"new_task"|"new_task.created_by"|"new_task.name"|"new_task.resource_subtype"|"new_task_template"|"new_task_template.name"|"resource_subtype"|"status")[]? (default ()) - This endpoint returns a compact 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.
Return Type
- Inline_response_200_13|error - Successfully created the job to handle project instantiation.
get projects
function get projects(boolean? opt_pretty, int? 'limit, string? offset, string? workspace, string? team, boolean? archived, ("archived"|"color"|"completed"|"completed_at"|"completed_by"|"completed_by.name"|"created_at"|"created_from_template"|"created_from_template.name"|"current_status"|"current_status.author"|"current_status.author.name"|"current_status.color"|"current_status.created_at"|"current_status.created_by"|"current_status.created_by.name"|"current_status.html_text"|"current_status.modified_at"|"current_status.text"|"current_status.title"|"current_status_update"|"current_status_update.resource_subtype"|"current_status_update.title"|"custom_field_settings"|"custom_field_settings.custom_field"|"custom_field_settings.custom_field.asana_created_field"|"custom_field_settings.custom_field.created_by"|"custom_field_settings.custom_field.created_by.name"|"custom_field_settings.custom_field.currency_code"|"custom_field_settings.custom_field.custom_label"|"custom_field_settings.custom_field.custom_label_position"|"custom_field_settings.custom_field.date_value"|"custom_field_settings.custom_field.date_value.date"|"custom_field_settings.custom_field.date_value.date_time"|"custom_field_settings.custom_field.description"|"custom_field_settings.custom_field.display_value"|"custom_field_settings.custom_field.enabled"|"custom_field_settings.custom_field.enum_options"|"custom_field_settings.custom_field.enum_options.color"|"custom_field_settings.custom_field.enum_options.enabled"|"custom_field_settings.custom_field.enum_options.name"|"custom_field_settings.custom_field.enum_value"|"custom_field_settings.custom_field.enum_value.color"|"custom_field_settings.custom_field.enum_value.enabled"|"custom_field_settings.custom_field.enum_value.name"|"custom_field_settings.custom_field.format"|"custom_field_settings.custom_field.has_notifications_enabled"|"custom_field_settings.custom_field.id_prefix"|"custom_field_settings.custom_field.is_formula_field"|"custom_field_settings.custom_field.is_global_to_workspace"|"custom_field_settings.custom_field.is_value_read_only"|"custom_field_settings.custom_field.multi_enum_values"|"custom_field_settings.custom_field.multi_enum_values.color"|"custom_field_settings.custom_field.multi_enum_values.enabled"|"custom_field_settings.custom_field.multi_enum_values.name"|"custom_field_settings.custom_field.name"|"custom_field_settings.custom_field.number_value"|"custom_field_settings.custom_field.people_value"|"custom_field_settings.custom_field.people_value.name"|"custom_field_settings.custom_field.precision"|"custom_field_settings.custom_field.representation_type"|"custom_field_settings.custom_field.resource_subtype"|"custom_field_settings.custom_field.text_value"|"custom_field_settings.custom_field.type"|"custom_field_settings.is_important"|"custom_field_settings.parent"|"custom_field_settings.parent.name"|"custom_field_settings.project"|"custom_field_settings.project.name"|"custom_fields"|"custom_fields.date_value"|"custom_fields.date_value.date"|"custom_fields.date_value.date_time"|"custom_fields.display_value"|"custom_fields.enabled"|"custom_fields.enum_options"|"custom_fields.enum_options.color"|"custom_fields.enum_options.enabled"|"custom_fields.enum_options.name"|"custom_fields.enum_value"|"custom_fields.enum_value.color"|"custom_fields.enum_value.enabled"|"custom_fields.enum_value.name"|"custom_fields.id_prefix"|"custom_fields.is_formula_field"|"custom_fields.multi_enum_values"|"custom_fields.multi_enum_values.color"|"custom_fields.multi_enum_values.enabled"|"custom_fields.multi_enum_values.name"|"custom_fields.name"|"custom_fields.number_value"|"custom_fields.representation_type"|"custom_fields.resource_subtype"|"custom_fields.text_value"|"custom_fields.type"|"default_access_level"|"default_view"|"due_date"|"due_on"|"followers"|"followers.name"|"html_notes"|"icon"|"members"|"members.name"|"minimum_access_level_for_customization"|"minimum_access_level_for_sharing"|"modified_at"|"name"|"notes"|"offset"|"owner"|"path"|"permalink_url"|"privacy_setting"|"project_brief"|"public"|"start_on"|"team"|"team.name"|"uri"|"workspace"|"workspace.name")[]? opt_fields) returns Inline_response_200_19|error
Get multiple projects
Parameters
- opt_pretty boolean? (default ()) - 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.
- 'limit int? (default ()) - Results per page. The number of objects to return per page. The value must be between 1 and 100.
- offset string? (default ()) - Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.'
- workspace string? (default ()) - The workspace or organization to filter projects on.
- team string? (default ()) - The team to filter projects on.
- archived boolean? (default ()) - Only return projects whose
archived
field takes on the value of this parameter.
- opt_fields ("archived"|"color"|"completed"|"completed_at"|"completed_by"|"completed_by.name"|"created_at"|"created_from_template"|"created_from_template.name"|"current_status"|"current_status.author"|"current_status.author.name"|"current_status.color"|"current_status.created_at"|"current_status.created_by"|"current_status.created_by.name"|"current_status.html_text"|"current_status.modified_at"|"current_status.text"|"current_status.title"|"current_status_update"|"current_status_update.resource_subtype"|"current_status_update.title"|"custom_field_settings"|"custom_field_settings.custom_field"|"custom_field_settings.custom_field.asana_created_field"|"custom_field_settings.custom_field.created_by"|"custom_field_settings.custom_field.created_by.name"|"custom_field_settings.custom_field.currency_code"|"custom_field_settings.custom_field.custom_label"|"custom_field_settings.custom_field.custom_label_position"|"custom_field_settings.custom_field.date_value"|"custom_field_settings.custom_field.date_value.date"|"custom_field_settings.custom_field.date_value.date_time"|"custom_field_settings.custom_field.description"|"custom_field_settings.custom_field.display_value"|"custom_field_settings.custom_field.enabled"|"custom_field_settings.custom_field.enum_options"|"custom_field_settings.custom_field.enum_options.color"|"custom_field_settings.custom_field.enum_options.enabled"|"custom_field_settings.custom_field.enum_options.name"|"custom_field_settings.custom_field.enum_value"|"custom_field_settings.custom_field.enum_value.color"|"custom_field_settings.custom_field.enum_value.enabled"|"custom_field_settings.custom_field.enum_value.name"|"custom_field_settings.custom_field.format"|"custom_field_settings.custom_field.has_notifications_enabled"|"custom_field_settings.custom_field.id_prefix"|"custom_field_settings.custom_field.is_formula_field"|"custom_field_settings.custom_field.is_global_to_workspace"|"custom_field_settings.custom_field.is_value_read_only"|"custom_field_settings.custom_field.multi_enum_values"|"custom_field_settings.custom_field.multi_enum_values.color"|"custom_field_settings.custom_field.multi_enum_values.enabled"|"custom_field_settings.custom_field.multi_enum_values.name"|"custom_field_settings.custom_field.name"|"custom_field_settings.custom_field.number_value"|"custom_field_settings.custom_field.people_value"|"custom_field_settings.custom_field.people_value.name"|"custom_field_settings.custom_field.precision"|"custom_field_settings.custom_field.representation_type"|"custom_field_settings.custom_field.resource_subtype"|"custom_field_settings.custom_field.text_value"|"custom_field_settings.custom_field.type"|"custom_field_settings.is_important"|"custom_field_settings.parent"|"custom_field_settings.parent.name"|"custom_field_settings.project"|"custom_field_settings.project.name"|"custom_fields"|"custom_fields.date_value"|"custom_fields.date_value.date"|"custom_fields.date_value.date_time"|"custom_fields.display_value"|"custom_fields.enabled"|"custom_fields.enum_options"|"custom_fields.enum_options.color"|"custom_fields.enum_options.enabled"|"custom_fields.enum_options.name"|"custom_fields.enum_value"|"custom_fields.enum_value.color"|"custom_fields.enum_value.enabled"|"custom_fields.enum_value.name"|"custom_fields.id_prefix"|"custom_fields.is_formula_field"|"custom_fields.multi_enum_values"|"custom_fields.multi_enum_values.color"|"custom_fields.multi_enum_values.enabled"|"custom_fields.multi_enum_values.name"|"custom_fields.name"|"custom_fields.number_value"|"custom_fields.representation_type"|"custom_fields.resource_subtype"|"custom_fields.text_value"|"custom_fields.type"|"default_access_level"|"default_view"|"due_date"|"due_on"|"followers"|"followers.name"|"html_notes"|"icon"|"members"|"members.name"|"minimum_access_level_for_customization"|"minimum_access_level_for_sharing"|"modified_at"|"name"|"notes"|"offset"|"owner"|"path"|"permalink_url"|"privacy_setting"|"project_brief"|"public"|"start_on"|"team"|"team.name"|"uri"|"workspace"|"workspace.name")[]? (default ()) - This endpoint returns a compact 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.
Return Type
- Inline_response_200_19|error - Successfully retrieved projects.
post projects
function post projects(Projects_body payload, boolean? opt_pretty, ("archived"|"color"|"completed"|"completed_at"|"completed_by"|"completed_by.name"|"created_at"|"created_from_template"|"created_from_template.name"|"current_status"|"current_status.author"|"current_status.author.name"|"current_status.color"|"current_status.created_at"|"current_status.created_by"|"current_status.created_by.name"|"current_status.html_text"|"current_status.modified_at"|"current_status.text"|"current_status.title"|"current_status_update"|"current_status_update.resource_subtype"|"current_status_update.title"|"custom_field_settings"|"custom_field_settings.custom_field"|"custom_field_settings.custom_field.asana_created_field"|"custom_field_settings.custom_field.created_by"|"custom_field_settings.custom_field.created_by.name"|"custom_field_settings.custom_field.currency_code"|"custom_field_settings.custom_field.custom_label"|"custom_field_settings.custom_field.custom_label_position"|"custom_field_settings.custom_field.date_value"|"custom_field_settings.custom_field.date_value.date"|"custom_field_settings.custom_field.date_value.date_time"|"custom_field_settings.custom_field.description"|"custom_field_settings.custom_field.display_value"|"custom_field_settings.custom_field.enabled"|"custom_field_settings.custom_field.enum_options"|"custom_field_settings.custom_field.enum_options.color"|"custom_field_settings.custom_field.enum_options.enabled"|"custom_field_settings.custom_field.enum_options.name"|"custom_field_settings.custom_field.enum_value"|"custom_field_settings.custom_field.enum_value.color"|"custom_field_settings.custom_field.enum_value.enabled"|"custom_field_settings.custom_field.enum_value.name"|"custom_field_settings.custom_field.format"|"custom_field_settings.custom_field.has_notifications_enabled"|"custom_field_settings.custom_field.id_prefix"|"custom_field_settings.custom_field.is_formula_field"|"custom_field_settings.custom_field.is_global_to_workspace"|"custom_field_settings.custom_field.is_value_read_only"|"custom_field_settings.custom_field.multi_enum_values"|"custom_field_settings.custom_field.multi_enum_values.color"|"custom_field_settings.custom_field.multi_enum_values.enabled"|"custom_field_settings.custom_field.multi_enum_values.name"|"custom_field_settings.custom_field.name"|"custom_field_settings.custom_field.number_value"|"custom_field_settings.custom_field.people_value"|"custom_field_settings.custom_field.people_value.name"|"custom_field_settings.custom_field.precision"|"custom_field_settings.custom_field.representation_type"|"custom_field_settings.custom_field.resource_subtype"|"custom_field_settings.custom_field.text_value"|"custom_field_settings.custom_field.type"|"custom_field_settings.is_important"|"custom_field_settings.parent"|"custom_field_settings.parent.name"|"custom_field_settings.project"|"custom_field_settings.project.name"|"custom_fields"|"custom_fields.date_value"|"custom_fields.date_value.date"|"custom_fields.date_value.date_time"|"custom_fields.display_value"|"custom_fields.enabled"|"custom_fields.enum_options"|"custom_fields.enum_options.color"|"custom_fields.enum_options.enabled"|"custom_fields.enum_options.name"|"custom_fields.enum_value"|"custom_fields.enum_value.color"|"custom_fields.enum_value.enabled"|"custom_fields.enum_value.name"|"custom_fields.id_prefix"|"custom_fields.is_formula_field"|"custom_fields.multi_enum_values"|"custom_fields.multi_enum_values.color"|"custom_fields.multi_enum_values.enabled"|"custom_fields.multi_enum_values.name"|"custom_fields.name"|"custom_fields.number_value"|"custom_fields.representation_type"|"custom_fields.resource_subtype"|"custom_fields.text_value"|"custom_fields.type"|"default_access_level"|"default_view"|"due_date"|"due_on"|"followers"|"followers.name"|"html_notes"|"icon"|"members"|"members.name"|"minimum_access_level_for_customization"|"minimum_access_level_for_sharing"|"modified_at"|"name"|"notes"|"owner"|"permalink_url"|"privacy_setting"|"project_brief"|"public"|"start_on"|"team"|"team.name"|"workspace"|"workspace.name")[]? opt_fields) returns Inline_response_201_5|error
Create a project
Parameters
- payload Projects_body - The project to create.
- opt_pretty boolean? (default ()) - 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 ("archived"|"color"|"completed"|"completed_at"|"completed_by"|"completed_by.name"|"created_at"|"created_from_template"|"created_from_template.name"|"current_status"|"current_status.author"|"current_status.author.name"|"current_status.color"|"current_status.created_at"|"current_status.created_by"|"current_status.created_by.name"|"current_status.html_text"|"current_status.modified_at"|"current_status.text"|"current_status.title"|"current_status_update"|"current_status_update.resource_subtype"|"current_status_update.title"|"custom_field_settings"|"custom_field_settings.custom_field"|"custom_field_settings.custom_field.asana_created_field"|"custom_field_settings.custom_field.created_by"|"custom_field_settings.custom_field.created_by.name"|"custom_field_settings.custom_field.currency_code"|"custom_field_settings.custom_field.custom_label"|"custom_field_settings.custom_field.custom_label_position"|"custom_field_settings.custom_field.date_value"|"custom_field_settings.custom_field.date_value.date"|"custom_field_settings.custom_field.date_value.date_time"|"custom_field_settings.custom_field.description"|"custom_field_settings.custom_field.display_value"|"custom_field_settings.custom_field.enabled"|"custom_field_settings.custom_field.enum_options"|"custom_field_settings.custom_field.enum_options.color"|"custom_field_settings.custom_field.enum_options.enabled"|"custom_field_settings.custom_field.enum_options.name"|"custom_field_settings.custom_field.enum_value"|"custom_field_settings.custom_field.enum_value.color"|"custom_field_settings.custom_field.enum_value.enabled"|"custom_field_settings.custom_field.enum_value.name"|"custom_field_settings.custom_field.format"|"custom_field_settings.custom_field.has_notifications_enabled"|"custom_field_settings.custom_field.id_prefix"|"custom_field_settings.custom_field.is_formula_field"|"custom_field_settings.custom_field.is_global_to_workspace"|"custom_field_settings.custom_field.is_value_read_only"|"custom_field_settings.custom_field.multi_enum_values"|"custom_field_settings.custom_field.multi_enum_values.color"|"custom_field_settings.custom_field.multi_enum_values.enabled"|"custom_field_settings.custom_field.multi_enum_values.name"|"custom_field_settings.custom_field.name"|"custom_field_settings.custom_field.number_value"|"custom_field_settings.custom_field.people_value"|"custom_field_settings.custom_field.people_value.name"|"custom_field_settings.custom_field.precision"|"custom_field_settings.custom_field.representation_type"|"custom_field_settings.custom_field.resource_subtype"|"custom_field_settings.custom_field.text_value"|"custom_field_settings.custom_field.type"|"custom_field_settings.is_important"|"custom_field_settings.parent"|"custom_field_settings.parent.name"|"custom_field_settings.project"|"custom_field_settings.project.name"|"custom_fields"|"custom_fields.date_value"|"custom_fields.date_value.date"|"custom_fields.date_value.date_time"|"custom_fields.display_value"|"custom_fields.enabled"|"custom_fields.enum_options"|"custom_fields.enum_options.color"|"custom_fields.enum_options.enabled"|"custom_fields.enum_options.name"|"custom_fields.enum_value"|"custom_fields.enum_value.color"|"custom_fields.enum_value.enabled"|"custom_fields.enum_value.name"|"custom_fields.id_prefix"|"custom_fields.is_formula_field"|"custom_fields.multi_enum_values"|"custom_fields.multi_enum_values.color"|"custom_fields.multi_enum_values.enabled"|"custom_fields.multi_enum_values.name"|"custom_fields.name"|"custom_fields.number_value"|"custom_fields.representation_type"|"custom_fields.resource_subtype"|"custom_fields.text_value"|"custom_fields.type"|"default_access_level"|"default_view"|"due_date"|"due_on"|"followers"|"followers.name"|"html_notes"|"icon"|"members"|"members.name"|"minimum_access_level_for_customization"|"minimum_access_level_for_sharing"|"modified_at"|"name"|"notes"|"owner"|"permalink_url"|"privacy_setting"|"project_brief"|"public"|"start_on"|"team"|"team.name"|"workspace"|"workspace.name")[]? (default ()) - This endpoint returns a compact 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.
Return Type
- Inline_response_201_5|error - Successfully retrieved projects.
get projects/[string project_gid]
function get projects/[string project_gid](boolean? opt_pretty, ("archived"|"color"|"completed"|"completed_at"|"completed_by"|"completed_by.name"|"created_at"|"created_from_template"|"created_from_template.name"|"current_status"|"current_status.author"|"current_status.author.name"|"current_status.color"|"current_status.created_at"|"current_status.created_by"|"current_status.created_by.name"|"current_status.html_text"|"current_status.modified_at"|"current_status.text"|"current_status.title"|"current_status_update"|"current_status_update.resource_subtype"|"current_status_update.title"|"custom_field_settings"|"custom_field_settings.custom_field"|"custom_field_settings.custom_field.asana_created_field"|"custom_field_settings.custom_field.created_by"|"custom_field_settings.custom_field.created_by.name"|"custom_field_settings.custom_field.currency_code"|"custom_field_settings.custom_field.custom_label"|"custom_field_settings.custom_field.custom_label_position"|"custom_field_settings.custom_field.date_value"|"custom_field_settings.custom_field.date_value.date"|"custom_field_settings.custom_field.date_value.date_time"|"custom_field_settings.custom_field.description"|"custom_field_settings.custom_field.display_value"|"custom_field_settings.custom_field.enabled"|"custom_field_settings.custom_field.enum_options"|"custom_field_settings.custom_field.enum_options.color"|"custom_field_settings.custom_field.enum_options.enabled"|"custom_field_settings.custom_field.enum_options.name"|"custom_field_settings.custom_field.enum_value"|"custom_field_settings.custom_field.enum_value.color"|"custom_field_settings.custom_field.enum_value.enabled"|"custom_field_settings.custom_field.enum_value.name"|"custom_field_settings.custom_field.format"|"custom_field_settings.custom_field.has_notifications_enabled"|"custom_field_settings.custom_field.id_prefix"|"custom_field_settings.custom_field.is_formula_field"|"custom_field_settings.custom_field.is_global_to_workspace"|"custom_field_settings.custom_field.is_value_read_only"|"custom_field_settings.custom_field.multi_enum_values"|"custom_field_settings.custom_field.multi_enum_values.color"|"custom_field_settings.custom_field.multi_enum_values.enabled"|"custom_field_settings.custom_field.multi_enum_values.name"|"custom_field_settings.custom_field.name"|"custom_field_settings.custom_field.number_value"|"custom_field_settings.custom_field.people_value"|"custom_field_settings.custom_field.people_value.name"|"custom_field_settings.custom_field.precision"|"custom_field_settings.custom_field.representation_type"|"custom_field_settings.custom_field.resource_subtype"|"custom_field_settings.custom_field.text_value"|"custom_field_settings.custom_field.type"|"custom_field_settings.is_important"|"custom_field_settings.parent"|"custom_field_settings.parent.name"|"custom_field_settings.project"|"custom_field_settings.project.name"|"custom_fields"|"custom_fields.date_value"|"custom_fields.date_value.date"|"custom_fields.date_value.date_time"|"custom_fields.display_value"|"custom_fields.enabled"|"custom_fields.enum_options"|"custom_fields.enum_options.color"|"custom_fields.enum_options.enabled"|"custom_fields.enum_options.name"|"custom_fields.enum_value"|"custom_fields.enum_value.color"|"custom_fields.enum_value.enabled"|"custom_fields.enum_value.name"|"custom_fields.id_prefix"|"custom_fields.is_formula_field"|"custom_fields.multi_enum_values"|"custom_fields.multi_enum_values.color"|"custom_fields.multi_enum_values.enabled"|"custom_fields.multi_enum_values.name"|"custom_fields.name"|"custom_fields.number_value"|"custom_fields.representation_type"|"custom_fields.resource_subtype"|"custom_fields.text_value"|"custom_fields.type"|"default_access_level"|"default_view"|"due_date"|"due_on"|"followers"|"followers.name"|"html_notes"|"icon"|"members"|"members.name"|"minimum_access_level_for_customization"|"minimum_access_level_for_sharing"|"modified_at"|"name"|"notes"|"owner"|"permalink_url"|"privacy_setting"|"project_brief"|"public"|"start_on"|"team"|"team.name"|"workspace"|"workspace.name")[]? opt_fields) returns Inline_response_201_5|error
Get a project
Parameters
- opt_pretty boolean? (default ()) - 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 ("archived"|"color"|"completed"|"completed_at"|"completed_by"|"completed_by.name"|"created_at"|"created_from_template"|"created_from_template.name"|"current_status"|"current_status.author"|"current_status.author.name"|"current_status.color"|"current_status.created_at"|"current_status.created_by"|"current_status.created_by.name"|"current_status.html_text"|"current_status.modified_at"|"current_status.text"|"current_status.title"|"current_status_update"|"current_status_update.resource_subtype"|"current_status_update.title"|"custom_field_settings"|"custom_field_settings.custom_field"|"custom_field_settings.custom_field.asana_created_field"|"custom_field_settings.custom_field.created_by"|"custom_field_settings.custom_field.created_by.name"|"custom_field_settings.custom_field.currency_code"|"custom_field_settings.custom_field.custom_label"|"custom_field_settings.custom_field.custom_label_position"|"custom_field_settings.custom_field.date_value"|"custom_field_settings.custom_field.date_value.date"|"custom_field_settings.custom_field.date_value.date_time"|"custom_field_settings.custom_field.description"|"custom_field_settings.custom_field.display_value"|"custom_field_settings.custom_field.enabled"|"custom_field_settings.custom_field.enum_options"|"custom_field_settings.custom_field.enum_options.color"|"custom_field_settings.custom_field.enum_options.enabled"|"custom_field_settings.custom_field.enum_options.name"|"custom_field_settings.custom_field.enum_value"|"custom_field_settings.custom_field.enum_value.color"|"custom_field_settings.custom_field.enum_value.enabled"|"custom_field_settings.custom_field.enum_value.name"|"custom_field_settings.custom_field.format"|"custom_field_settings.custom_field.has_notifications_enabled"|"custom_field_settings.custom_field.id_prefix"|"custom_field_settings.custom_field.is_formula_field"|"custom_field_settings.custom_field.is_global_to_workspace"|"custom_field_settings.custom_field.is_value_read_only"|"custom_field_settings.custom_field.multi_enum_values"|"custom_field_settings.custom_field.multi_enum_values.color"|"custom_field_settings.custom_field.multi_enum_values.enabled"|"custom_field_settings.custom_field.multi_enum_values.name"|"custom_field_settings.custom_field.name"|"custom_field_settings.custom_field.number_value"|"custom_field_settings.custom_field.people_value"|"custom_field_settings.custom_field.people_value.name"|"custom_field_settings.custom_field.precision"|"custom_field_settings.custom_field.representation_type"|"custom_field_settings.custom_field.resource_subtype"|"custom_field_settings.custom_field.text_value"|"custom_field_settings.custom_field.type"|"custom_field_settings.is_important"|"custom_field_settings.parent"|"custom_field_settings.parent.name"|"custom_field_settings.project"|"custom_field_settings.project.name"|"custom_fields"|"custom_fields.date_value"|"custom_fields.date_value.date"|"custom_fields.date_value.date_time"|"custom_fields.display_value"|"custom_fields.enabled"|"custom_fields.enum_options"|"custom_fields.enum_options.color"|"custom_fields.enum_options.enabled"|"custom_fields.enum_options.name"|"custom_fields.enum_value"|"custom_fields.enum_value.color"|"custom_fields.enum_value.enabled"|"custom_fields.enum_value.name"|"custom_fields.id_prefix"|"custom_fields.is_formula_field"|"custom_fields.multi_enum_values"|"custom_fields.multi_enum_values.color"|"custom_fields.multi_enum_values.enabled"|"custom_fields.multi_enum_values.name"|"custom_fields.name"|"custom_fields.number_value"|"custom_fields.representation_type"|"custom_fields.resource_subtype"|"custom_fields.text_value"|"custom_fields.type"|"default_access_level"|"default_view"|"due_date"|"due_on"|"followers"|"followers.name"|"html_notes"|"icon"|"members"|"members.name"|"minimum_access_level_for_customization"|"minimum_access_level_for_sharing"|"modified_at"|"name"|"notes"|"owner"|"permalink_url"|"privacy_setting"|"project_brief"|"public"|"start_on"|"team"|"team.name"|"workspace"|"workspace.name")[]? (default ()) - This endpoint returns a compact 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.
Return Type
- Inline_response_201_5|error - Successfully retrieved the requested project.
put projects/[string project_gid]
function put projects/[string project_gid](Projects_project_gid_body payload, boolean? opt_pretty, ("archived"|"color"|"completed"|"completed_at"|"completed_by"|"completed_by.name"|"created_at"|"created_from_template"|"created_from_template.name"|"current_status"|"current_status.author"|"current_status.author.name"|"current_status.color"|"current_status.created_at"|"current_status.created_by"|"current_status.created_by.name"|"current_status.html_text"|"current_status.modified_at"|"current_status.text"|"current_status.title"|"current_status_update"|"current_status_update.resource_subtype"|"current_status_update.title"|"custom_field_settings"|"custom_field_settings.custom_field"|"custom_field_settings.custom_field.asana_created_field"|"custom_field_settings.custom_field.created_by"|"custom_field_settings.custom_field.created_by.name"|"custom_field_settings.custom_field.currency_code"|"custom_field_settings.custom_field.custom_label"|"custom_field_settings.custom_field.custom_label_position"|"custom_field_settings.custom_field.date_value"|"custom_field_settings.custom_field.date_value.date"|"custom_field_settings.custom_field.date_value.date_time"|"custom_field_settings.custom_field.description"|"custom_field_settings.custom_field.display_value"|"custom_field_settings.custom_field.enabled"|"custom_field_settings.custom_field.enum_options"|"custom_field_settings.custom_field.enum_options.color"|"custom_field_settings.custom_field.enum_options.enabled"|"custom_field_settings.custom_field.enum_options.name"|"custom_field_settings.custom_field.enum_value"|"custom_field_settings.custom_field.enum_value.color"|"custom_field_settings.custom_field.enum_value.enabled"|"custom_field_settings.custom_field.enum_value.name"|"custom_field_settings.custom_field.format"|"custom_field_settings.custom_field.has_notifications_enabled"|"custom_field_settings.custom_field.id_prefix"|"custom_field_settings.custom_field.is_formula_field"|"custom_field_settings.custom_field.is_global_to_workspace"|"custom_field_settings.custom_field.is_value_read_only"|"custom_field_settings.custom_field.multi_enum_values"|"custom_field_settings.custom_field.multi_enum_values.color"|"custom_field_settings.custom_field.multi_enum_values.enabled"|"custom_field_settings.custom_field.multi_enum_values.name"|"custom_field_settings.custom_field.name"|"custom_field_settings.custom_field.number_value"|"custom_field_settings.custom_field.people_value"|"custom_field_settings.custom_field.people_value.name"|"custom_field_settings.custom_field.precision"|"custom_field_settings.custom_field.representation_type"|"custom_field_settings.custom_field.resource_subtype"|"custom_field_settings.custom_field.text_value"|"custom_field_settings.custom_field.type"|"custom_field_settings.is_important"|"custom_field_settings.parent"|"custom_field_settings.parent.name"|"custom_field_settings.project"|"custom_field_settings.project.name"|"custom_fields"|"custom_fields.date_value"|"custom_fields.date_value.date"|"custom_fields.date_value.date_time"|"custom_fields.display_value"|"custom_fields.enabled"|"custom_fields.enum_options"|"custom_fields.enum_options.color"|"custom_fields.enum_options.enabled"|"custom_fields.enum_options.name"|"custom_fields.enum_value"|"custom_fields.enum_value.color"|"custom_fields.enum_value.enabled"|"custom_fields.enum_value.name"|"custom_fields.id_prefix"|"custom_fields.is_formula_field"|"custom_fields.multi_enum_values"|"custom_fields.multi_enum_values.color"|"custom_fields.multi_enum_values.enabled"|"custom_fields.multi_enum_values.name"|"custom_fields.name"|"custom_fields.number_value"|"custom_fields.representation_type"|"custom_fields.resource_subtype"|"custom_fields.text_value"|"custom_fields.type"|"default_access_level"|"default_view"|"due_date"|"due_on"|"followers"|"followers.name"|"html_notes"|"icon"|"members"|"members.name"|"minimum_access_level_for_customization"|"minimum_access_level_for_sharing"|"modified_at"|"name"|"notes"|"owner"|"permalink_url"|"privacy_setting"|"project_brief"|"public"|"start_on"|"team"|"team.name"|"workspace"|"workspace.name")[]? opt_fields) returns Inline_response_201_5|error
Update a project
Parameters
- payload Projects_project_gid_body - The updated fields for the project.
- opt_pretty boolean? (default ()) - 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 ("archived"|"color"|"completed"|"completed_at"|"completed_by"|"completed_by.name"|"created_at"|"created_from_template"|"created_from_template.name"|"current_status"|"current_status.author"|"current_status.author.name"|"current_status.color"|"current_status.created_at"|"current_status.created_by"|"current_status.created_by.name"|"current_status.html_text"|"current_status.modified_at"|"current_status.text"|"current_status.title"|"current_status_update"|"current_status_update.resource_subtype"|"current_status_update.title"|"custom_field_settings"|"custom_field_settings.custom_field"|"custom_field_settings.custom_field.asana_created_field"|"custom_field_settings.custom_field.created_by"|"custom_field_settings.custom_field.created_by.name"|"custom_field_settings.custom_field.currency_code"|"custom_field_settings.custom_field.custom_label"|"custom_field_settings.custom_field.custom_label_position"|"custom_field_settings.custom_field.date_value"|"custom_field_settings.custom_field.date_value.date"|"custom_field_settings.custom_field.date_value.date_time"|"custom_field_settings.custom_field.description"|"custom_field_settings.custom_field.display_value"|"custom_field_settings.custom_field.enabled"|"custom_field_settings.custom_field.enum_options"|"custom_field_settings.custom_field.enum_options.color"|"custom_field_settings.custom_field.enum_options.enabled"|"custom_field_settings.custom_field.enum_options.name"|"custom_field_settings.custom_field.enum_value"|"custom_field_settings.custom_field.enum_value.color"|"custom_field_settings.custom_field.enum_value.enabled"|"custom_field_settings.custom_field.enum_value.name"|"custom_field_settings.custom_field.format"|"custom_field_settings.custom_field.has_notifications_enabled"|"custom_field_settings.custom_field.id_prefix"|"custom_field_settings.custom_field.is_formula_field"|"custom_field_settings.custom_field.is_global_to_workspace"|"custom_field_settings.custom_field.is_value_read_only"|"custom_field_settings.custom_field.multi_enum_values"|"custom_field_settings.custom_field.multi_enum_values.color"|"custom_field_settings.custom_field.multi_enum_values.enabled"|"custom_field_settings.custom_field.multi_enum_values.name"|"custom_field_settings.custom_field.name"|"custom_field_settings.custom_field.number_value"|"custom_field_settings.custom_field.people_value"|"custom_field_settings.custom_field.people_value.name"|"custom_field_settings.custom_field.precision"|"custom_field_settings.custom_field.representation_type"|"custom_field_settings.custom_field.resource_subtype"|"custom_field_settings.custom_field.text_value"|"custom_field_settings.custom_field.type"|"custom_field_settings.is_important"|"custom_field_settings.parent"|"custom_field_settings.parent.name"|"custom_field_settings.project"|"custom_field_settings.project.name"|"custom_fields"|"custom_fields.date_value"|"custom_fields.date_value.date"|"custom_fields.date_value.date_time"|"custom_fields.display_value"|"custom_fields.enabled"|"custom_fields.enum_options"|"custom_fields.enum_options.color"|"custom_fields.enum_options.enabled"|"custom_fields.enum_options.name"|"custom_fields.enum_value"|"custom_fields.enum_value.color"|"custom_fields.enum_value.enabled"|"custom_fields.enum_value.name"|"custom_fields.id_prefix"|"custom_fields.is_formula_field"|"custom_fields.multi_enum_values"|"custom_fields.multi_enum_values.color"|"custom_fields.multi_enum_values.enabled"|"custom_fields.multi_enum_values.name"|"custom_fields.name"|"custom_fields.number_value"|"custom_fields.representation_type"|"custom_fields.resource_subtype"|"custom_fields.text_value"|"custom_fields.type"|"default_access_level"|"default_view"|"due_date"|"due_on"|"followers"|"followers.name"|"html_notes"|"icon"|"members"|"members.name"|"minimum_access_level_for_customization"|"minimum_access_level_for_sharing"|"modified_at"|"name"|"notes"|"owner"|"permalink_url"|"privacy_setting"|"project_brief"|"public"|"start_on"|"team"|"team.name"|"workspace"|"workspace.name")[]? (default ()) - This endpoint returns a compact 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.
Return Type
- Inline_response_201_5|error - Successfully updated the project.
delete projects/[string project_gid]
function delete projects/[string project_gid](boolean? opt_pretty) returns Inline_response_200_1|error
Delete a project
Parameters
- opt_pretty boolean? (default ()) - 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.
Return Type
- Inline_response_200_1|error - Successfully deleted the specified project.
post projects/[string project_gid]/duplicate
function post projects/[string project_gid]/duplicate(Project_gid_duplicate_body payload, boolean? opt_pretty, ("new_project"|"new_project.name"|"new_project_template"|"new_project_template.name"|"new_task"|"new_task.created_by"|"new_task.name"|"new_task.resource_subtype"|"new_task_template"|"new_task_template.name"|"resource_subtype"|"status")[]? opt_fields) returns Inline_response_200_13|error
Duplicate a project
Parameters
- payload Project_gid_duplicate_body - Describes the duplicate's name and the elements that will be duplicated.
- opt_pretty boolean? (default ()) - 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 ("new_project"|"new_project.name"|"new_project_template"|"new_project_template.name"|"new_task"|"new_task.created_by"|"new_task.name"|"new_task.resource_subtype"|"new_task_template"|"new_task_template.name"|"resource_subtype"|"status")[]? (default ()) - This endpoint returns a compact 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.
Return Type
- Inline_response_200_13|error - Successfully created the job to handle duplication.
get tasks/[string task_gid]/projects
function get tasks/[string task_gid]/projects(boolean? opt_pretty, int? 'limit, string? offset, ("archived"|"color"|"completed"|"completed_at"|"completed_by"|"completed_by.name"|"created_at"|"created_from_template"|"created_from_template.name"|"current_status"|"current_status.author"|"current_status.author.name"|"current_status.color"|"current_status.created_at"|"current_status.created_by"|"current_status.created_by.name"|"current_status.html_text"|"current_status.modified_at"|"current_status.text"|"current_status.title"|"current_status_update"|"current_status_update.resource_subtype"|"current_status_update.title"|"custom_field_settings"|"custom_field_settings.custom_field"|"custom_field_settings.custom_field.asana_created_field"|"custom_field_settings.custom_field.created_by"|"custom_field_settings.custom_field.created_by.name"|"custom_field_settings.custom_field.currency_code"|"custom_field_settings.custom_field.custom_label"|"custom_field_settings.custom_field.custom_label_position"|"custom_field_settings.custom_field.date_value"|"custom_field_settings.custom_field.date_value.date"|"custom_field_settings.custom_field.date_value.date_time"|"custom_field_settings.custom_field.description"|"custom_field_settings.custom_field.display_value"|"custom_field_settings.custom_field.enabled"|"custom_field_settings.custom_field.enum_options"|"custom_field_settings.custom_field.enum_options.color"|"custom_field_settings.custom_field.enum_options.enabled"|"custom_field_settings.custom_field.enum_options.name"|"custom_field_settings.custom_field.enum_value"|"custom_field_settings.custom_field.enum_value.color"|"custom_field_settings.custom_field.enum_value.enabled"|"custom_field_settings.custom_field.enum_value.name"|"custom_field_settings.custom_field.format"|"custom_field_settings.custom_field.has_notifications_enabled"|"custom_field_settings.custom_field.id_prefix"|"custom_field_settings.custom_field.is_formula_field"|"custom_field_settings.custom_field.is_global_to_workspace"|"custom_field_settings.custom_field.is_value_read_only"|"custom_field_settings.custom_field.multi_enum_values"|"custom_field_settings.custom_field.multi_enum_values.color"|"custom_field_settings.custom_field.multi_enum_values.enabled"|"custom_field_settings.custom_field.multi_enum_values.name"|"custom_field_settings.custom_field.name"|"custom_field_settings.custom_field.number_value"|"custom_field_settings.custom_field.people_value"|"custom_field_settings.custom_field.people_value.name"|"custom_field_settings.custom_field.precision"|"custom_field_settings.custom_field.representation_type"|"custom_field_settings.custom_field.resource_subtype"|"custom_field_settings.custom_field.text_value"|"custom_field_settings.custom_field.type"|"custom_field_settings.is_important"|"custom_field_settings.parent"|"custom_field_settings.parent.name"|"custom_field_settings.project"|"custom_field_settings.project.name"|"custom_fields"|"custom_fields.date_value"|"custom_fields.date_value.date"|"custom_fields.date_value.date_time"|"custom_fields.display_value"|"custom_fields.enabled"|"custom_fields.enum_options"|"custom_fields.enum_options.color"|"custom_fields.enum_options.enabled"|"custom_fields.enum_options.name"|"custom_fields.enum_value"|"custom_fields.enum_value.color"|"custom_fields.enum_value.enabled"|"custom_fields.enum_value.name"|"custom_fields.id_prefix"|"custom_fields.is_formula_field"|"custom_fields.multi_enum_values"|"custom_fields.multi_enum_values.color"|"custom_fields.multi_enum_values.enabled"|"custom_fields.multi_enum_values.name"|"custom_fields.name"|"custom_fields.number_value"|"custom_fields.representation_type"|"custom_fields.resource_subtype"|"custom_fields.text_value"|"custom_fields.type"|"default_access_level"|"default_view"|"due_date"|"due_on"|"followers"|"followers.name"|"html_notes"|"icon"|"members"|"members.name"|"minimum_access_level_for_customization"|"minimum_access_level_for_sharing"|"modified_at"|"name"|"notes"|"offset"|"owner"|"path"|"permalink_url"|"privacy_setting"|"project_brief"|"public"|"start_on"|"team"|"team.name"|"uri"|"workspace"|"workspace.name")[]? opt_fields) returns Inline_response_200_19|error
Get projects a task is in
Parameters
- opt_pretty boolean? (default ()) - 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.
- 'limit int? (default ()) - Results per page. The number of objects to return per page. The value must be between 1 and 100.
- offset string? (default ()) - Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.'
- opt_fields ("archived"|"color"|"completed"|"completed_at"|"completed_by"|"completed_by.name"|"created_at"|"created_from_template"|"created_from_template.name"|"current_status"|"current_status.author"|"current_status.author.name"|"current_status.color"|"current_status.created_at"|"current_status.created_by"|"current_status.created_by.name"|"current_status.html_text"|"current_status.modified_at"|"current_status.text"|"current_status.title"|"current_status_update"|"current_status_update.resource_subtype"|"current_status_update.title"|"custom_field_settings"|"custom_field_settings.custom_field"|"custom_field_settings.custom_field.asana_created_field"|"custom_field_settings.custom_field.created_by"|"custom_field_settings.custom_field.created_by.name"|"custom_field_settings.custom_field.currency_code"|"custom_field_settings.custom_field.custom_label"|"custom_field_settings.custom_field.custom_label_position"|"custom_field_settings.custom_field.date_value"|"custom_field_settings.custom_field.date_value.date"|"custom_field_settings.custom_field.date_value.date_time"|"custom_field_settings.custom_field.description"|"custom_field_settings.custom_field.display_value"|"custom_field_settings.custom_field.enabled"|"custom_field_settings.custom_field.enum_options"|"custom_field_settings.custom_field.enum_options.color"|"custom_field_settings.custom_field.enum_options.enabled"|"custom_field_settings.custom_field.enum_options.name"|"custom_field_settings.custom_field.enum_value"|"custom_field_settings.custom_field.enum_value.color"|"custom_field_settings.custom_field.enum_value.enabled"|"custom_field_settings.custom_field.enum_value.name"|"custom_field_settings.custom_field.format"|"custom_field_settings.custom_field.has_notifications_enabled"|"custom_field_settings.custom_field.id_prefix"|"custom_field_settings.custom_field.is_formula_field"|"custom_field_settings.custom_field.is_global_to_workspace"|"custom_field_settings.custom_field.is_value_read_only"|"custom_field_settings.custom_field.multi_enum_values"|"custom_field_settings.custom_field.multi_enum_values.color"|"custom_field_settings.custom_field.multi_enum_values.enabled"|"custom_field_settings.custom_field.multi_enum_values.name"|"custom_field_settings.custom_field.name"|"custom_field_settings.custom_field.number_value"|"custom_field_settings.custom_field.people_value"|"custom_field_settings.custom_field.people_value.name"|"custom_field_settings.custom_field.precision"|"custom_field_settings.custom_field.representation_type"|"custom_field_settings.custom_field.resource_subtype"|"custom_field_settings.custom_field.text_value"|"custom_field_settings.custom_field.type"|"custom_field_settings.is_important"|"custom_field_settings.parent"|"custom_field_settings.parent.name"|"custom_field_settings.project"|"custom_field_settings.project.name"|"custom_fields"|"custom_fields.date_value"|"custom_fields.date_value.date"|"custom_fields.date_value.date_time"|"custom_fields.display_value"|"custom_fields.enabled"|"custom_fields.enum_options"|"custom_fields.enum_options.color"|"custom_fields.enum_options.enabled"|"custom_fields.enum_options.name"|"custom_fields.enum_value"|"custom_fields.enum_value.color"|"custom_fields.enum_value.enabled"|"custom_fields.enum_value.name"|"custom_fields.id_prefix"|"custom_fields.is_formula_field"|"custom_fields.multi_enum_values"|"custom_fields.multi_enum_values.color"|"custom_fields.multi_enum_values.enabled"|"custom_fields.multi_enum_values.name"|"custom_fields.name"|"custom_fields.number_value"|"custom_fields.representation_type"|"custom_fields.resource_subtype"|"custom_fields.text_value"|"custom_fields.type"|"default_access_level"|"default_view"|"due_date"|"due_on"|"followers"|"followers.name"|"html_notes"|"icon"|"members"|"members.name"|"minimum_access_level_for_customization"|"minimum_access_level_for_sharing"|"modified_at"|"name"|"notes"|"offset"|"owner"|"path"|"permalink_url"|"privacy_setting"|"project_brief"|"public"|"start_on"|"team"|"team.name"|"uri"|"workspace"|"workspace.name")[]? (default ()) - This endpoint returns a compact 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.
Return Type
- Inline_response_200_19|error - Successfully retrieved the projects for the given task.
get teams/[string team_gid]/projects
function get teams/[string team_gid]/projects(boolean? opt_pretty, int? 'limit, string? offset, boolean? archived, ("archived"|"color"|"completed"|"completed_at"|"completed_by"|"completed_by.name"|"created_at"|"created_from_template"|"created_from_template.name"|"current_status"|"current_status.author"|"current_status.author.name"|"current_status.color"|"current_status.created_at"|"current_status.created_by"|"current_status.created_by.name"|"current_status.html_text"|"current_status.modified_at"|"current_status.text"|"current_status.title"|"current_status_update"|"current_status_update.resource_subtype"|"current_status_update.title"|"custom_field_settings"|"custom_field_settings.custom_field"|"custom_field_settings.custom_field.asana_created_field"|"custom_field_settings.custom_field.created_by"|"custom_field_settings.custom_field.created_by.name"|"custom_field_settings.custom_field.currency_code"|"custom_field_settings.custom_field.custom_label"|"custom_field_settings.custom_field.custom_label_position"|"custom_field_settings.custom_field.date_value"|"custom_field_settings.custom_field.date_value.date"|"custom_field_settings.custom_field.date_value.date_time"|"custom_field_settings.custom_field.description"|"custom_field_settings.custom_field.display_value"|"custom_field_settings.custom_field.enabled"|"custom_field_settings.custom_field.enum_options"|"custom_field_settings.custom_field.enum_options.color"|"custom_field_settings.custom_field.enum_options.enabled"|"custom_field_settings.custom_field.enum_options.name"|"custom_field_settings.custom_field.enum_value"|"custom_field_settings.custom_field.enum_value.color"|"custom_field_settings.custom_field.enum_value.enabled"|"custom_field_settings.custom_field.enum_value.name"|"custom_field_settings.custom_field.format"|"custom_field_settings.custom_field.has_notifications_enabled"|"custom_field_settings.custom_field.id_prefix"|"custom_field_settings.custom_field.is_formula_field"|"custom_field_settings.custom_field.is_global_to_workspace"|"custom_field_settings.custom_field.is_value_read_only"|"custom_field_settings.custom_field.multi_enum_values"|"custom_field_settings.custom_field.multi_enum_values.color"|"custom_field_settings.custom_field.multi_enum_values.enabled"|"custom_field_settings.custom_field.multi_enum_values.name"|"custom_field_settings.custom_field.name"|"custom_field_settings.custom_field.number_value"|"custom_field_settings.custom_field.people_value"|"custom_field_settings.custom_field.people_value.name"|"custom_field_settings.custom_field.precision"|"custom_field_settings.custom_field.representation_type"|"custom_field_settings.custom_field.resource_subtype"|"custom_field_settings.custom_field.text_value"|"custom_field_settings.custom_field.type"|"custom_field_settings.is_important"|"custom_field_settings.parent"|"custom_field_settings.parent.name"|"custom_field_settings.project"|"custom_field_settings.project.name"|"custom_fields"|"custom_fields.date_value"|"custom_fields.date_value.date"|"custom_fields.date_value.date_time"|"custom_fields.display_value"|"custom_fields.enabled"|"custom_fields.enum_options"|"custom_fields.enum_options.color"|"custom_fields.enum_options.enabled"|"custom_fields.enum_options.name"|"custom_fields.enum_value"|"custom_fields.enum_value.color"|"custom_fields.enum_value.enabled"|"custom_fields.enum_value.name"|"custom_fields.id_prefix"|"custom_fields.is_formula_field"|"custom_fields.multi_enum_values"|"custom_fields.multi_enum_values.color"|"custom_fields.multi_enum_values.enabled"|"custom_fields.multi_enum_values.name"|"custom_fields.name"|"custom_fields.number_value"|"custom_fields.representation_type"|"custom_fields.resource_subtype"|"custom_fields.text_value"|"custom_fields.type"|"default_access_level"|"default_view"|"due_date"|"due_on"|"followers"|"followers.name"|"html_notes"|"icon"|"members"|"members.name"|"minimum_access_level_for_customization"|"minimum_access_level_for_sharing"|"modified_at"|"name"|"notes"|"offset"|"owner"|"path"|"permalink_url"|"privacy_setting"|"project_brief"|"public"|"start_on"|"team"|"team.name"|"uri"|"workspace"|"workspace.name")[]? opt_fields) returns Inline_response_200_19|error
Get a team's projects
Parameters
- opt_pretty boolean? (default ()) - 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.
- 'limit int? (default ()) - Results per page. The number of objects to return per page. The value must be between 1 and 100.
- offset string? (default ()) - Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.'
- archived boolean? (default ()) - Only return projects whose
archived
field takes on the value of this parameter.
- opt_fields ("archived"|"color"|"completed"|"completed_at"|"completed_by"|"completed_by.name"|"created_at"|"created_from_template"|"created_from_template.name"|"current_status"|"current_status.author"|"current_status.author.name"|"current_status.color"|"current_status.created_at"|"current_status.created_by"|"current_status.created_by.name"|"current_status.html_text"|"current_status.modified_at"|"current_status.text"|"current_status.title"|"current_status_update"|"current_status_update.resource_subtype"|"current_status_update.title"|"custom_field_settings"|"custom_field_settings.custom_field"|"custom_field_settings.custom_field.asana_created_field"|"custom_field_settings.custom_field.created_by"|"custom_field_settings.custom_field.created_by.name"|"custom_field_settings.custom_field.currency_code"|"custom_field_settings.custom_field.custom_label"|"custom_field_settings.custom_field.custom_label_position"|"custom_field_settings.custom_field.date_value"|"custom_field_settings.custom_field.date_value.date"|"custom_field_settings.custom_field.date_value.date_time"|"custom_field_settings.custom_field.description"|"custom_field_settings.custom_field.display_value"|"custom_field_settings.custom_field.enabled"|"custom_field_settings.custom_field.enum_options"|"custom_field_settings.custom_field.enum_options.color"|"custom_field_settings.custom_field.enum_options.enabled"|"custom_field_settings.custom_field.enum_options.name"|"custom_field_settings.custom_field.enum_value"|"custom_field_settings.custom_field.enum_value.color"|"custom_field_settings.custom_field.enum_value.enabled"|"custom_field_settings.custom_field.enum_value.name"|"custom_field_settings.custom_field.format"|"custom_field_settings.custom_field.has_notifications_enabled"|"custom_field_settings.custom_field.id_prefix"|"custom_field_settings.custom_field.is_formula_field"|"custom_field_settings.custom_field.is_global_to_workspace"|"custom_field_settings.custom_field.is_value_read_only"|"custom_field_settings.custom_field.multi_enum_values"|"custom_field_settings.custom_field.multi_enum_values.color"|"custom_field_settings.custom_field.multi_enum_values.enabled"|"custom_field_settings.custom_field.multi_enum_values.name"|"custom_field_settings.custom_field.name"|"custom_field_settings.custom_field.number_value"|"custom_field_settings.custom_field.people_value"|"custom_field_settings.custom_field.people_value.name"|"custom_field_settings.custom_field.precision"|"custom_field_settings.custom_field.representation_type"|"custom_field_settings.custom_field.resource_subtype"|"custom_field_settings.custom_field.text_value"|"custom_field_settings.custom_field.type"|"custom_field_settings.is_important"|"custom_field_settings.parent"|"custom_field_settings.parent.name"|"custom_field_settings.project"|"custom_field_settings.project.name"|"custom_fields"|"custom_fields.date_value"|"custom_fields.date_value.date"|"custom_fields.date_value.date_time"|"custom_fields.display_value"|"custom_fields.enabled"|"custom_fields.enum_options"|"custom_fields.enum_options.color"|"custom_fields.enum_options.enabled"|"custom_fields.enum_options.name"|"custom_fields.enum_value"|"custom_fields.enum_value.color"|"custom_fields.enum_value.enabled"|"custom_fields.enum_value.name"|"custom_fields.id_prefix"|"custom_fields.is_formula_field"|"custom_fields.multi_enum_values"|"custom_fields.multi_enum_values.color"|"custom_fields.multi_enum_values.enabled"|"custom_fields.multi_enum_values.name"|"custom_fields.name"|"custom_fields.number_value"|"custom_fields.representation_type"|"custom_fields.resource_subtype"|"custom_fields.text_value"|"custom_fields.type"|"default_access_level"|"default_view"|"due_date"|"due_on"|"followers"|"followers.name"|"html_notes"|"icon"|"members"|"members.name"|"minimum_access_level_for_customization"|"minimum_access_level_for_sharing"|"modified_at"|"name"|"notes"|"offset"|"owner"|"path"|"permalink_url"|"privacy_setting"|"project_brief"|"public"|"start_on"|"team"|"team.name"|"uri"|"workspace"|"workspace.name")[]? (default ()) - This endpoint returns a compact 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.
Return Type
- Inline_response_200_19|error - Successfully retrieved the requested team's projects.
post teams/[string team_gid]/projects
function post teams/[string team_gid]/projects(Team_gid_projects_body payload, boolean? opt_pretty, ("archived"|"color"|"completed"|"completed_at"|"completed_by"|"completed_by.name"|"created_at"|"created_from_template"|"created_from_template.name"|"current_status"|"current_status.author"|"current_status.author.name"|"current_status.color"|"current_status.created_at"|"current_status.created_by"|"current_status.created_by.name"|"current_status.html_text"|"current_status.modified_at"|"current_status.text"|"current_status.title"|"current_status_update"|"current_status_update.resource_subtype"|"current_status_update.title"|"custom_field_settings"|"custom_field_settings.custom_field"|"custom_field_settings.custom_field.asana_created_field"|"custom_field_settings.custom_field.created_by"|"custom_field_settings.custom_field.created_by.name"|"custom_field_settings.custom_field.currency_code"|"custom_field_settings.custom_field.custom_label"|"custom_field_settings.custom_field.custom_label_position"|"custom_field_settings.custom_field.date_value"|"custom_field_settings.custom_field.date_value.date"|"custom_field_settings.custom_field.date_value.date_time"|"custom_field_settings.custom_field.description"|"custom_field_settings.custom_field.display_value"|"custom_field_settings.custom_field.enabled"|"custom_field_settings.custom_field.enum_options"|"custom_field_settings.custom_field.enum_options.color"|"custom_field_settings.custom_field.enum_options.enabled"|"custom_field_settings.custom_field.enum_options.name"|"custom_field_settings.custom_field.enum_value"|"custom_field_settings.custom_field.enum_value.color"|"custom_field_settings.custom_field.enum_value.enabled"|"custom_field_settings.custom_field.enum_value.name"|"custom_field_settings.custom_field.format"|"custom_field_settings.custom_field.has_notifications_enabled"|"custom_field_settings.custom_field.id_prefix"|"custom_field_settings.custom_field.is_formula_field"|"custom_field_settings.custom_field.is_global_to_workspace"|"custom_field_settings.custom_field.is_value_read_only"|"custom_field_settings.custom_field.multi_enum_values"|"custom_field_settings.custom_field.multi_enum_values.color"|"custom_field_settings.custom_field.multi_enum_values.enabled"|"custom_field_settings.custom_field.multi_enum_values.name"|"custom_field_settings.custom_field.name"|"custom_field_settings.custom_field.number_value"|"custom_field_settings.custom_field.people_value"|"custom_field_settings.custom_field.people_value.name"|"custom_field_settings.custom_field.precision"|"custom_field_settings.custom_field.representation_type"|"custom_field_settings.custom_field.resource_subtype"|"custom_field_settings.custom_field.text_value"|"custom_field_settings.custom_field.type"|"custom_field_settings.is_important"|"custom_field_settings.parent"|"custom_field_settings.parent.name"|"custom_field_settings.project"|"custom_field_settings.project.name"|"custom_fields"|"custom_fields.date_value"|"custom_fields.date_value.date"|"custom_fields.date_value.date_time"|"custom_fields.display_value"|"custom_fields.enabled"|"custom_fields.enum_options"|"custom_fields.enum_options.color"|"custom_fields.enum_options.enabled"|"custom_fields.enum_options.name"|"custom_fields.enum_value"|"custom_fields.enum_value.color"|"custom_fields.enum_value.enabled"|"custom_fields.enum_value.name"|"custom_fields.id_prefix"|"custom_fields.is_formula_field"|"custom_fields.multi_enum_values"|"custom_fields.multi_enum_values.color"|"custom_fields.multi_enum_values.enabled"|"custom_fields.multi_enum_values.name"|"custom_fields.name"|"custom_fields.number_value"|"custom_fields.representation_type"|"custom_fields.resource_subtype"|"custom_fields.text_value"|"custom_fields.type"|"default_access_level"|"default_view"|"due_date"|"due_on"|"followers"|"followers.name"|"html_notes"|"icon"|"members"|"members.name"|"minimum_access_level_for_customization"|"minimum_access_level_for_sharing"|"modified_at"|"name"|"notes"|"owner"|"permalink_url"|"privacy_setting"|"project_brief"|"public"|"start_on"|"team"|"team.name"|"workspace"|"workspace.name")[]? opt_fields) returns Inline_response_201_5|error
Create a project in a team
Parameters
- payload Team_gid_projects_body - The new project to create.
- opt_pretty boolean? (default ()) - 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 ("archived"|"color"|"completed"|"completed_at"|"completed_by"|"completed_by.name"|"created_at"|"created_from_template"|"created_from_template.name"|"current_status"|"current_status.author"|"current_status.author.name"|"current_status.color"|"current_status.created_at"|"current_status.created_by"|"current_status.created_by.name"|"current_status.html_text"|"current_status.modified_at"|"current_status.text"|"current_status.title"|"current_status_update"|"current_status_update.resource_subtype"|"current_status_update.title"|"custom_field_settings"|"custom_field_settings.custom_field"|"custom_field_settings.custom_field.asana_created_field"|"custom_field_settings.custom_field.created_by"|"custom_field_settings.custom_field.created_by.name"|"custom_field_settings.custom_field.currency_code"|"custom_field_settings.custom_field.custom_label"|"custom_field_settings.custom_field.custom_label_position"|"custom_field_settings.custom_field.date_value"|"custom_field_settings.custom_field.date_value.date"|"custom_field_settings.custom_field.date_value.date_time"|"custom_field_settings.custom_field.description"|"custom_field_settings.custom_field.display_value"|"custom_field_settings.custom_field.enabled"|"custom_field_settings.custom_field.enum_options"|"custom_field_settings.custom_field.enum_options.color"|"custom_field_settings.custom_field.enum_options.enabled"|"custom_field_settings.custom_field.enum_options.name"|"custom_field_settings.custom_field.enum_value"|"custom_field_settings.custom_field.enum_value.color"|"custom_field_settings.custom_field.enum_value.enabled"|"custom_field_settings.custom_field.enum_value.name"|"custom_field_settings.custom_field.format"|"custom_field_settings.custom_field.has_notifications_enabled"|"custom_field_settings.custom_field.id_prefix"|"custom_field_settings.custom_field.is_formula_field"|"custom_field_settings.custom_field.is_global_to_workspace"|"custom_field_settings.custom_field.is_value_read_only"|"custom_field_settings.custom_field.multi_enum_values"|"custom_field_settings.custom_field.multi_enum_values.color"|"custom_field_settings.custom_field.multi_enum_values.enabled"|"custom_field_settings.custom_field.multi_enum_values.name"|"custom_field_settings.custom_field.name"|"custom_field_settings.custom_field.number_value"|"custom_field_settings.custom_field.people_value"|"custom_field_settings.custom_field.people_value.name"|"custom_field_settings.custom_field.precision"|"custom_field_settings.custom_field.representation_type"|"custom_field_settings.custom_field.resource_subtype"|"custom_field_settings.custom_field.text_value"|"custom_field_settings.custom_field.type"|"custom_field_settings.is_important"|"custom_field_settings.parent"|"custom_field_settings.parent.name"|"custom_field_settings.project"|"custom_field_settings.project.name"|"custom_fields"|"custom_fields.date_value"|"custom_fields.date_value.date"|"custom_fields.date_value.date_time"|"custom_fields.display_value"|"custom_fields.enabled"|"custom_fields.enum_options"|"custom_fields.enum_options.color"|"custom_fields.enum_options.enabled"|"custom_fields.enum_options.name"|"custom_fields.enum_value"|"custom_fields.enum_value.color"|"custom_fields.enum_value.enabled"|"custom_fields.enum_value.name"|"custom_fields.id_prefix"|"custom_fields.is_formula_field"|"custom_fields.multi_enum_values"|"custom_fields.multi_enum_values.color"|"custom_fields.multi_enum_values.enabled"|"custom_fields.multi_enum_values.name"|"custom_fields.name"|"custom_fields.number_value"|"custom_fields.representation_type"|"custom_fields.resource_subtype"|"custom_fields.text_value"|"custom_fields.type"|"default_access_level"|"default_view"|"due_date"|"due_on"|"followers"|"followers.name"|"html_notes"|"icon"|"members"|"members.name"|"minimum_access_level_for_customization"|"minimum_access_level_for_sharing"|"modified_at"|"name"|"notes"|"owner"|"permalink_url"|"privacy_setting"|"project_brief"|"public"|"start_on"|"team"|"team.name"|"workspace"|"workspace.name")[]? (default ()) - This endpoint returns a compact 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.
Return Type
- Inline_response_201_5|error - Successfully created the specified project.
get workspaces/[string workspace_gid]/projects
function get workspaces/[string workspace_gid]/projects(boolean? opt_pretty, int? 'limit, string? offset, boolean? archived, ("archived"|"color"|"completed"|"completed_at"|"completed_by"|"completed_by.name"|"created_at"|"created_from_template"|"created_from_template.name"|"current_status"|"current_status.author"|"current_status.author.name"|"current_status.color"|"current_status.created_at"|"current_status.created_by"|"current_status.created_by.name"|"current_status.html_text"|"current_status.modified_at"|"current_status.text"|"current_status.title"|"current_status_update"|"current_status_update.resource_subtype"|"current_status_update.title"|"custom_field_settings"|"custom_field_settings.custom_field"|"custom_field_settings.custom_field.asana_created_field"|"custom_field_settings.custom_field.created_by"|"custom_field_settings.custom_field.created_by.name"|"custom_field_settings.custom_field.currency_code"|"custom_field_settings.custom_field.custom_label"|"custom_field_settings.custom_field.custom_label_position"|"custom_field_settings.custom_field.date_value"|"custom_field_settings.custom_field.date_value.date"|"custom_field_settings.custom_field.date_value.date_time"|"custom_field_settings.custom_field.description"|"custom_field_settings.custom_field.display_value"|"custom_field_settings.custom_field.enabled"|"custom_field_settings.custom_field.enum_options"|"custom_field_settings.custom_field.enum_options.color"|"custom_field_settings.custom_field.enum_options.enabled"|"custom_field_settings.custom_field.enum_options.name"|"custom_field_settings.custom_field.enum_value"|"custom_field_settings.custom_field.enum_value.color"|"custom_field_settings.custom_field.enum_value.enabled"|"custom_field_settings.custom_field.enum_value.name"|"custom_field_settings.custom_field.format"|"custom_field_settings.custom_field.has_notifications_enabled"|"custom_field_settings.custom_field.id_prefix"|"custom_field_settings.custom_field.is_formula_field"|"custom_field_settings.custom_field.is_global_to_workspace"|"custom_field_settings.custom_field.is_value_read_only"|"custom_field_settings.custom_field.multi_enum_values"|"custom_field_settings.custom_field.multi_enum_values.color"|"custom_field_settings.custom_field.multi_enum_values.enabled"|"custom_field_settings.custom_field.multi_enum_values.name"|"custom_field_settings.custom_field.name"|"custom_field_settings.custom_field.number_value"|"custom_field_settings.custom_field.people_value"|"custom_field_settings.custom_field.people_value.name"|"custom_field_settings.custom_field.precision"|"custom_field_settings.custom_field.representation_type"|"custom_field_settings.custom_field.resource_subtype"|"custom_field_settings.custom_field.text_value"|"custom_field_settings.custom_field.type"|"custom_field_settings.is_important"|"custom_field_settings.parent"|"custom_field_settings.parent.name"|"custom_field_settings.project"|"custom_field_settings.project.name"|"custom_fields"|"custom_fields.date_value"|"custom_fields.date_value.date"|"custom_fields.date_value.date_time"|"custom_fields.display_value"|"custom_fields.enabled"|"custom_fields.enum_options"|"custom_fields.enum_options.color"|"custom_fields.enum_options.enabled"|"custom_fields.enum_options.name"|"custom_fields.enum_value"|"custom_fields.enum_value.color"|"custom_fields.enum_value.enabled"|"custom_fields.enum_value.name"|"custom_fields.id_prefix"|"custom_fields.is_formula_field"|"custom_fields.multi_enum_values"|"custom_fields.multi_enum_values.color"|"custom_fields.multi_enum_values.enabled"|"custom_fields.multi_enum_values.name"|"custom_fields.name"|"custom_fields.number_value"|"custom_fields.representation_type"|"custom_fields.resource_subtype"|"custom_fields.text_value"|"custom_fields.type"|"default_access_level"|"default_view"|"due_date"|"due_on"|"followers"|"followers.name"|"html_notes"|"icon"|"members"|"members.name"|"minimum_access_level_for_customization"|"minimum_access_level_for_sharing"|"modified_at"|"name"|"notes"|"offset"|"owner"|"path"|"permalink_url"|"privacy_setting"|"project_brief"|"public"|"start_on"|"team"|"team.name"|"uri"|"workspace"|"workspace.name")[]? opt_fields) returns Inline_response_200_19|error
Get all projects in a workspace
Parameters
- opt_pretty boolean? (default ()) - 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.
- 'limit int? (default ()) - Results per page. The number of objects to return per page. The value must be between 1 and 100.
- offset string? (default ()) - Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.'
- archived boolean? (default ()) - Only return projects whose
archived
field takes on the value of this parameter.
- opt_fields ("archived"|"color"|"completed"|"completed_at"|"completed_by"|"completed_by.name"|"created_at"|"created_from_template"|"created_from_template.name"|"current_status"|"current_status.author"|"current_status.author.name"|"current_status.color"|"current_status.created_at"|"current_status.created_by"|"current_status.created_by.name"|"current_status.html_text"|"current_status.modified_at"|"current_status.text"|"current_status.title"|"current_status_update"|"current_status_update.resource_subtype"|"current_status_update.title"|"custom_field_settings"|"custom_field_settings.custom_field"|"custom_field_settings.custom_field.asana_created_field"|"custom_field_settings.custom_field.created_by"|"custom_field_settings.custom_field.created_by.name"|"custom_field_settings.custom_field.currency_code"|"custom_field_settings.custom_field.custom_label"|"custom_field_settings.custom_field.custom_label_position"|"custom_field_settings.custom_field.date_value"|"custom_field_settings.custom_field.date_value.date"|"custom_field_settings.custom_field.date_value.date_time"|"custom_field_settings.custom_field.description"|"custom_field_settings.custom_field.display_value"|"custom_field_settings.custom_field.enabled"|"custom_field_settings.custom_field.enum_options"|"custom_field_settings.custom_field.enum_options.color"|"custom_field_settings.custom_field.enum_options.enabled"|"custom_field_settings.custom_field.enum_options.name"|"custom_field_settings.custom_field.enum_value"|"custom_field_settings.custom_field.enum_value.color"|"custom_field_settings.custom_field.enum_value.enabled"|"custom_field_settings.custom_field.enum_value.name"|"custom_field_settings.custom_field.format"|"custom_field_settings.custom_field.has_notifications_enabled"|"custom_field_settings.custom_field.id_prefix"|"custom_field_settings.custom_field.is_formula_field"|"custom_field_settings.custom_field.is_global_to_workspace"|"custom_field_settings.custom_field.is_value_read_only"|"custom_field_settings.custom_field.multi_enum_values"|"custom_field_settings.custom_field.multi_enum_values.color"|"custom_field_settings.custom_field.multi_enum_values.enabled"|"custom_field_settings.custom_field.multi_enum_values.name"|"custom_field_settings.custom_field.name"|"custom_field_settings.custom_field.number_value"|"custom_field_settings.custom_field.people_value"|"custom_field_settings.custom_field.people_value.name"|"custom_field_settings.custom_field.precision"|"custom_field_settings.custom_field.representation_type"|"custom_field_settings.custom_field.resource_subtype"|"custom_field_settings.custom_field.text_value"|"custom_field_settings.custom_field.type"|"custom_field_settings.is_important"|"custom_field_settings.parent"|"custom_field_settings.parent.name"|"custom_field_settings.project"|"custom_field_settings.project.name"|"custom_fields"|"custom_fields.date_value"|"custom_fields.date_value.date"|"custom_fields.date_value.date_time"|"custom_fields.display_value"|"custom_fields.enabled"|"custom_fields.enum_options"|"custom_fields.enum_options.color"|"custom_fields.enum_options.enabled"|"custom_fields.enum_options.name"|"custom_fields.enum_value"|"custom_fields.enum_value.color"|"custom_fields.enum_value.enabled"|"custom_fields.enum_value.name"|"custom_fields.id_prefix"|"custom_fields.is_formula_field"|"custom_fields.multi_enum_values"|"custom_fields.multi_enum_values.color"|"custom_fields.multi_enum_values.enabled"|"custom_fields.multi_enum_values.name"|"custom_fields.name"|"custom_fields.number_value"|"custom_fields.representation_type"|"custom_fields.resource_subtype"|"custom_fields.text_value"|"custom_fields.type"|"default_access_level"|"default_view"|"due_date"|"due_on"|"followers"|"followers.name"|"html_notes"|"icon"|"members"|"members.name"|"minimum_access_level_for_customization"|"minimum_access_level_for_sharing"|"modified_at"|"name"|"notes"|"offset"|"owner"|"path"|"permalink_url"|"privacy_setting"|"project_brief"|"public"|"start_on"|"team"|"team.name"|"uri"|"workspace"|"workspace.name")[]? (default ()) - This endpoint returns a compact 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.
Return Type
- Inline_response_200_19|error - Successfully retrieved the requested workspace's projects.
post workspaces/[string workspace_gid]/projects
function post workspaces/[string workspace_gid]/projects(Workspace_gid_projects_body payload, boolean? opt_pretty, ("archived"|"color"|"completed"|"completed_at"|"completed_by"|"completed_by.name"|"created_at"|"created_from_template"|"created_from_template.name"|"current_status"|"current_status.author"|"current_status.author.name"|"current_status.color"|"current_status.created_at"|"current_status.created_by"|"current_status.created_by.name"|"current_status.html_text"|"current_status.modified_at"|"current_status.text"|"current_status.title"|"current_status_update"|"current_status_update.resource_subtype"|"current_status_update.title"|"custom_field_settings"|"custom_field_settings.custom_field"|"custom_field_settings.custom_field.asana_created_field"|"custom_field_settings.custom_field.created_by"|"custom_field_settings.custom_field.created_by.name"|"custom_field_settings.custom_field.currency_code"|"custom_field_settings.custom_field.custom_label"|"custom_field_settings.custom_field.custom_label_position"|"custom_field_settings.custom_field.date_value"|"custom_field_settings.custom_field.date_value.date"|"custom_field_settings.custom_field.date_value.date_time"|"custom_field_settings.custom_field.description"|"custom_field_settings.custom_field.display_value"|"custom_field_settings.custom_field.enabled"|"custom_field_settings.custom_field.enum_options"|"custom_field_settings.custom_field.enum_options.color"|"custom_field_settings.custom_field.enum_options.enabled"|"custom_field_settings.custom_field.enum_options.name"|"custom_field_settings.custom_field.enum_value"|"custom_field_settings.custom_field.enum_value.color"|"custom_field_settings.custom_field.enum_value.enabled"|"custom_field_settings.custom_field.enum_value.name"|"custom_field_settings.custom_field.format"|"custom_field_settings.custom_field.has_notifications_enabled"|"custom_field_settings.custom_field.id_prefix"|"custom_field_settings.custom_field.is_formula_field"|"custom_field_settings.custom_field.is_global_to_workspace"|"custom_field_settings.custom_field.is_value_read_only"|"custom_field_settings.custom_field.multi_enum_values"|"custom_field_settings.custom_field.multi_enum_values.color"|"custom_field_settings.custom_field.multi_enum_values.enabled"|"custom_field_settings.custom_field.multi_enum_values.name"|"custom_field_settings.custom_field.name"|"custom_field_settings.custom_field.number_value"|"custom_field_settings.custom_field.people_value"|"custom_field_settings.custom_field.people_value.name"|"custom_field_settings.custom_field.precision"|"custom_field_settings.custom_field.representation_type"|"custom_field_settings.custom_field.resource_subtype"|"custom_field_settings.custom_field.text_value"|"custom_field_settings.custom_field.type"|"custom_field_settings.is_important"|"custom_field_settings.parent"|"custom_field_settings.parent.name"|"custom_field_settings.project"|"custom_field_settings.project.name"|"custom_fields"|"custom_fields.date_value"|"custom_fields.date_value.date"|"custom_fields.date_value.date_time"|"custom_fields.display_value"|"custom_fields.enabled"|"custom_fields.enum_options"|"custom_fields.enum_options.color"|"custom_fields.enum_options.enabled"|"custom_fields.enum_options.name"|"custom_fields.enum_value"|"custom_fields.enum_value.color"|"custom_fields.enum_value.enabled"|"custom_fields.enum_value.name"|"custom_fields.id_prefix"|"custom_fields.is_formula_field"|"custom_fields.multi_enum_values"|"custom_fields.multi_enum_values.color"|"custom_fields.multi_enum_values.enabled"|"custom_fields.multi_enum_values.name"|"custom_fields.name"|"custom_fields.number_value"|"custom_fields.representation_type"|"custom_fields.resource_subtype"|"custom_fields.text_value"|"custom_fields.type"|"default_access_level"|"default_view"|"due_date"|"due_on"|"followers"|"followers.name"|"html_notes"|"icon"|"members"|"members.name"|"minimum_access_level_for_customization"|"minimum_access_level_for_sharing"|"modified_at"|"name"|"notes"|"owner"|"permalink_url"|"privacy_setting"|"project_brief"|"public"|"start_on"|"team"|"team.name"|"workspace"|"workspace.name")[]? opt_fields) returns Inline_response_201_5|error
Create a project in a workspace
Parameters
- payload Workspace_gid_projects_body - The new project to create.
- opt_pretty boolean? (default ()) - 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 ("archived"|"color"|"completed"|"completed_at"|"completed_by"|"completed_by.name"|"created_at"|"created_from_template"|"created_from_template.name"|"current_status"|"current_status.author"|"current_status.author.name"|"current_status.color"|"current_status.created_at"|"current_status.created_by"|"current_status.created_by.name"|"current_status.html_text"|"current_status.modified_at"|"current_status.text"|"current_status.title"|"current_status_update"|"current_status_update.resource_subtype"|"current_status_update.title"|"custom_field_settings"|"custom_field_settings.custom_field"|"custom_field_settings.custom_field.asana_created_field"|"custom_field_settings.custom_field.created_by"|"custom_field_settings.custom_field.created_by.name"|"custom_field_settings.custom_field.currency_code"|"custom_field_settings.custom_field.custom_label"|"custom_field_settings.custom_field.custom_label_position"|"custom_field_settings.custom_field.date_value"|"custom_field_settings.custom_field.date_value.date"|"custom_field_settings.custom_field.date_value.date_time"|"custom_field_settings.custom_field.description"|"custom_field_settings.custom_field.display_value"|"custom_field_settings.custom_field.enabled"|"custom_field_settings.custom_field.enum_options"|"custom_field_settings.custom_field.enum_options.color"|"custom_field_settings.custom_field.enum_options.enabled"|"custom_field_settings.custom_field.enum_options.name"|"custom_field_settings.custom_field.enum_value"|"custom_field_settings.custom_field.enum_value.color"|"custom_field_settings.custom_field.enum_value.enabled"|"custom_field_settings.custom_field.enum_value.name"|"custom_field_settings.custom_field.format"|"custom_field_settings.custom_field.has_notifications_enabled"|"custom_field_settings.custom_field.id_prefix"|"custom_field_settings.custom_field.is_formula_field"|"custom_field_settings.custom_field.is_global_to_workspace"|"custom_field_settings.custom_field.is_value_read_only"|"custom_field_settings.custom_field.multi_enum_values"|"custom_field_settings.custom_field.multi_enum_values.color"|"custom_field_settings.custom_field.multi_enum_values.enabled"|"custom_field_settings.custom_field.multi_enum_values.name"|"custom_field_settings.custom_field.name"|"custom_field_settings.custom_field.number_value"|"custom_field_settings.custom_field.people_value"|"custom_field_settings.custom_field.people_value.name"|"custom_field_settings.custom_field.precision"|"custom_field_settings.custom_field.representation_type"|"custom_field_settings.custom_field.resource_subtype"|"custom_field_settings.custom_field.text_value"|"custom_field_settings.custom_field.type"|"custom_field_settings.is_important"|"custom_field_settings.parent"|"custom_field_settings.parent.name"|"custom_field_settings.project"|"custom_field_settings.project.name"|"custom_fields"|"custom_fields.date_value"|"custom_fields.date_value.date"|"custom_fields.date_value.date_time"|"custom_fields.display_value"|"custom_fields.enabled"|"custom_fields.enum_options"|"custom_fields.enum_options.color"|"custom_fields.enum_options.enabled"|"custom_fields.enum_options.name"|"custom_fields.enum_value"|"custom_fields.enum_value.color"|"custom_fields.enum_value.enabled"|"custom_fields.enum_value.name"|"custom_fields.id_prefix"|"custom_fields.is_formula_field"|"custom_fields.multi_enum_values"|"custom_fields.multi_enum_values.color"|"custom_fields.multi_enum_values.enabled"|"custom_fields.multi_enum_values.name"|"custom_fields.name"|"custom_fields.number_value"|"custom_fields.representation_type"|"custom_fields.resource_subtype"|"custom_fields.text_value"|"custom_fields.type"|"default_access_level"|"default_view"|"due_date"|"due_on"|"followers"|"followers.name"|"html_notes"|"icon"|"members"|"members.name"|"minimum_access_level_for_customization"|"minimum_access_level_for_sharing"|"modified_at"|"name"|"notes"|"owner"|"permalink_url"|"privacy_setting"|"project_brief"|"public"|"start_on"|"team"|"team.name"|"workspace"|"workspace.name")[]? (default ()) - This endpoint returns a compact 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.
Return Type
- Inline_response_201_5|error - Successfully created a new project in the specified workspace.
post projects/[string project_gid]/addCustomFieldSetting
function post projects/[string project_gid]/addCustomFieldSetting(Project_gid_addCustomFieldSetting_body payload, boolean? opt_pretty, ("custom_field"|"custom_field.asana_created_field"|"custom_field.created_by"|"custom_field.created_by.name"|"custom_field.currency_code"|"custom_field.custom_label"|"custom_field.custom_label_position"|"custom_field.date_value"|"custom_field.date_value.date"|"custom_field.date_value.date_time"|"custom_field.description"|"custom_field.display_value"|"custom_field.enabled"|"custom_field.enum_options"|"custom_field.enum_options.color"|"custom_field.enum_options.enabled"|"custom_field.enum_options.name"|"custom_field.enum_value"|"custom_field.enum_value.color"|"custom_field.enum_value.enabled"|"custom_field.enum_value.name"|"custom_field.format"|"custom_field.has_notifications_enabled"|"custom_field.id_prefix"|"custom_field.is_formula_field"|"custom_field.is_global_to_workspace"|"custom_field.is_value_read_only"|"custom_field.multi_enum_values"|"custom_field.multi_enum_values.color"|"custom_field.multi_enum_values.enabled"|"custom_field.multi_enum_values.name"|"custom_field.name"|"custom_field.number_value"|"custom_field.people_value"|"custom_field.people_value.name"|"custom_field.precision"|"custom_field.representation_type"|"custom_field.resource_subtype"|"custom_field.text_value"|"custom_field.type"|"is_important"|"parent"|"parent.name"|"project"|"project.name")[]? opt_fields) returns Inline_response_200_20|error
Add a custom field to a project
Parameters
- payload Project_gid_addCustomFieldSetting_body - Information about the custom field setting.
- opt_pretty boolean? (default ()) - 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 ("custom_field"|"custom_field.asana_created_field"|"custom_field.created_by"|"custom_field.created_by.name"|"custom_field.currency_code"|"custom_field.custom_label"|"custom_field.custom_label_position"|"custom_field.date_value"|"custom_field.date_value.date"|"custom_field.date_value.date_time"|"custom_field.description"|"custom_field.display_value"|"custom_field.enabled"|"custom_field.enum_options"|"custom_field.enum_options.color"|"custom_field.enum_options.enabled"|"custom_field.enum_options.name"|"custom_field.enum_value"|"custom_field.enum_value.color"|"custom_field.enum_value.enabled"|"custom_field.enum_value.name"|"custom_field.format"|"custom_field.has_notifications_enabled"|"custom_field.id_prefix"|"custom_field.is_formula_field"|"custom_field.is_global_to_workspace"|"custom_field.is_value_read_only"|"custom_field.multi_enum_values"|"custom_field.multi_enum_values.color"|"custom_field.multi_enum_values.enabled"|"custom_field.multi_enum_values.name"|"custom_field.name"|"custom_field.number_value"|"custom_field.people_value"|"custom_field.people_value.name"|"custom_field.precision"|"custom_field.representation_type"|"custom_field.resource_subtype"|"custom_field.text_value"|"custom_field.type"|"is_important"|"parent"|"parent.name"|"project"|"project.name")[]? (default ()) - This endpoint returns a compact 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.
Return Type
- Inline_response_200_20|error - Successfully added the custom field to the project.
post projects/[string project_gid]/removeCustomFieldSetting
function post projects/[string project_gid]/removeCustomFieldSetting(Project_gid_removeCustomFieldSetting_body payload, boolean? opt_pretty) returns Inline_response_200_1|error
Remove a custom field from a project
Parameters
- payload Project_gid_removeCustomFieldSetting_body - Information about the custom field setting being removed.
- opt_pretty boolean? (default ()) - 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.
Return Type
- Inline_response_200_1|error - Successfully removed the custom field from the project.
get projects/[string project_gid]/task_counts
function get projects/[string project_gid]/task_counts(boolean? opt_pretty, ("num_completed_milestones"|"num_completed_tasks"|"num_incomplete_milestones"|"num_incomplete_tasks"|"num_milestones"|"num_tasks")[]? opt_fields) returns Inline_response_200_28|error
Get task count of a project
Parameters
- opt_pretty boolean? (default ()) - 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 ("num_completed_milestones"|"num_completed_tasks"|"num_incomplete_milestones"|"num_incomplete_tasks"|"num_milestones"|"num_tasks")[]? (default ()) - This endpoint returns a compact 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.
Return Type
- Inline_response_200_28|error - Successfully retrieved the requested project's task counts.
post projects/[string project_gid]/addMembers
function post projects/[string project_gid]/addMembers(Project_gid_addMembers_body payload, boolean? opt_pretty, ("archived"|"color"|"completed"|"completed_at"|"completed_by"|"completed_by.name"|"created_at"|"created_from_template"|"created_from_template.name"|"current_status"|"current_status.author"|"current_status.author.name"|"current_status.color"|"current_status.created_at"|"current_status.created_by"|"current_status.created_by.name"|"current_status.html_text"|"current_status.modified_at"|"current_status.text"|"current_status.title"|"current_status_update"|"current_status_update.resource_subtype"|"current_status_update.title"|"custom_field_settings"|"custom_field_settings.custom_field"|"custom_field_settings.custom_field.asana_created_field"|"custom_field_settings.custom_field.created_by"|"custom_field_settings.custom_field.created_by.name"|"custom_field_settings.custom_field.currency_code"|"custom_field_settings.custom_field.custom_label"|"custom_field_settings.custom_field.custom_label_position"|"custom_field_settings.custom_field.date_value"|"custom_field_settings.custom_field.date_value.date"|"custom_field_settings.custom_field.date_value.date_time"|"custom_field_settings.custom_field.description"|"custom_field_settings.custom_field.display_value"|"custom_field_settings.custom_field.enabled"|"custom_field_settings.custom_field.enum_options"|"custom_field_settings.custom_field.enum_options.color"|"custom_field_settings.custom_field.enum_options.enabled"|"custom_field_settings.custom_field.enum_options.name"|"custom_field_settings.custom_field.enum_value"|"custom_field_settings.custom_field.enum_value.color"|"custom_field_settings.custom_field.enum_value.enabled"|"custom_field_settings.custom_field.enum_value.name"|"custom_field_settings.custom_field.format"|"custom_field_settings.custom_field.has_notifications_enabled"|"custom_field_settings.custom_field.id_prefix"|"custom_field_settings.custom_field.is_formula_field"|"custom_field_settings.custom_field.is_global_to_workspace"|"custom_field_settings.custom_field.is_value_read_only"|"custom_field_settings.custom_field.multi_enum_values"|"custom_field_settings.custom_field.multi_enum_values.color"|"custom_field_settings.custom_field.multi_enum_values.enabled"|"custom_field_settings.custom_field.multi_enum_values.name"|"custom_field_settings.custom_field.name"|"custom_field_settings.custom_field.number_value"|"custom_field_settings.custom_field.people_value"|"custom_field_settings.custom_field.people_value.name"|"custom_field_settings.custom_field.precision"|"custom_field_settings.custom_field.representation_type"|"custom_field_settings.custom_field.resource_subtype"|"custom_field_settings.custom_field.text_value"|"custom_field_settings.custom_field.type"|"custom_field_settings.is_important"|"custom_field_settings.parent"|"custom_field_settings.parent.name"|"custom_field_settings.project"|"custom_field_settings.project.name"|"custom_fields"|"custom_fields.date_value"|"custom_fields.date_value.date"|"custom_fields.date_value.date_time"|"custom_fields.display_value"|"custom_fields.enabled"|"custom_fields.enum_options"|"custom_fields.enum_options.color"|"custom_fields.enum_options.enabled"|"custom_fields.enum_options.name"|"custom_fields.enum_value"|"custom_fields.enum_value.color"|"custom_fields.enum_value.enabled"|"custom_fields.enum_value.name"|"custom_fields.id_prefix"|"custom_fields.is_formula_field"|"custom_fields.multi_enum_values"|"custom_fields.multi_enum_values.color"|"custom_fields.multi_enum_values.enabled"|"custom_fields.multi_enum_values.name"|"custom_fields.name"|"custom_fields.number_value"|"custom_fields.representation_type"|"custom_fields.resource_subtype"|"custom_fields.text_value"|"custom_fields.type"|"default_access_level"|"default_view"|"due_date"|"due_on"|"followers"|"followers.name"|"html_notes"|"icon"|"members"|"members.name"|"minimum_access_level_for_customization"|"minimum_access_level_for_sharing"|"modified_at"|"name"|"notes"|"owner"|"permalink_url"|"privacy_setting"|"project_brief"|"public"|"start_on"|"team"|"team.name"|"workspace"|"workspace.name")[]? opt_fields) returns Inline_response_201_5|error
Add users to a project
Parameters
- payload Project_gid_addMembers_body - Information about the members being added.
- opt_pretty boolean? (default ()) - 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 ("archived"|"color"|"completed"|"completed_at"|"completed_by"|"completed_by.name"|"created_at"|"created_from_template"|"created_from_template.name"|"current_status"|"current_status.author"|"current_status.author.name"|"current_status.color"|"current_status.created_at"|"current_status.created_by"|"current_status.created_by.name"|"current_status.html_text"|"current_status.modified_at"|"current_status.text"|"current_status.title"|"current_status_update"|"current_status_update.resource_subtype"|"current_status_update.title"|"custom_field_settings"|"custom_field_settings.custom_field"|"custom_field_settings.custom_field.asana_created_field"|"custom_field_settings.custom_field.created_by"|"custom_field_settings.custom_field.created_by.name"|"custom_field_settings.custom_field.currency_code"|"custom_field_settings.custom_field.custom_label"|"custom_field_settings.custom_field.custom_label_position"|"custom_field_settings.custom_field.date_value"|"custom_field_settings.custom_field.date_value.date"|"custom_field_settings.custom_field.date_value.date_time"|"custom_field_settings.custom_field.description"|"custom_field_settings.custom_field.display_value"|"custom_field_settings.custom_field.enabled"|"custom_field_settings.custom_field.enum_options"|"custom_field_settings.custom_field.enum_options.color"|"custom_field_settings.custom_field.enum_options.enabled"|"custom_field_settings.custom_field.enum_options.name"|"custom_field_settings.custom_field.enum_value"|"custom_field_settings.custom_field.enum_value.color"|"custom_field_settings.custom_field.enum_value.enabled"|"custom_field_settings.custom_field.enum_value.name"|"custom_field_settings.custom_field.format"|"custom_field_settings.custom_field.has_notifications_enabled"|"custom_field_settings.custom_field.id_prefix"|"custom_field_settings.custom_field.is_formula_field"|"custom_field_settings.custom_field.is_global_to_workspace"|"custom_field_settings.custom_field.is_value_read_only"|"custom_field_settings.custom_field.multi_enum_values"|"custom_field_settings.custom_field.multi_enum_values.color"|"custom_field_settings.custom_field.multi_enum_values.enabled"|"custom_field_settings.custom_field.multi_enum_values.name"|"custom_field_settings.custom_field.name"|"custom_field_settings.custom_field.number_value"|"custom_field_settings.custom_field.people_value"|"custom_field_settings.custom_field.people_value.name"|"custom_field_settings.custom_field.precision"|"custom_field_settings.custom_field.representation_type"|"custom_field_settings.custom_field.resource_subtype"|"custom_field_settings.custom_field.text_value"|"custom_field_settings.custom_field.type"|"custom_field_settings.is_important"|"custom_field_settings.parent"|"custom_field_settings.parent.name"|"custom_field_settings.project"|"custom_field_settings.project.name"|"custom_fields"|"custom_fields.date_value"|"custom_fields.date_value.date"|"custom_fields.date_value.date_time"|"custom_fields.display_value"|"custom_fields.enabled"|"custom_fields.enum_options"|"custom_fields.enum_options.color"|"custom_fields.enum_options.enabled"|"custom_fields.enum_options.name"|"custom_fields.enum_value"|"custom_fields.enum_value.color"|"custom_fields.enum_value.enabled"|"custom_fields.enum_value.name"|"custom_fields.id_prefix"|"custom_fields.is_formula_field"|"custom_fields.multi_enum_values"|"custom_fields.multi_enum_values.color"|"custom_fields.multi_enum_values.enabled"|"custom_fields.multi_enum_values.name"|"custom_fields.name"|"custom_fields.number_value"|"custom_fields.representation_type"|"custom_fields.resource_subtype"|"custom_fields.text_value"|"custom_fields.type"|"default_access_level"|"default_view"|"due_date"|"due_on"|"followers"|"followers.name"|"html_notes"|"icon"|"members"|"members.name"|"minimum_access_level_for_customization"|"minimum_access_level_for_sharing"|"modified_at"|"name"|"notes"|"owner"|"permalink_url"|"privacy_setting"|"project_brief"|"public"|"start_on"|"team"|"team.name"|"workspace"|"workspace.name")[]? (default ()) - This endpoint returns a compact 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.
Return Type
- Inline_response_201_5|error - Successfully added members to the project.
post projects/[string project_gid]/removeMembers
function post projects/[string project_gid]/removeMembers(Project_gid_removeMembers_body payload, boolean? opt_pretty, ("archived"|"color"|"completed"|"completed_at"|"completed_by"|"completed_by.name"|"created_at"|"created_from_template"|"created_from_template.name"|"current_status"|"current_status.author"|"current_status.author.name"|"current_status.color"|"current_status.created_at"|"current_status.created_by"|"current_status.created_by.name"|"current_status.html_text"|"current_status.modified_at"|"current_status.text"|"current_status.title"|"current_status_update"|"current_status_update.resource_subtype"|"current_status_update.title"|"custom_field_settings"|"custom_field_settings.custom_field"|"custom_field_settings.custom_field.asana_created_field"|"custom_field_settings.custom_field.created_by"|"custom_field_settings.custom_field.created_by.name"|"custom_field_settings.custom_field.currency_code"|"custom_field_settings.custom_field.custom_label"|"custom_field_settings.custom_field.custom_label_position"|"custom_field_settings.custom_field.date_value"|"custom_field_settings.custom_field.date_value.date"|"custom_field_settings.custom_field.date_value.date_time"|"custom_field_settings.custom_field.description"|"custom_field_settings.custom_field.display_value"|"custom_field_settings.custom_field.enabled"|"custom_field_settings.custom_field.enum_options"|"custom_field_settings.custom_field.enum_options.color"|"custom_field_settings.custom_field.enum_options.enabled"|"custom_field_settings.custom_field.enum_options.name"|"custom_field_settings.custom_field.enum_value"|"custom_field_settings.custom_field.enum_value.color"|"custom_field_settings.custom_field.enum_value.enabled"|"custom_field_settings.custom_field.enum_value.name"|"custom_field_settings.custom_field.format"|"custom_field_settings.custom_field.has_notifications_enabled"|"custom_field_settings.custom_field.id_prefix"|"custom_field_settings.custom_field.is_formula_field"|"custom_field_settings.custom_field.is_global_to_workspace"|"custom_field_settings.custom_field.is_value_read_only"|"custom_field_settings.custom_field.multi_enum_values"|"custom_field_settings.custom_field.multi_enum_values.color"|"custom_field_settings.custom_field.multi_enum_values.enabled"|"custom_field_settings.custom_field.multi_enum_values.name"|"custom_field_settings.custom_field.name"|"custom_field_settings.custom_field.number_value"|"custom_field_settings.custom_field.people_value"|"custom_field_settings.custom_field.people_value.name"|"custom_field_settings.custom_field.precision"|"custom_field_settings.custom_field.representation_type"|"custom_field_settings.custom_field.resource_subtype"|"custom_field_settings.custom_field.text_value"|"custom_field_settings.custom_field.type"|"custom_field_settings.is_important"|"custom_field_settings.parent"|"custom_field_settings.parent.name"|"custom_field_settings.project"|"custom_field_settings.project.name"|"custom_fields"|"custom_fields.date_value"|"custom_fields.date_value.date"|"custom_fields.date_value.date_time"|"custom_fields.display_value"|"custom_fields.enabled"|"custom_fields.enum_options"|"custom_fields.enum_options.color"|"custom_fields.enum_options.enabled"|"custom_fields.enum_options.name"|"custom_fields.enum_value"|"custom_fields.enum_value.color"|"custom_fields.enum_value.enabled"|"custom_fields.enum_value.name"|"custom_fields.id_prefix"|"custom_fields.is_formula_field"|"custom_fields.multi_enum_values"|"custom_fields.multi_enum_values.color"|"custom_fields.multi_enum_values.enabled"|"custom_fields.multi_enum_values.name"|"custom_fields.name"|"custom_fields.number_value"|"custom_fields.representation_type"|"custom_fields.resource_subtype"|"custom_fields.text_value"|"custom_fields.type"|"default_access_level"|"default_view"|"due_date"|"due_on"|"followers"|"followers.name"|"html_notes"|"icon"|"members"|"members.name"|"minimum_access_level_for_customization"|"minimum_access_level_for_sharing"|"modified_at"|"name"|"notes"|"owner"|"permalink_url"|"privacy_setting"|"project_brief"|"public"|"start_on"|"team"|"team.name"|"workspace"|"workspace.name")[]? opt_fields) returns Inline_response_201_5|error
Remove users from a project
Parameters
- payload Project_gid_removeMembers_body - Information about the members being removed.
- opt_pretty boolean? (default ()) - 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 ("archived"|"color"|"completed"|"completed_at"|"completed_by"|"completed_by.name"|"created_at"|"created_from_template"|"created_from_template.name"|"current_status"|"current_status.author"|"current_status.author.name"|"current_status.color"|"current_status.created_at"|"current_status.created_by"|"current_status.created_by.name"|"current_status.html_text"|"current_status.modified_at"|"current_status.text"|"current_status.title"|"current_status_update"|"current_status_update.resource_subtype"|"current_status_update.title"|"custom_field_settings"|"custom_field_settings.custom_field"|"custom_field_settings.custom_field.asana_created_field"|"custom_field_settings.custom_field.created_by"|"custom_field_settings.custom_field.created_by.name"|"custom_field_settings.custom_field.currency_code"|"custom_field_settings.custom_field.custom_label"|"custom_field_settings.custom_field.custom_label_position"|"custom_field_settings.custom_field.date_value"|"custom_field_settings.custom_field.date_value.date"|"custom_field_settings.custom_field.date_value.date_time"|"custom_field_settings.custom_field.description"|"custom_field_settings.custom_field.display_value"|"custom_field_settings.custom_field.enabled"|"custom_field_settings.custom_field.enum_options"|"custom_field_settings.custom_field.enum_options.color"|"custom_field_settings.custom_field.enum_options.enabled"|"custom_field_settings.custom_field.enum_options.name"|"custom_field_settings.custom_field.enum_value"|"custom_field_settings.custom_field.enum_value.color"|"custom_field_settings.custom_field.enum_value.enabled"|"custom_field_settings.custom_field.enum_value.name"|"custom_field_settings.custom_field.format"|"custom_field_settings.custom_field.has_notifications_enabled"|"custom_field_settings.custom_field.id_prefix"|"custom_field_settings.custom_field.is_formula_field"|"custom_field_settings.custom_field.is_global_to_workspace"|"custom_field_settings.custom_field.is_value_read_only"|"custom_field_settings.custom_field.multi_enum_values"|"custom_field_settings.custom_field.multi_enum_values.color"|"custom_field_settings.custom_field.multi_enum_values.enabled"|"custom_field_settings.custom_field.multi_enum_values.name"|"custom_field_settings.custom_field.name"|"custom_field_settings.custom_field.number_value"|"custom_field_settings.custom_field.people_value"|"custom_field_settings.custom_field.people_value.name"|"custom_field_settings.custom_field.precision"|"custom_field_settings.custom_field.representation_type"|"custom_field_settings.custom_field.resource_subtype"|"custom_field_settings.custom_field.text_value"|"custom_field_settings.custom_field.type"|"custom_field_settings.is_important"|"custom_field_settings.parent"|"custom_field_settings.parent.name"|"custom_field_settings.project"|"custom_field_settings.project.name"|"custom_fields"|"custom_fields.date_value"|"custom_fields.date_value.date"|"custom_fields.date_value.date_time"|"custom_fields.display_value"|"custom_fields.enabled"|"custom_fields.enum_options"|"custom_fields.enum_options.color"|"custom_fields.enum_options.enabled"|"custom_fields.enum_options.name"|"custom_fields.enum_value"|"custom_fields.enum_value.color"|"custom_fields.enum_value.enabled"|"custom_fields.enum_value.name"|"custom_fields.id_prefix"|"custom_fields.is_formula_field"|"custom_fields.multi_enum_values"|"custom_fields.multi_enum_values.color"|"custom_fields.multi_enum_values.enabled"|"custom_fields.multi_enum_values.name"|"custom_fields.name"|"custom_fields.number_value"|"custom_fields.representation_type"|"custom_fields.resource_subtype"|"custom_fields.text_value"|"custom_fields.type"|"default_access_level"|"default_view"|"due_date"|"due_on"|"followers"|"followers.name"|"html_notes"|"icon"|"members"|"members.name"|"minimum_access_level_for_customization"|"minimum_access_level_for_sharing"|"modified_at"|"name"|"notes"|"owner"|"permalink_url"|"privacy_setting"|"project_brief"|"public"|"start_on"|"team"|"team.name"|"workspace"|"workspace.name")[]? (default ()) - This endpoint returns a compact 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.
Return Type
- Inline_response_201_5|error - Successfully removed the members from the project.
post projects/[string project_gid]/addFollowers
function post projects/[string project_gid]/addFollowers(Project_gid_addFollowers_body payload, boolean? opt_pretty, ("archived"|"color"|"completed"|"completed_at"|"completed_by"|"completed_by.name"|"created_at"|"created_from_template"|"created_from_template.name"|"current_status"|"current_status.author"|"current_status.author.name"|"current_status.color"|"current_status.created_at"|"current_status.created_by"|"current_status.created_by.name"|"current_status.html_text"|"current_status.modified_at"|"current_status.text"|"current_status.title"|"current_status_update"|"current_status_update.resource_subtype"|"current_status_update.title"|"custom_field_settings"|"custom_field_settings.custom_field"|"custom_field_settings.custom_field.asana_created_field"|"custom_field_settings.custom_field.created_by"|"custom_field_settings.custom_field.created_by.name"|"custom_field_settings.custom_field.currency_code"|"custom_field_settings.custom_field.custom_label"|"custom_field_settings.custom_field.custom_label_position"|"custom_field_settings.custom_field.date_value"|"custom_field_settings.custom_field.date_value.date"|"custom_field_settings.custom_field.date_value.date_time"|"custom_field_settings.custom_field.description"|"custom_field_settings.custom_field.display_value"|"custom_field_settings.custom_field.enabled"|"custom_field_settings.custom_field.enum_options"|"custom_field_settings.custom_field.enum_options.color"|"custom_field_settings.custom_field.enum_options.enabled"|"custom_field_settings.custom_field.enum_options.name"|"custom_field_settings.custom_field.enum_value"|"custom_field_settings.custom_field.enum_value.color"|"custom_field_settings.custom_field.enum_value.enabled"|"custom_field_settings.custom_field.enum_value.name"|"custom_field_settings.custom_field.format"|"custom_field_settings.custom_field.has_notifications_enabled"|"custom_field_settings.custom_field.id_prefix"|"custom_field_settings.custom_field.is_formula_field"|"custom_field_settings.custom_field.is_global_to_workspace"|"custom_field_settings.custom_field.is_value_read_only"|"custom_field_settings.custom_field.multi_enum_values"|"custom_field_settings.custom_field.multi_enum_values.color"|"custom_field_settings.custom_field.multi_enum_values.enabled"|"custom_field_settings.custom_field.multi_enum_values.name"|"custom_field_settings.custom_field.name"|"custom_field_settings.custom_field.number_value"|"custom_field_settings.custom_field.people_value"|"custom_field_settings.custom_field.people_value.name"|"custom_field_settings.custom_field.precision"|"custom_field_settings.custom_field.representation_type"|"custom_field_settings.custom_field.resource_subtype"|"custom_field_settings.custom_field.text_value"|"custom_field_settings.custom_field.type"|"custom_field_settings.is_important"|"custom_field_settings.parent"|"custom_field_settings.parent.name"|"custom_field_settings.project"|"custom_field_settings.project.name"|"custom_fields"|"custom_fields.date_value"|"custom_fields.date_value.date"|"custom_fields.date_value.date_time"|"custom_fields.display_value"|"custom_fields.enabled"|"custom_fields.enum_options"|"custom_fields.enum_options.color"|"custom_fields.enum_options.enabled"|"custom_fields.enum_options.name"|"custom_fields.enum_value"|"custom_fields.enum_value.color"|"custom_fields.enum_value.enabled"|"custom_fields.enum_value.name"|"custom_fields.id_prefix"|"custom_fields.is_formula_field"|"custom_fields.multi_enum_values"|"custom_fields.multi_enum_values.color"|"custom_fields.multi_enum_values.enabled"|"custom_fields.multi_enum_values.name"|"custom_fields.name"|"custom_fields.number_value"|"custom_fields.representation_type"|"custom_fields.resource_subtype"|"custom_fields.text_value"|"custom_fields.type"|"default_access_level"|"default_view"|"due_date"|"due_on"|"followers"|"followers.name"|"html_notes"|"icon"|"members"|"members.name"|"minimum_access_level_for_customization"|"minimum_access_level_for_sharing"|"modified_at"|"name"|"notes"|"owner"|"permalink_url"|"privacy_setting"|"project_brief"|"public"|"start_on"|"team"|"team.name"|"workspace"|"workspace.name")[]? opt_fields) returns Inline_response_201_5|error
Add followers to a project
Parameters
- payload Project_gid_addFollowers_body - Information about the followers being added.
- opt_pretty boolean? (default ()) - 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 ("archived"|"color"|"completed"|"completed_at"|"completed_by"|"completed_by.name"|"created_at"|"created_from_template"|"created_from_template.name"|"current_status"|"current_status.author"|"current_status.author.name"|"current_status.color"|"current_status.created_at"|"current_status.created_by"|"current_status.created_by.name"|"current_status.html_text"|"current_status.modified_at"|"current_status.text"|"current_status.title"|"current_status_update"|"current_status_update.resource_subtype"|"current_status_update.title"|"custom_field_settings"|"custom_field_settings.custom_field"|"custom_field_settings.custom_field.asana_created_field"|"custom_field_settings.custom_field.created_by"|"custom_field_settings.custom_field.created_by.name"|"custom_field_settings.custom_field.currency_code"|"custom_field_settings.custom_field.custom_label"|"custom_field_settings.custom_field.custom_label_position"|"custom_field_settings.custom_field.date_value"|"custom_field_settings.custom_field.date_value.date"|"custom_field_settings.custom_field.date_value.date_time"|"custom_field_settings.custom_field.description"|"custom_field_settings.custom_field.display_value"|"custom_field_settings.custom_field.enabled"|"custom_field_settings.custom_field.enum_options"|"custom_field_settings.custom_field.enum_options.color"|"custom_field_settings.custom_field.enum_options.enabled"|"custom_field_settings.custom_field.enum_options.name"|"custom_field_settings.custom_field.enum_value"|"custom_field_settings.custom_field.enum_value.color"|"custom_field_settings.custom_field.enum_value.enabled"|"custom_field_settings.custom_field.enum_value.name"|"custom_field_settings.custom_field.format"|"custom_field_settings.custom_field.has_notifications_enabled"|"custom_field_settings.custom_field.id_prefix"|"custom_field_settings.custom_field.is_formula_field"|"custom_field_settings.custom_field.is_global_to_workspace"|"custom_field_settings.custom_field.is_value_read_only"|"custom_field_settings.custom_field.multi_enum_values"|"custom_field_settings.custom_field.multi_enum_values.color"|"custom_field_settings.custom_field.multi_enum_values.enabled"|"custom_field_settings.custom_field.multi_enum_values.name"|"custom_field_settings.custom_field.name"|"custom_field_settings.custom_field.number_value"|"custom_field_settings.custom_field.people_value"|"custom_field_settings.custom_field.people_value.name"|"custom_field_settings.custom_field.precision"|"custom_field_settings.custom_field.representation_type"|"custom_field_settings.custom_field.resource_subtype"|"custom_field_settings.custom_field.text_value"|"custom_field_settings.custom_field.type"|"custom_field_settings.is_important"|"custom_field_settings.parent"|"custom_field_settings.parent.name"|"custom_field_settings.project"|"custom_field_settings.project.name"|"custom_fields"|"custom_fields.date_value"|"custom_fields.date_value.date"|"custom_fields.date_value.date_time"|"custom_fields.display_value"|"custom_fields.enabled"|"custom_fields.enum_options"|"custom_fields.enum_options.color"|"custom_fields.enum_options.enabled"|"custom_fields.enum_options.name"|"custom_fields.enum_value"|"custom_fields.enum_value.color"|"custom_fields.enum_value.enabled"|"custom_fields.enum_value.name"|"custom_fields.id_prefix"|"custom_fields.is_formula_field"|"custom_fields.multi_enum_values"|"custom_fields.multi_enum_values.color"|"custom_fields.multi_enum_values.enabled"|"custom_fields.multi_enum_values.name"|"custom_fields.name"|"custom_fields.number_value"|"custom_fields.representation_type"|"custom_fields.resource_subtype"|"custom_fields.text_value"|"custom_fields.type"|"default_access_level"|"default_view"|"due_date"|"due_on"|"followers"|"followers.name"|"html_notes"|"icon"|"members"|"members.name"|"minimum_access_level_for_customization"|"minimum_access_level_for_sharing"|"modified_at"|"name"|"notes"|"owner"|"permalink_url"|"privacy_setting"|"project_brief"|"public"|"start_on"|"team"|"team.name"|"workspace"|"workspace.name")[]? (default ()) - This endpoint returns a compact 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.
Return Type
- Inline_response_201_5|error - Successfully added followers to the project.
post projects/[string project_gid]/removeFollowers
function post projects/[string project_gid]/removeFollowers(Project_gid_removeFollowers_body payload, boolean? opt_pretty, ("archived"|"color"|"completed"|"completed_at"|"completed_by"|"completed_by.name"|"created_at"|"created_from_template"|"created_from_template.name"|"current_status"|"current_status.author"|"current_status.author.name"|"current_status.color"|"current_status.created_at"|"current_status.created_by"|"current_status.created_by.name"|"current_status.html_text"|"current_status.modified_at"|"current_status.text"|"current_status.title"|"current_status_update"|"current_status_update.resource_subtype"|"current_status_update.title"|"custom_field_settings"|"custom_field_settings.custom_field"|"custom_field_settings.custom_field.asana_created_field"|"custom_field_settings.custom_field.created_by"|"custom_field_settings.custom_field.created_by.name"|"custom_field_settings.custom_field.currency_code"|"custom_field_settings.custom_field.custom_label"|"custom_field_settings.custom_field.custom_label_position"|"custom_field_settings.custom_field.date_value"|"custom_field_settings.custom_field.date_value.date"|"custom_field_settings.custom_field.date_value.date_time"|"custom_field_settings.custom_field.description"|"custom_field_settings.custom_field.display_value"|"custom_field_settings.custom_field.enabled"|"custom_field_settings.custom_field.enum_options"|"custom_field_settings.custom_field.enum_options.color"|"custom_field_settings.custom_field.enum_options.enabled"|"custom_field_settings.custom_field.enum_options.name"|"custom_field_settings.custom_field.enum_value"|"custom_field_settings.custom_field.enum_value.color"|"custom_field_settings.custom_field.enum_value.enabled"|"custom_field_settings.custom_field.enum_value.name"|"custom_field_settings.custom_field.format"|"custom_field_settings.custom_field.has_notifications_enabled"|"custom_field_settings.custom_field.id_prefix"|"custom_field_settings.custom_field.is_formula_field"|"custom_field_settings.custom_field.is_global_to_workspace"|"custom_field_settings.custom_field.is_value_read_only"|"custom_field_settings.custom_field.multi_enum_values"|"custom_field_settings.custom_field.multi_enum_values.color"|"custom_field_settings.custom_field.multi_enum_values.enabled"|"custom_field_settings.custom_field.multi_enum_values.name"|"custom_field_settings.custom_field.name"|"custom_field_settings.custom_field.number_value"|"custom_field_settings.custom_field.people_value"|"custom_field_settings.custom_field.people_value.name"|"custom_field_settings.custom_field.precision"|"custom_field_settings.custom_field.representation_type"|"custom_field_settings.custom_field.resource_subtype"|"custom_field_settings.custom_field.text_value"|"custom_field_settings.custom_field.type"|"custom_field_settings.is_important"|"custom_field_settings.parent"|"custom_field_settings.parent.name"|"custom_field_settings.project"|"custom_field_settings.project.name"|"custom_fields"|"custom_fields.date_value"|"custom_fields.date_value.date"|"custom_fields.date_value.date_time"|"custom_fields.display_value"|"custom_fields.enabled"|"custom_fields.enum_options"|"custom_fields.enum_options.color"|"custom_fields.enum_options.enabled"|"custom_fields.enum_options.name"|"custom_fields.enum_value"|"custom_fields.enum_value.color"|"custom_fields.enum_value.enabled"|"custom_fields.enum_value.name"|"custom_fields.id_prefix"|"custom_fields.is_formula_field"|"custom_fields.multi_enum_values"|"custom_fields.multi_enum_values.color"|"custom_fields.multi_enum_values.enabled"|"custom_fields.multi_enum_values.name"|"custom_fields.name"|"custom_fields.number_value"|"custom_fields.representation_type"|"custom_fields.resource_subtype"|"custom_fields.text_value"|"custom_fields.type"|"default_access_level"|"default_view"|"due_date"|"due_on"|"followers"|"followers.name"|"html_notes"|"icon"|"members"|"members.name"|"minimum_access_level_for_customization"|"minimum_access_level_for_sharing"|"modified_at"|"name"|"notes"|"owner"|"permalink_url"|"privacy_setting"|"project_brief"|"public"|"start_on"|"team"|"team.name"|"workspace"|"workspace.name")[]? opt_fields) returns Inline_response_201_5|error
Remove followers from a project
Parameters
- payload Project_gid_removeFollowers_body - Information about the followers being removed.
- opt_pretty boolean? (default ()) - 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 ("archived"|"color"|"completed"|"completed_at"|"completed_by"|"completed_by.name"|"created_at"|"created_from_template"|"created_from_template.name"|"current_status"|"current_status.author"|"current_status.author.name"|"current_status.color"|"current_status.created_at"|"current_status.created_by"|"current_status.created_by.name"|"current_status.html_text"|"current_status.modified_at"|"current_status.text"|"current_status.title"|"current_status_update"|"current_status_update.resource_subtype"|"current_status_update.title"|"custom_field_settings"|"custom_field_settings.custom_field"|"custom_field_settings.custom_field.asana_created_field"|"custom_field_settings.custom_field.created_by"|"custom_field_settings.custom_field.created_by.name"|"custom_field_settings.custom_field.currency_code"|"custom_field_settings.custom_field.custom_label"|"custom_field_settings.custom_field.custom_label_position"|"custom_field_settings.custom_field.date_value"|"custom_field_settings.custom_field.date_value.date"|"custom_field_settings.custom_field.date_value.date_time"|"custom_field_settings.custom_field.description"|"custom_field_settings.custom_field.display_value"|"custom_field_settings.custom_field.enabled"|"custom_field_settings.custom_field.enum_options"|"custom_field_settings.custom_field.enum_options.color"|"custom_field_settings.custom_field.enum_options.enabled"|"custom_field_settings.custom_field.enum_options.name"|"custom_field_settings.custom_field.enum_value"|"custom_field_settings.custom_field.enum_value.color"|"custom_field_settings.custom_field.enum_value.enabled"|"custom_field_settings.custom_field.enum_value.name"|"custom_field_settings.custom_field.format"|"custom_field_settings.custom_field.has_notifications_enabled"|"custom_field_settings.custom_field.id_prefix"|"custom_field_settings.custom_field.is_formula_field"|"custom_field_settings.custom_field.is_global_to_workspace"|"custom_field_settings.custom_field.is_value_read_only"|"custom_field_settings.custom_field.multi_enum_values"|"custom_field_settings.custom_field.multi_enum_values.color"|"custom_field_settings.custom_field.multi_enum_values.enabled"|"custom_field_settings.custom_field.multi_enum_values.name"|"custom_field_settings.custom_field.name"|"custom_field_settings.custom_field.number_value"|"custom_field_settings.custom_field.people_value"|"custom_field_settings.custom_field.people_value.name"|"custom_field_settings.custom_field.precision"|"custom_field_settings.custom_field.representation_type"|"custom_field_settings.custom_field.resource_subtype"|"custom_field_settings.custom_field.text_value"|"custom_field_settings.custom_field.type"|"custom_field_settings.is_important"|"custom_field_settings.parent"|"custom_field_settings.parent.name"|"custom_field_settings.project"|"custom_field_settings.project.name"|"custom_fields"|"custom_fields.date_value"|"custom_fields.date_value.date"|"custom_fields.date_value.date_time"|"custom_fields.display_value"|"custom_fields.enabled"|"custom_fields.enum_options"|"custom_fields.enum_options.color"|"custom_fields.enum_options.enabled"|"custom_fields.enum_options.name"|"custom_fields.enum_value"|"custom_fields.enum_value.color"|"custom_fields.enum_value.enabled"|"custom_fields.enum_value.name"|"custom_fields.id_prefix"|"custom_fields.is_formula_field"|"custom_fields.multi_enum_values"|"custom_fields.multi_enum_values.color"|"custom_fields.multi_enum_values.enabled"|"custom_fields.multi_enum_values.name"|"custom_fields.name"|"custom_fields.number_value"|"custom_fields.representation_type"|"custom_fields.resource_subtype"|"custom_fields.text_value"|"custom_fields.type"|"default_access_level"|"default_view"|"due_date"|"due_on"|"followers"|"followers.name"|"html_notes"|"icon"|"members"|"members.name"|"minimum_access_level_for_customization"|"minimum_access_level_for_sharing"|"modified_at"|"name"|"notes"|"owner"|"permalink_url"|"privacy_setting"|"project_brief"|"public"|"start_on"|"team"|"team.name"|"workspace"|"workspace.name")[]? (default ()) - This endpoint returns a compact 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.
Return Type
- Inline_response_201_5|error - Successfully removed followers from the project.
post projects/[string project_gid]/saveAsTemplate
function post projects/[string project_gid]/saveAsTemplate(Project_gid_saveAsTemplate_body payload, boolean? opt_pretty, ("new_project"|"new_project.name"|"new_project_template"|"new_project_template.name"|"new_task"|"new_task.created_by"|"new_task.name"|"new_task.resource_subtype"|"new_task_template"|"new_task_template.name"|"resource_subtype"|"status")[]? opt_fields) returns Inline_response_200_13|error
Create a project template from a project
Parameters
- payload Project_gid_saveAsTemplate_body - Describes the inputs used for creating a project template, such as the resulting project template's name, which team it should be created in.
- opt_pretty boolean? (default ()) - 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 ("new_project"|"new_project.name"|"new_project_template"|"new_project_template.name"|"new_task"|"new_task.created_by"|"new_task.name"|"new_task.resource_subtype"|"new_task_template"|"new_task_template.name"|"resource_subtype"|"status")[]? (default ()) - This endpoint returns a compact 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.
Return Type
- Inline_response_200_13|error - Successfully created the job to handle project template creation.
post rule_triggers/[string rule_trigger_gid]/run
function post rule_triggers/[string rule_trigger_gid]/run(Rule_trigger_gid_run_body payload) returns Inline_response_200_29|error
Trigger a rule
Parameters
- payload Rule_trigger_gid_run_body - A dictionary of variables accessible from within the rule.
Return Type
- Inline_response_200_29|error - Successfully triggered a rule.
get sections/[string section_gid]
function get sections/[string section_gid](boolean? opt_pretty, ("created_at"|"name"|"project"|"project.name"|"projects"|"projects.name")[]? opt_fields) returns Inline_response_200_30|error
Get a section
Parameters
- opt_pretty boolean? (default ()) - 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 ("created_at"|"name"|"project"|"project.name"|"projects"|"projects.name")[]? (default ()) - This endpoint returns a compact 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.
Return Type
- Inline_response_200_30|error - Successfully retrieved section.
put sections/[string section_gid]
function put sections/[string section_gid](Sections_section_gid_body payload, boolean? opt_pretty, ("created_at"|"name"|"project"|"project.name"|"projects"|"projects.name")[]? opt_fields) returns Inline_response_200_30|error
Update a section
Parameters
- payload Sections_section_gid_body - The section to create.
- opt_pretty boolean? (default ()) - 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 ("created_at"|"name"|"project"|"project.name"|"projects"|"projects.name")[]? (default ()) - This endpoint returns a compact 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.
Return Type
- Inline_response_200_30|error - Successfully updated the specified section.
delete sections/[string section_gid]
function delete sections/[string section_gid](boolean? opt_pretty) returns Inline_response_200_1|error
Delete a section
Parameters
- opt_pretty boolean? (default ()) - 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.
Return Type
- Inline_response_200_1|error - Successfully deleted the specified section.
get projects/[string project_gid]/sections
function get projects/[string project_gid]/sections(boolean? opt_pretty, int? 'limit, string? offset, ("created_at"|"name"|"offset"|"path"|"project"|"project.name"|"projects"|"projects.name"|"uri")[]? opt_fields) returns Inline_response_200_31|error
Get sections in a project
Parameters
- opt_pretty boolean? (default ()) - 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.
- 'limit int? (default ()) - Results per page. The number of objects to return per page. The value must be between 1 and 100.
- offset string? (default ()) - Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.'
- opt_fields ("created_at"|"name"|"offset"|"path"|"project"|"project.name"|"projects"|"projects.name"|"uri")[]? (default ()) - This endpoint returns a compact 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.
Return Type
- Inline_response_200_31|error - Successfully retrieved sections in project.
post projects/[string project_gid]/sections
function post projects/[string project_gid]/sections(Project_gid_sections_body payload, boolean? opt_pretty, ("created_at"|"name"|"project"|"project.name"|"projects"|"projects.name")[]? opt_fields) returns Inline_response_200_30|error
Create a section in a project
Parameters
- payload Project_gid_sections_body - The section to create.
- opt_pretty boolean? (default ()) - 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 ("created_at"|"name"|"project"|"project.name"|"projects"|"projects.name")[]? (default ()) - This endpoint returns a compact 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.
Return Type
- Inline_response_200_30|error - Successfully created the specified section.
post sections/[string section_gid]/addTask
function post sections/[string section_gid]/addTask(Section_gid_addTask_body payload, boolean? opt_pretty) returns Inline_response_200_1|error
Add task to section
Parameters
- payload Section_gid_addTask_body - The task and optionally the insert location.
- opt_pretty boolean? (default ()) - 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.
Return Type
- Inline_response_200_1|error - Successfully added the task.
post projects/[string project_gid]/sections/insert
function post projects/[string project_gid]/sections/insert(Sections_insert_body payload, boolean? opt_pretty) returns Inline_response_200_1|error
Move or Insert sections
Parameters
- payload Sections_insert_body - The section's move action.
- opt_pretty boolean? (default ()) - 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.
Return Type
- Inline_response_200_1|error - Successfully moved the specified section.
get status_updates/[string status_update_gid]
function get status_updates/[string status_update_gid](boolean? opt_pretty, ("author"|"author.name"|"created_at"|"created_by"|"created_by.name"|"hearted"|"hearts"|"hearts.user"|"hearts.user.name"|"html_text"|"liked"|"likes"|"likes.user"|"likes.user.name"|"modified_at"|"num_hearts"|"num_likes"|"parent"|"parent.name"|"resource_subtype"|"status_type"|"text"|"title")[]? opt_fields) returns Inline_response_200_32|error
Get a status update
Parameters
- opt_pretty boolean? (default ()) - 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 ("author"|"author.name"|"created_at"|"created_by"|"created_by.name"|"hearted"|"hearts"|"hearts.user"|"hearts.user.name"|"html_text"|"liked"|"likes"|"likes.user"|"likes.user.name"|"modified_at"|"num_hearts"|"num_likes"|"parent"|"parent.name"|"resource_subtype"|"status_type"|"text"|"title")[]? (default ()) - This endpoint returns a compact 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.
Return Type
- Inline_response_200_32|error - Successfully retrieved the specified object's status updates.
delete status_updates/[string status_update_gid]
function delete status_updates/[string status_update_gid](boolean? opt_pretty) returns Inline_response_200_1|error
Delete a status update
Parameters
- opt_pretty boolean? (default ()) - 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.
Return Type
- Inline_response_200_1|error - Successfully deleted the specified status.
get status_updates
function get status_updates(string parent, boolean? opt_pretty, int? 'limit, string? offset, string? created_since, ("author"|"author.name"|"created_at"|"created_by"|"created_by.name"|"hearted"|"hearts"|"hearts.user"|"hearts.user.name"|"html_text"|"liked"|"likes"|"likes.user"|"likes.user.name"|"modified_at"|"num_hearts"|"num_likes"|"offset"|"parent"|"parent.name"|"path"|"resource_subtype"|"status_type"|"text"|"title"|"uri")[]? opt_fields) returns Inline_response_200_33|error
Get status updates from an object
Parameters
- parent string - Globally unique identifier for object to fetch statuses from. Must be a GID for a project, portfolio, or goal.
- opt_pretty boolean? (default ()) - 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.
- 'limit int? (default ()) - Results per page. The number of objects to return per page. The value must be between 1 and 100.
- offset string? (default ()) - Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.'
- created_since string? (default ()) - Only return statuses that have been created since the given time.
- opt_fields ("author"|"author.name"|"created_at"|"created_by"|"created_by.name"|"hearted"|"hearts"|"hearts.user"|"hearts.user.name"|"html_text"|"liked"|"likes"|"likes.user"|"likes.user.name"|"modified_at"|"num_hearts"|"num_likes"|"offset"|"parent"|"parent.name"|"path"|"resource_subtype"|"status_type"|"text"|"title"|"uri")[]? (default ()) - This endpoint returns a compact 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.
Return Type
- Inline_response_200_33|error - Successfully retrieved the specified object's status updates.
post status_updates
function post status_updates(Status_updates_body payload, boolean? opt_pretty, int? 'limit, string? offset, ("author"|"author.name"|"created_at"|"created_by"|"created_by.name"|"hearted"|"hearts"|"hearts.user"|"hearts.user.name"|"html_text"|"liked"|"likes"|"likes.user"|"likes.user.name"|"modified_at"|"num_hearts"|"num_likes"|"parent"|"parent.name"|"resource_subtype"|"status_type"|"text"|"title")[]? opt_fields) returns Inline_response_200_32|error
Create a status update
Parameters
- payload Status_updates_body - The status update to create.
- opt_pretty boolean? (default ()) - 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.
- 'limit int? (default ()) - Results per page. The number of objects to return per page. The value must be between 1 and 100.
- offset string? (default ()) - Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.'
- opt_fields ("author"|"author.name"|"created_at"|"created_by"|"created_by.name"|"hearted"|"hearts"|"hearts.user"|"hearts.user.name"|"html_text"|"liked"|"likes"|"likes.user"|"likes.user.name"|"modified_at"|"num_hearts"|"num_likes"|"parent"|"parent.name"|"resource_subtype"|"status_type"|"text"|"title")[]? (default ()) - This endpoint returns a compact 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.
Return Type
- Inline_response_200_32|error - Successfully created a new status update.
get stories/[string story_gid]
function get stories/[string story_gid](boolean? opt_pretty, ("assignee"|"assignee.name"|"created_at"|"created_by"|"created_by.name"|"custom_field"|"custom_field.date_value"|"custom_field.date_value.date"|"custom_field.date_value.date_time"|"custom_field.display_value"|"custom_field.enabled"|"custom_field.enum_options"|"custom_field.enum_options.color"|"custom_field.enum_options.enabled"|"custom_field.enum_options.name"|"custom_field.enum_value"|"custom_field.enum_value.color"|"custom_field.enum_value.enabled"|"custom_field.enum_value.name"|"custom_field.id_prefix"|"custom_field.is_formula_field"|"custom_field.multi_enum_values"|"custom_field.multi_enum_values.color"|"custom_field.multi_enum_values.enabled"|"custom_field.multi_enum_values.name"|"custom_field.name"|"custom_field.number_value"|"custom_field.representation_type"|"custom_field.resource_subtype"|"custom_field.text_value"|"custom_field.type"|"dependency"|"dependency.created_by"|"dependency.name"|"dependency.resource_subtype"|"duplicate_of"|"duplicate_of.created_by"|"duplicate_of.name"|"duplicate_of.resource_subtype"|"duplicated_from"|"duplicated_from.created_by"|"duplicated_from.name"|"duplicated_from.resource_subtype"|"follower"|"follower.name"|"hearted"|"hearts"|"hearts.user"|"hearts.user.name"|"html_text"|"is_editable"|"is_edited"|"is_pinned"|"liked"|"likes"|"likes.user"|"likes.user.name"|"new_approval_status"|"new_date_value"|"new_dates"|"new_dates.due_at"|"new_dates.due_on"|"new_dates.start_on"|"new_enum_value"|"new_enum_value.color"|"new_enum_value.enabled"|"new_enum_value.name"|"new_multi_enum_values"|"new_multi_enum_values.color"|"new_multi_enum_values.enabled"|"new_multi_enum_values.name"|"new_name"|"new_number_value"|"new_people_value"|"new_people_value.name"|"new_resource_subtype"|"new_section"|"new_section.name"|"new_text_value"|"num_hearts"|"num_likes"|"old_approval_status"|"old_date_value"|"old_dates"|"old_dates.due_at"|"old_dates.due_on"|"old_dates.start_on"|"old_enum_value"|"old_enum_value.color"|"old_enum_value.enabled"|"old_enum_value.name"|"old_multi_enum_values"|"old_multi_enum_values.color"|"old_multi_enum_values.enabled"|"old_multi_enum_values.name"|"old_name"|"old_number_value"|"old_people_value"|"old_people_value.name"|"old_resource_subtype"|"old_section"|"old_section.name"|"old_text_value"|"previews"|"previews.fallback"|"previews.footer"|"previews.header"|"previews.header_link"|"previews.html_text"|"previews.text"|"previews.title"|"previews.title_link"|"project"|"project.name"|"resource_subtype"|"source"|"sticker_name"|"story"|"story.created_at"|"story.created_by"|"story.created_by.name"|"story.resource_subtype"|"story.text"|"tag"|"tag.name"|"target"|"target.created_by"|"target.name"|"target.resource_subtype"|"task"|"task.created_by"|"task.name"|"task.resource_subtype"|"text"|"type")[]? opt_fields) returns Inline_response_200_34|error
Get a story
Parameters
- opt_pretty boolean? (default ()) - 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 ("assignee"|"assignee.name"|"created_at"|"created_by"|"created_by.name"|"custom_field"|"custom_field.date_value"|"custom_field.date_value.date"|"custom_field.date_value.date_time"|"custom_field.display_value"|"custom_field.enabled"|"custom_field.enum_options"|"custom_field.enum_options.color"|"custom_field.enum_options.enabled"|"custom_field.enum_options.name"|"custom_field.enum_value"|"custom_field.enum_value.color"|"custom_field.enum_value.enabled"|"custom_field.enum_value.name"|"custom_field.id_prefix"|"custom_field.is_formula_field"|"custom_field.multi_enum_values"|"custom_field.multi_enum_values.color"|"custom_field.multi_enum_values.enabled"|"custom_field.multi_enum_values.name"|"custom_field.name"|"custom_field.number_value"|"custom_field.representation_type"|"custom_field.resource_subtype"|"custom_field.text_value"|"custom_field.type"|"dependency"|"dependency.created_by"|"dependency.name"|"dependency.resource_subtype"|"duplicate_of"|"duplicate_of.created_by"|"duplicate_of.name"|"duplicate_of.resource_subtype"|"duplicated_from"|"duplicated_from.created_by"|"duplicated_from.name"|"duplicated_from.resource_subtype"|"follower"|"follower.name"|"hearted"|"hearts"|"hearts.user"|"hearts.user.name"|"html_text"|"is_editable"|"is_edited"|"is_pinned"|"liked"|"likes"|"likes.user"|"likes.user.name"|"new_approval_status"|"new_date_value"|"new_dates"|"new_dates.due_at"|"new_dates.due_on"|"new_dates.start_on"|"new_enum_value"|"new_enum_value.color"|"new_enum_value.enabled"|"new_enum_value.name"|"new_multi_enum_values"|"new_multi_enum_values.color"|"new_multi_enum_values.enabled"|"new_multi_enum_values.name"|"new_name"|"new_number_value"|"new_people_value"|"new_people_value.name"|"new_resource_subtype"|"new_section"|"new_section.name"|"new_text_value"|"num_hearts"|"num_likes"|"old_approval_status"|"old_date_value"|"old_dates"|"old_dates.due_at"|"old_dates.due_on"|"old_dates.start_on"|"old_enum_value"|"old_enum_value.color"|"old_enum_value.enabled"|"old_enum_value.name"|"old_multi_enum_values"|"old_multi_enum_values.color"|"old_multi_enum_values.enabled"|"old_multi_enum_values.name"|"old_name"|"old_number_value"|"old_people_value"|"old_people_value.name"|"old_resource_subtype"|"old_section"|"old_section.name"|"old_text_value"|"previews"|"previews.fallback"|"previews.footer"|"previews.header"|"previews.header_link"|"previews.html_text"|"previews.text"|"previews.title"|"previews.title_link"|"project"|"project.name"|"resource_subtype"|"source"|"sticker_name"|"story"|"story.created_at"|"story.created_by"|"story.created_by.name"|"story.resource_subtype"|"story.text"|"tag"|"tag.name"|"target"|"target.created_by"|"target.name"|"target.resource_subtype"|"task"|"task.created_by"|"task.name"|"task.resource_subtype"|"text"|"type")[]? (default ()) - This endpoint returns a compact 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.
Return Type
- Inline_response_200_34|error - Successfully retrieved the specified story.
put stories/[string story_gid]
function put stories/[string story_gid](Stories_story_gid_body payload, boolean? opt_pretty, ("assignee"|"assignee.name"|"created_at"|"created_by"|"created_by.name"|"custom_field"|"custom_field.date_value"|"custom_field.date_value.date"|"custom_field.date_value.date_time"|"custom_field.display_value"|"custom_field.enabled"|"custom_field.enum_options"|"custom_field.enum_options.color"|"custom_field.enum_options.enabled"|"custom_field.enum_options.name"|"custom_field.enum_value"|"custom_field.enum_value.color"|"custom_field.enum_value.enabled"|"custom_field.enum_value.name"|"custom_field.id_prefix"|"custom_field.is_formula_field"|"custom_field.multi_enum_values"|"custom_field.multi_enum_values.color"|"custom_field.multi_enum_values.enabled"|"custom_field.multi_enum_values.name"|"custom_field.name"|"custom_field.number_value"|"custom_field.representation_type"|"custom_field.resource_subtype"|"custom_field.text_value"|"custom_field.type"|"dependency"|"dependency.created_by"|"dependency.name"|"dependency.resource_subtype"|"duplicate_of"|"duplicate_of.created_by"|"duplicate_of.name"|"duplicate_of.resource_subtype"|"duplicated_from"|"duplicated_from.created_by"|"duplicated_from.name"|"duplicated_from.resource_subtype"|"follower"|"follower.name"|"hearted"|"hearts"|"hearts.user"|"hearts.user.name"|"html_text"|"is_editable"|"is_edited"|"is_pinned"|"liked"|"likes"|"likes.user"|"likes.user.name"|"new_approval_status"|"new_date_value"|"new_dates"|"new_dates.due_at"|"new_dates.due_on"|"new_dates.start_on"|"new_enum_value"|"new_enum_value.color"|"new_enum_value.enabled"|"new_enum_value.name"|"new_multi_enum_values"|"new_multi_enum_values.color"|"new_multi_enum_values.enabled"|"new_multi_enum_values.name"|"new_name"|"new_number_value"|"new_people_value"|"new_people_value.name"|"new_resource_subtype"|"new_section"|"new_section.name"|"new_text_value"|"num_hearts"|"num_likes"|"old_approval_status"|"old_date_value"|"old_dates"|"old_dates.due_at"|"old_dates.due_on"|"old_dates.start_on"|"old_enum_value"|"old_enum_value.color"|"old_enum_value.enabled"|"old_enum_value.name"|"old_multi_enum_values"|"old_multi_enum_values.color"|"old_multi_enum_values.enabled"|"old_multi_enum_values.name"|"old_name"|"old_number_value"|"old_people_value"|"old_people_value.name"|"old_resource_subtype"|"old_section"|"old_section.name"|"old_text_value"|"previews"|"previews.fallback"|"previews.footer"|"previews.header"|"previews.header_link"|"previews.html_text"|"previews.text"|"previews.title"|"previews.title_link"|"project"|"project.name"|"resource_subtype"|"source"|"sticker_name"|"story"|"story.created_at"|"story.created_by"|"story.created_by.name"|"story.resource_subtype"|"story.text"|"tag"|"tag.name"|"target"|"target.created_by"|"target.name"|"target.resource_subtype"|"task"|"task.created_by"|"task.name"|"task.resource_subtype"|"text"|"type")[]? opt_fields) returns Inline_response_200_34|error
Update a story
Parameters
- payload Stories_story_gid_body - The comment story to update.
- opt_pretty boolean? (default ()) - 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 ("assignee"|"assignee.name"|"created_at"|"created_by"|"created_by.name"|"custom_field"|"custom_field.date_value"|"custom_field.date_value.date"|"custom_field.date_value.date_time"|"custom_field.display_value"|"custom_field.enabled"|"custom_field.enum_options"|"custom_field.enum_options.color"|"custom_field.enum_options.enabled"|"custom_field.enum_options.name"|"custom_field.enum_value"|"custom_field.enum_value.color"|"custom_field.enum_value.enabled"|"custom_field.enum_value.name"|"custom_field.id_prefix"|"custom_field.is_formula_field"|"custom_field.multi_enum_values"|"custom_field.multi_enum_values.color"|"custom_field.multi_enum_values.enabled"|"custom_field.multi_enum_values.name"|"custom_field.name"|"custom_field.number_value"|"custom_field.representation_type"|"custom_field.resource_subtype"|"custom_field.text_value"|"custom_field.type"|"dependency"|"dependency.created_by"|"dependency.name"|"dependency.resource_subtype"|"duplicate_of"|"duplicate_of.created_by"|"duplicate_of.name"|"duplicate_of.resource_subtype"|"duplicated_from"|"duplicated_from.created_by"|"duplicated_from.name"|"duplicated_from.resource_subtype"|"follower"|"follower.name"|"hearted"|"hearts"|"hearts.user"|"hearts.user.name"|"html_text"|"is_editable"|"is_edited"|"is_pinned"|"liked"|"likes"|"likes.user"|"likes.user.name"|"new_approval_status"|"new_date_value"|"new_dates"|"new_dates.due_at"|"new_dates.due_on"|"new_dates.start_on"|"new_enum_value"|"new_enum_value.color"|"new_enum_value.enabled"|"new_enum_value.name"|"new_multi_enum_values"|"new_multi_enum_values.color"|"new_multi_enum_values.enabled"|"new_multi_enum_values.name"|"new_name"|"new_number_value"|"new_people_value"|"new_people_value.name"|"new_resource_subtype"|"new_section"|"new_section.name"|"new_text_value"|"num_hearts"|"num_likes"|"old_approval_status"|"old_date_value"|"old_dates"|"old_dates.due_at"|"old_dates.due_on"|"old_dates.start_on"|"old_enum_value"|"old_enum_value.color"|"old_enum_value.enabled"|"old_enum_value.name"|"old_multi_enum_values"|"old_multi_enum_values.color"|"old_multi_enum_values.enabled"|"old_multi_enum_values.name"|"old_name"|"old_number_value"|"old_people_value"|"old_people_value.name"|"old_resource_subtype"|"old_section"|"old_section.name"|"old_text_value"|"previews"|"previews.fallback"|"previews.footer"|"previews.header"|"previews.header_link"|"previews.html_text"|"previews.text"|"previews.title"|"previews.title_link"|"project"|"project.name"|"resource_subtype"|"source"|"sticker_name"|"story"|"story.created_at"|"story.created_by"|"story.created_by.name"|"story.resource_subtype"|"story.text"|"tag"|"tag.name"|"target"|"target.created_by"|"target.name"|"target.resource_subtype"|"task"|"task.created_by"|"task.name"|"task.resource_subtype"|"text"|"type")[]? (default ()) - This endpoint returns a compact 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.
Return Type
- Inline_response_200_34|error - Successfully retrieved the specified story.
delete stories/[string story_gid]
function delete stories/[string story_gid](boolean? opt_pretty) returns Inline_response_200_1|error
Delete a story
Parameters
- opt_pretty boolean? (default ()) - 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.
Return Type
- Inline_response_200_1|error - Successfully deleted the specified story.
get tasks/[string task_gid]/stories
function get tasks/[string task_gid]/stories(boolean? opt_pretty, int? 'limit, string? offset, ("assignee"|"assignee.name"|"created_at"|"created_by"|"created_by.name"|"custom_field"|"custom_field.date_value"|"custom_field.date_value.date"|"custom_field.date_value.date_time"|"custom_field.display_value"|"custom_field.enabled"|"custom_field.enum_options"|"custom_field.enum_options.color"|"custom_field.enum_options.enabled"|"custom_field.enum_options.name"|"custom_field.enum_value"|"custom_field.enum_value.color"|"custom_field.enum_value.enabled"|"custom_field.enum_value.name"|"custom_field.id_prefix"|"custom_field.is_formula_field"|"custom_field.multi_enum_values"|"custom_field.multi_enum_values.color"|"custom_field.multi_enum_values.enabled"|"custom_field.multi_enum_values.name"|"custom_field.name"|"custom_field.number_value"|"custom_field.representation_type"|"custom_field.resource_subtype"|"custom_field.text_value"|"custom_field.type"|"dependency"|"dependency.created_by"|"dependency.name"|"dependency.resource_subtype"|"duplicate_of"|"duplicate_of.created_by"|"duplicate_of.name"|"duplicate_of.resource_subtype"|"duplicated_from"|"duplicated_from.created_by"|"duplicated_from.name"|"duplicated_from.resource_subtype"|"follower"|"follower.name"|"hearted"|"hearts"|"hearts.user"|"hearts.user.name"|"html_text"|"is_editable"|"is_edited"|"is_pinned"|"liked"|"likes"|"likes.user"|"likes.user.name"|"new_approval_status"|"new_date_value"|"new_dates"|"new_dates.due_at"|"new_dates.due_on"|"new_dates.start_on"|"new_enum_value"|"new_enum_value.color"|"new_enum_value.enabled"|"new_enum_value.name"|"new_multi_enum_values"|"new_multi_enum_values.color"|"new_multi_enum_values.enabled"|"new_multi_enum_values.name"|"new_name"|"new_number_value"|"new_people_value"|"new_people_value.name"|"new_resource_subtype"|"new_section"|"new_section.name"|"new_text_value"|"num_hearts"|"num_likes"|"offset"|"old_approval_status"|"old_date_value"|"old_dates"|"old_dates.due_at"|"old_dates.due_on"|"old_dates.start_on"|"old_enum_value"|"old_enum_value.color"|"old_enum_value.enabled"|"old_enum_value.name"|"old_multi_enum_values"|"old_multi_enum_values.color"|"old_multi_enum_values.enabled"|"old_multi_enum_values.name"|"old_name"|"old_number_value"|"old_people_value"|"old_people_value.name"|"old_resource_subtype"|"old_section"|"old_section.name"|"old_text_value"|"path"|"previews"|"previews.fallback"|"previews.footer"|"previews.header"|"previews.header_link"|"previews.html_text"|"previews.text"|"previews.title"|"previews.title_link"|"project"|"project.name"|"resource_subtype"|"source"|"sticker_name"|"story"|"story.created_at"|"story.created_by"|"story.created_by.name"|"story.resource_subtype"|"story.text"|"tag"|"tag.name"|"target"|"target.created_by"|"target.name"|"target.resource_subtype"|"task"|"task.created_by"|"task.name"|"task.resource_subtype"|"text"|"type"|"uri")[]? opt_fields) returns Inline_response_200_35|error
Get stories from a task
Parameters
- opt_pretty boolean? (default ()) - 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.
- 'limit int? (default ()) - Results per page. The number of objects to return per page. The value must be between 1 and 100.
- offset string? (default ()) - Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.'
- opt_fields ("assignee"|"assignee.name"|"created_at"|"created_by"|"created_by.name"|"custom_field"|"custom_field.date_value"|"custom_field.date_value.date"|"custom_field.date_value.date_time"|"custom_field.display_value"|"custom_field.enabled"|"custom_field.enum_options"|"custom_field.enum_options.color"|"custom_field.enum_options.enabled"|"custom_field.enum_options.name"|"custom_field.enum_value"|"custom_field.enum_value.color"|"custom_field.enum_value.enabled"|"custom_field.enum_value.name"|"custom_field.id_prefix"|"custom_field.is_formula_field"|"custom_field.multi_enum_values"|"custom_field.multi_enum_values.color"|"custom_field.multi_enum_values.enabled"|"custom_field.multi_enum_values.name"|"custom_field.name"|"custom_field.number_value"|"custom_field.representation_type"|"custom_field.resource_subtype"|"custom_field.text_value"|"custom_field.type"|"dependency"|"dependency.created_by"|"dependency.name"|"dependency.resource_subtype"|"duplicate_of"|"duplicate_of.created_by"|"duplicate_of.name"|"duplicate_of.resource_subtype"|"duplicated_from"|"duplicated_from.created_by"|"duplicated_from.name"|"duplicated_from.resource_subtype"|"follower"|"follower.name"|"hearted"|"hearts"|"hearts.user"|"hearts.user.name"|"html_text"|"is_editable"|"is_edited"|"is_pinned"|"liked"|"likes"|"likes.user"|"likes.user.name"|"new_approval_status"|"new_date_value"|"new_dates"|"new_dates.due_at"|"new_dates.due_on"|"new_dates.start_on"|"new_enum_value"|"new_enum_value.color"|"new_enum_value.enabled"|"new_enum_value.name"|"new_multi_enum_values"|"new_multi_enum_values.color"|"new_multi_enum_values.enabled"|"new_multi_enum_values.name"|"new_name"|"new_number_value"|"new_people_value"|"new_people_value.name"|"new_resource_subtype"|"new_section"|"new_section.name"|"new_text_value"|"num_hearts"|"num_likes"|"offset"|"old_approval_status"|"old_date_value"|"old_dates"|"old_dates.due_at"|"old_dates.due_on"|"old_dates.start_on"|"old_enum_value"|"old_enum_value.color"|"old_enum_value.enabled"|"old_enum_value.name"|"old_multi_enum_values"|"old_multi_enum_values.color"|"old_multi_enum_values.enabled"|"old_multi_enum_values.name"|"old_name"|"old_number_value"|"old_people_value"|"old_people_value.name"|"old_resource_subtype"|"old_section"|"old_section.name"|"old_text_value"|"path"|"previews"|"previews.fallback"|"previews.footer"|"previews.header"|"previews.header_link"|"previews.html_text"|"previews.text"|"previews.title"|"previews.title_link"|"project"|"project.name"|"resource_subtype"|"source"|"sticker_name"|"story"|"story.created_at"|"story.created_by"|"story.created_by.name"|"story.resource_subtype"|"story.text"|"tag"|"tag.name"|"target"|"target.created_by"|"target.name"|"target.resource_subtype"|"task"|"task.created_by"|"task.name"|"task.resource_subtype"|"text"|"type"|"uri")[]? (default ()) - This endpoint returns a compact 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.
Return Type
- Inline_response_200_35|error - Successfully retrieved the specified task's stories.
post tasks/[string task_gid]/stories
function post tasks/[string task_gid]/stories(Task_gid_stories_body payload, boolean? opt_pretty, ("assignee"|"assignee.name"|"created_at"|"created_by"|"created_by.name"|"custom_field"|"custom_field.date_value"|"custom_field.date_value.date"|"custom_field.date_value.date_time"|"custom_field.display_value"|"custom_field.enabled"|"custom_field.enum_options"|"custom_field.enum_options.color"|"custom_field.enum_options.enabled"|"custom_field.enum_options.name"|"custom_field.enum_value"|"custom_field.enum_value.color"|"custom_field.enum_value.enabled"|"custom_field.enum_value.name"|"custom_field.id_prefix"|"custom_field.is_formula_field"|"custom_field.multi_enum_values"|"custom_field.multi_enum_values.color"|"custom_field.multi_enum_values.enabled"|"custom_field.multi_enum_values.name"|"custom_field.name"|"custom_field.number_value"|"custom_field.representation_type"|"custom_field.resource_subtype"|"custom_field.text_value"|"custom_field.type"|"dependency"|"dependency.created_by"|"dependency.name"|"dependency.resource_subtype"|"duplicate_of"|"duplicate_of.created_by"|"duplicate_of.name"|"duplicate_of.resource_subtype"|"duplicated_from"|"duplicated_from.created_by"|"duplicated_from.name"|"duplicated_from.resource_subtype"|"follower"|"follower.name"|"hearted"|"hearts"|"hearts.user"|"hearts.user.name"|"html_text"|"is_editable"|"is_edited"|"is_pinned"|"liked"|"likes"|"likes.user"|"likes.user.name"|"new_approval_status"|"new_date_value"|"new_dates"|"new_dates.due_at"|"new_dates.due_on"|"new_dates.start_on"|"new_enum_value"|"new_enum_value.color"|"new_enum_value.enabled"|"new_enum_value.name"|"new_multi_enum_values"|"new_multi_enum_values.color"|"new_multi_enum_values.enabled"|"new_multi_enum_values.name"|"new_name"|"new_number_value"|"new_people_value"|"new_people_value.name"|"new_resource_subtype"|"new_section"|"new_section.name"|"new_text_value"|"num_hearts"|"num_likes"|"old_approval_status"|"old_date_value"|"old_dates"|"old_dates.due_at"|"old_dates.due_on"|"old_dates.start_on"|"old_enum_value"|"old_enum_value.color"|"old_enum_value.enabled"|"old_enum_value.name"|"old_multi_enum_values"|"old_multi_enum_values.color"|"old_multi_enum_values.enabled"|"old_multi_enum_values.name"|"old_name"|"old_number_value"|"old_people_value"|"old_people_value.name"|"old_resource_subtype"|"old_section"|"old_section.name"|"old_text_value"|"previews"|"previews.fallback"|"previews.footer"|"previews.header"|"previews.header_link"|"previews.html_text"|"previews.text"|"previews.title"|"previews.title_link"|"project"|"project.name"|"resource_subtype"|"source"|"sticker_name"|"story"|"story.created_at"|"story.created_by"|"story.created_by.name"|"story.resource_subtype"|"story.text"|"tag"|"tag.name"|"target"|"target.created_by"|"target.name"|"target.resource_subtype"|"task"|"task.created_by"|"task.name"|"task.resource_subtype"|"text"|"type")[]? opt_fields) returns Inline_response_200_34|error
Create a story on a task
Parameters
- payload Task_gid_stories_body - The story to create.
- opt_pretty boolean? (default ()) - 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 ("assignee"|"assignee.name"|"created_at"|"created_by"|"created_by.name"|"custom_field"|"custom_field.date_value"|"custom_field.date_value.date"|"custom_field.date_value.date_time"|"custom_field.display_value"|"custom_field.enabled"|"custom_field.enum_options"|"custom_field.enum_options.color"|"custom_field.enum_options.enabled"|"custom_field.enum_options.name"|"custom_field.enum_value"|"custom_field.enum_value.color"|"custom_field.enum_value.enabled"|"custom_field.enum_value.name"|"custom_field.id_prefix"|"custom_field.is_formula_field"|"custom_field.multi_enum_values"|"custom_field.multi_enum_values.color"|"custom_field.multi_enum_values.enabled"|"custom_field.multi_enum_values.name"|"custom_field.name"|"custom_field.number_value"|"custom_field.representation_type"|"custom_field.resource_subtype"|"custom_field.text_value"|"custom_field.type"|"dependency"|"dependency.created_by"|"dependency.name"|"dependency.resource_subtype"|"duplicate_of"|"duplicate_of.created_by"|"duplicate_of.name"|"duplicate_of.resource_subtype"|"duplicated_from"|"duplicated_from.created_by"|"duplicated_from.name"|"duplicated_from.resource_subtype"|"follower"|"follower.name"|"hearted"|"hearts"|"hearts.user"|"hearts.user.name"|"html_text"|"is_editable"|"is_edited"|"is_pinned"|"liked"|"likes"|"likes.user"|"likes.user.name"|"new_approval_status"|"new_date_value"|"new_dates"|"new_dates.due_at"|"new_dates.due_on"|"new_dates.start_on"|"new_enum_value"|"new_enum_value.color"|"new_enum_value.enabled"|"new_enum_value.name"|"new_multi_enum_values"|"new_multi_enum_values.color"|"new_multi_enum_values.enabled"|"new_multi_enum_values.name"|"new_name"|"new_number_value"|"new_people_value"|"new_people_value.name"|"new_resource_subtype"|"new_section"|"new_section.name"|"new_text_value"|"num_hearts"|"num_likes"|"old_approval_status"|"old_date_value"|"old_dates"|"old_dates.due_at"|"old_dates.due_on"|"old_dates.start_on"|"old_enum_value"|"old_enum_value.color"|"old_enum_value.enabled"|"old_enum_value.name"|"old_multi_enum_values"|"old_multi_enum_values.color"|"old_multi_enum_values.enabled"|"old_multi_enum_values.name"|"old_name"|"old_number_value"|"old_people_value"|"old_people_value.name"|"old_resource_subtype"|"old_section"|"old_section.name"|"old_text_value"|"previews"|"previews.fallback"|"previews.footer"|"previews.header"|"previews.header_link"|"previews.html_text"|"previews.text"|"previews.title"|"previews.title_link"|"project"|"project.name"|"resource_subtype"|"source"|"sticker_name"|"story"|"story.created_at"|"story.created_by"|"story.created_by.name"|"story.resource_subtype"|"story.text"|"tag"|"tag.name"|"target"|"target.created_by"|"target.name"|"target.resource_subtype"|"task"|"task.created_by"|"task.name"|"task.resource_subtype"|"text"|"type")[]? (default ()) - This endpoint returns a compact 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.
Return Type
- Inline_response_200_34|error - Successfully created a new story.
get tags
function get tags(boolean? opt_pretty, int? 'limit, string? offset, string? workspace, ("color"|"created_at"|"followers"|"followers.name"|"name"|"notes"|"offset"|"path"|"permalink_url"|"uri"|"workspace"|"workspace.name")[]? opt_fields) returns Inline_response_200_36|error
Get multiple tags
Parameters
- opt_pretty boolean? (default ()) - 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.
- 'limit int? (default ()) - Results per page. The number of objects to return per page. The value must be between 1 and 100.
- offset string? (default ()) - Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.'
- workspace string? (default ()) - The workspace to filter tags on.
- opt_fields ("color"|"created_at"|"followers"|"followers.name"|"name"|"notes"|"offset"|"path"|"permalink_url"|"uri"|"workspace"|"workspace.name")[]? (default ()) - This endpoint returns a compact 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.
Return Type
- Inline_response_200_36|error - Successfully retrieved the specified set of tags.
post tags
function post tags(Tags_body payload, boolean? opt_pretty, ("color"|"created_at"|"followers"|"followers.name"|"name"|"notes"|"permalink_url"|"workspace"|"workspace.name")[]? opt_fields) returns Inline_response_201_6|error
Create a tag
Parameters
- payload Tags_body - The tag to create.
- opt_pretty boolean? (default ()) - 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 ("color"|"created_at"|"followers"|"followers.name"|"name"|"notes"|"permalink_url"|"workspace"|"workspace.name")[]? (default ()) - This endpoint returns a compact 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.
Return Type
- Inline_response_201_6|error - Successfully created the newly specified tag.
get tags/[string tag_gid]
function get tags/[string tag_gid](boolean? opt_pretty, ("color"|"created_at"|"followers"|"followers.name"|"name"|"notes"|"permalink_url"|"workspace"|"workspace.name")[]? opt_fields) returns Inline_response_201_6|error
Get a tag
Parameters
- opt_pretty boolean? (default ()) - 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 ("color"|"created_at"|"followers"|"followers.name"|"name"|"notes"|"permalink_url"|"workspace"|"workspace.name")[]? (default ()) - This endpoint returns a compact 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.
Return Type
- Inline_response_201_6|error - Successfully retrieved the specified tag.
put tags/[string tag_gid]
function put tags/[string tag_gid](boolean? opt_pretty, ("color"|"created_at"|"followers"|"followers.name"|"name"|"notes"|"permalink_url"|"workspace"|"workspace.name")[]? opt_fields) returns Inline_response_201_6|error
Update a tag
Parameters
- opt_pretty boolean? (default ()) - 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 ("color"|"created_at"|"followers"|"followers.name"|"name"|"notes"|"permalink_url"|"workspace"|"workspace.name")[]? (default ()) - This endpoint returns a compact 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.
Return Type
- Inline_response_201_6|error - Successfully updated the specified tag.
delete tags/[string tag_gid]
function delete tags/[string tag_gid](boolean? opt_pretty) returns Inline_response_200_1|error
Delete a tag
Parameters
- opt_pretty boolean? (default ()) - 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.
Return Type
- Inline_response_200_1|error - Successfully deleted the specified tag.
get tasks/[string task_gid]/tags
function get tasks/[string task_gid]/tags(boolean? opt_pretty, int? 'limit, string? offset, ("color"|"created_at"|"followers"|"followers.name"|"name"|"notes"|"offset"|"path"|"permalink_url"|"uri"|"workspace"|"workspace.name")[]? opt_fields) returns Inline_response_200_36|error
Get a task's tags
Parameters
- opt_pretty boolean? (default ()) - 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.
- 'limit int? (default ()) - Results per page. The number of objects to return per page. The value must be between 1 and 100.
- offset string? (default ()) - Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.'
- opt_fields ("color"|"created_at"|"followers"|"followers.name"|"name"|"notes"|"offset"|"path"|"permalink_url"|"uri"|"workspace"|"workspace.name")[]? (default ()) - This endpoint returns a compact 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.
Return Type
- Inline_response_200_36|error - Successfully retrieved the tags for the given task.
get workspaces/[string workspace_gid]/tags
function get workspaces/[string workspace_gid]/tags(boolean? opt_pretty, int? 'limit, string? offset, ("color"|"created_at"|"followers"|"followers.name"|"name"|"notes"|"offset"|"path"|"permalink_url"|"uri"|"workspace"|"workspace.name")[]? opt_fields) returns Inline_response_200_36|error
Get tags in a workspace
Parameters
- opt_pretty boolean? (default ()) - 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.
- 'limit int? (default ()) - Results per page. The number of objects to return per page. The value must be between 1 and 100.
- offset string? (default ()) - Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.'
- opt_fields ("color"|"created_at"|"followers"|"followers.name"|"name"|"notes"|"offset"|"path"|"permalink_url"|"uri"|"workspace"|"workspace.name")[]? (default ()) - This endpoint returns a compact 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.
Return Type
- Inline_response_200_36|error - Successfully retrieved the specified set of tags.
post workspaces/[string workspace_gid]/tags
function post workspaces/[string workspace_gid]/tags(Workspace_gid_tags_body payload, boolean? opt_pretty, ("color"|"created_at"|"followers"|"followers.name"|"name"|"notes"|"permalink_url"|"workspace"|"workspace.name")[]? opt_fields) returns Inline_response_201_6|error
Create a tag in a workspace
Parameters
- payload Workspace_gid_tags_body - The tag to create.
- opt_pretty boolean? (default ()) - 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 ("color"|"created_at"|"followers"|"followers.name"|"name"|"notes"|"permalink_url"|"workspace"|"workspace.name")[]? (default ()) - This endpoint returns a compact 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.
Return Type
- Inline_response_201_6|error - Successfully created the newly specified tag.
get task_templates
function get task_templates(boolean? opt_pretty, int? 'limit, string? offset, string? project, ("created_at"|"created_by"|"name"|"project"|"template")[]? opt_fields) returns Inline_response_200_37|error
Get multiple task templates
Parameters
- opt_pretty boolean? (default ()) - 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.
- 'limit int? (default ()) - Results per page. The number of objects to return per page. The value must be between 1 and 100.
- offset string? (default ()) - Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.'
- project string? (default ()) - The project to filter task templates on.
- opt_fields ("created_at"|"created_by"|"name"|"project"|"template")[]? (default ()) - This endpoint returns a compact 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.
Return Type
- Inline_response_200_37|error - Successfully retrieved requested task templates
get task_templates/[string task_template_gid]
function get task_templates/[string task_template_gid](boolean? opt_pretty, ("created_at"|"created_by"|"name"|"project"|"template")[]? opt_fields) returns Inline_response_200_38|error
Get a task template
Parameters
- opt_pretty boolean? (default ()) - 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 ("created_at"|"created_by"|"name"|"project"|"template")[]? (default ()) - This endpoint returns a compact 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.
Return Type
- Inline_response_200_38|error - Successfully retrieved requested task template
delete task_templates/[string task_template_gid]
function delete task_templates/[string task_template_gid](boolean? opt_pretty) returns Inline_response_200_1|error
Delete a task template
Parameters
- opt_pretty boolean? (default ()) - 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.
Return Type
- Inline_response_200_1|error - Successfully deleted the specified task template.
post task_templates/[string task_template_gid]/instantiateTask
function post task_templates/[string task_template_gid]/instantiateTask(Task_template_gid_instantiateTask_body payload, boolean? opt_pretty, ("new_project"|"new_project.name"|"new_project_template"|"new_project_template.name"|"new_task"|"new_task.created_by"|"new_task.name"|"new_task.resource_subtype"|"new_task_template"|"new_task_template.name"|"resource_subtype"|"status")[]? opt_fields) returns Inline_response_200_13|error
Instantiate a task from a task template
Parameters
- payload Task_template_gid_instantiateTask_body - Describes the inputs used for instantiating a task - the task's name.
- opt_pretty boolean? (default ()) - 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 ("new_project"|"new_project.name"|"new_project_template"|"new_project_template.name"|"new_task"|"new_task.created_by"|"new_task.name"|"new_task.resource_subtype"|"new_task_template"|"new_task_template.name"|"resource_subtype"|"status")[]? (default ()) - This endpoint returns a compact 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.
Return Type
- Inline_response_200_13|error - Successfully created the job to handle task instantiation.
get tasks
function get tasks(boolean? opt_pretty, int? 'limit, string? offset, string? assignee, string? project, string? section, string? workspace, string? completed_since, string? modified_since, ("actual_time_minutes"|"approval_status"|"assignee"|"assignee.name"|"assignee_section"|"assignee_section.name"|"assignee_status"|"completed"|"completed_at"|"completed_by"|"completed_by.name"|"created_at"|"created_by"|"custom_fields"|"custom_fields.asana_created_field"|"custom_fields.created_by"|"custom_fields.created_by.name"|"custom_fields.currency_code"|"custom_fields.custom_label"|"custom_fields.custom_label_position"|"custom_fields.date_value"|"custom_fields.date_value.date"|"custom_fields.date_value.date_time"|"custom_fields.description"|"custom_fields.display_value"|"custom_fields.enabled"|"custom_fields.enum_options"|"custom_fields.enum_options.color"|"custom_fields.enum_options.enabled"|"custom_fields.enum_options.name"|"custom_fields.enum_value"|"custom_fields.enum_value.color"|"custom_fields.enum_value.enabled"|"custom_fields.enum_value.name"|"custom_fields.format"|"custom_fields.has_notifications_enabled"|"custom_fields.id_prefix"|"custom_fields.is_formula_field"|"custom_fields.is_global_to_workspace"|"custom_fields.is_value_read_only"|"custom_fields.multi_enum_values"|"custom_fields.multi_enum_values.color"|"custom_fields.multi_enum_values.enabled"|"custom_fields.multi_enum_values.name"|"custom_fields.name"|"custom_fields.number_value"|"custom_fields.people_value"|"custom_fields.people_value.name"|"custom_fields.precision"|"custom_fields.representation_type"|"custom_fields.resource_subtype"|"custom_fields.text_value"|"custom_fields.type"|"dependencies"|"dependents"|"due_at"|"due_on"|"external"|"external.data"|"followers"|"followers.name"|"hearted"|"hearts"|"hearts.user"|"hearts.user.name"|"html_notes"|"is_rendered_as_separator"|"liked"|"likes"|"likes.user"|"likes.user.name"|"memberships"|"memberships.project"|"memberships.project.name"|"memberships.section"|"memberships.section.name"|"modified_at"|"name"|"notes"|"num_hearts"|"num_likes"|"num_subtasks"|"offset"|"parent"|"parent.created_by"|"parent.name"|"parent.resource_subtype"|"path"|"permalink_url"|"projects"|"projects.name"|"resource_subtype"|"start_at"|"start_on"|"tags"|"tags.name"|"uri"|"workspace"|"workspace.name")[]? opt_fields) returns Inline_response_200_39|error
Get multiple tasks
Parameters
- opt_pretty boolean? (default ()) - 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.
- 'limit int? (default ()) - Results per page. The number of objects to return per page. The value must be between 1 and 100.
- offset string? (default ()) - Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.'
- assignee string? (default ()) - The assignee to filter tasks on. If searching for unassigned tasks, assignee.any = null can be specified.
Note: If you specify
assignee
, you must also specify theworkspace
to filter on.
- project string? (default ()) - The project to filter tasks on.
- section string? (default ()) - The section to filter tasks on.
- workspace string? (default ()) - The workspace to filter tasks on.
Note: If you specify
workspace
, you must also specify theassignee
to filter on.
- completed_since string? (default ()) - Only return tasks that are either incomplete or that have been completed since this time.
- modified_since string? (default ()) - Only return tasks that have been modified since the given time. Note: A task is considered “modified” if any of its properties change, or associations between it and other objects are modified (e.g. a task being added to a project). A task is not considered modified just because another object it is associated with (e.g. a subtask) is modified. Actions that count as modifying the task include assigning, renaming, completing, and adding stories.
- opt_fields ("actual_time_minutes"|"approval_status"|"assignee"|"assignee.name"|"assignee_section"|"assignee_section.name"|"assignee_status"|"completed"|"completed_at"|"completed_by"|"completed_by.name"|"created_at"|"created_by"|"custom_fields"|"custom_fields.asana_created_field"|"custom_fields.created_by"|"custom_fields.created_by.name"|"custom_fields.currency_code"|"custom_fields.custom_label"|"custom_fields.custom_label_position"|"custom_fields.date_value"|"custom_fields.date_value.date"|"custom_fields.date_value.date_time"|"custom_fields.description"|"custom_fields.display_value"|"custom_fields.enabled"|"custom_fields.enum_options"|"custom_fields.enum_options.color"|"custom_fields.enum_options.enabled"|"custom_fields.enum_options.name"|"custom_fields.enum_value"|"custom_fields.enum_value.color"|"custom_fields.enum_value.enabled"|"custom_fields.enum_value.name"|"custom_fields.format"|"custom_fields.has_notifications_enabled"|"custom_fields.id_prefix"|"custom_fields.is_formula_field"|"custom_fields.is_global_to_workspace"|"custom_fields.is_value_read_only"|"custom_fields.multi_enum_values"|"custom_fields.multi_enum_values.color"|"custom_fields.multi_enum_values.enabled"|"custom_fields.multi_enum_values.name"|"custom_fields.name"|"custom_fields.number_value"|"custom_fields.people_value"|"custom_fields.people_value.name"|"custom_fields.precision"|"custom_fields.representation_type"|"custom_fields.resource_subtype"|"custom_fields.text_value"|"custom_fields.type"|"dependencies"|"dependents"|"due_at"|"due_on"|"external"|"external.data"|"followers"|"followers.name"|"hearted"|"hearts"|"hearts.user"|"hearts.user.name"|"html_notes"|"is_rendered_as_separator"|"liked"|"likes"|"likes.user"|"likes.user.name"|"memberships"|"memberships.project"|"memberships.project.name"|"memberships.section"|"memberships.section.name"|"modified_at"|"name"|"notes"|"num_hearts"|"num_likes"|"num_subtasks"|"offset"|"parent"|"parent.created_by"|"parent.name"|"parent.resource_subtype"|"path"|"permalink_url"|"projects"|"projects.name"|"resource_subtype"|"start_at"|"start_on"|"tags"|"tags.name"|"uri"|"workspace"|"workspace.name")[]? (default ()) - This endpoint returns a compact 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.
Return Type
- Inline_response_200_39|error - Successfully retrieved requested tasks.
post tasks
function post tasks(Tasks_body payload, boolean? opt_pretty, ("actual_time_minutes"|"approval_status"|"assignee"|"assignee.name"|"assignee_section"|"assignee_section.name"|"assignee_status"|"completed"|"completed_at"|"completed_by"|"completed_by.name"|"created_at"|"created_by"|"custom_fields"|"custom_fields.asana_created_field"|"custom_fields.created_by"|"custom_fields.created_by.name"|"custom_fields.currency_code"|"custom_fields.custom_label"|"custom_fields.custom_label_position"|"custom_fields.date_value"|"custom_fields.date_value.date"|"custom_fields.date_value.date_time"|"custom_fields.description"|"custom_fields.display_value"|"custom_fields.enabled"|"custom_fields.enum_options"|"custom_fields.enum_options.color"|"custom_fields.enum_options.enabled"|"custom_fields.enum_options.name"|"custom_fields.enum_value"|"custom_fields.enum_value.color"|"custom_fields.enum_value.enabled"|"custom_fields.enum_value.name"|"custom_fields.format"|"custom_fields.has_notifications_enabled"|"custom_fields.id_prefix"|"custom_fields.is_formula_field"|"custom_fields.is_global_to_workspace"|"custom_fields.is_value_read_only"|"custom_fields.multi_enum_values"|"custom_fields.multi_enum_values.color"|"custom_fields.multi_enum_values.enabled"|"custom_fields.multi_enum_values.name"|"custom_fields.name"|"custom_fields.number_value"|"custom_fields.people_value"|"custom_fields.people_value.name"|"custom_fields.precision"|"custom_fields.representation_type"|"custom_fields.resource_subtype"|"custom_fields.text_value"|"custom_fields.type"|"dependencies"|"dependents"|"due_at"|"due_on"|"external"|"external.data"|"followers"|"followers.name"|"hearted"|"hearts"|"hearts.user"|"hearts.user.name"|"html_notes"|"is_rendered_as_separator"|"liked"|"likes"|"likes.user"|"likes.user.name"|"memberships"|"memberships.project"|"memberships.project.name"|"memberships.section"|"memberships.section.name"|"modified_at"|"name"|"notes"|"num_hearts"|"num_likes"|"num_subtasks"|"parent"|"parent.created_by"|"parent.name"|"parent.resource_subtype"|"permalink_url"|"projects"|"projects.name"|"resource_subtype"|"start_at"|"start_on"|"tags"|"tags.name"|"workspace"|"workspace.name")[]? opt_fields) returns Inline_response_201_7|error
Create a task
Parameters
- payload Tasks_body - The task to create.
- opt_pretty boolean? (default ()) - 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 ("actual_time_minutes"|"approval_status"|"assignee"|"assignee.name"|"assignee_section"|"assignee_section.name"|"assignee_status"|"completed"|"completed_at"|"completed_by"|"completed_by.name"|"created_at"|"created_by"|"custom_fields"|"custom_fields.asana_created_field"|"custom_fields.created_by"|"custom_fields.created_by.name"|"custom_fields.currency_code"|"custom_fields.custom_label"|"custom_fields.custom_label_position"|"custom_fields.date_value"|"custom_fields.date_value.date"|"custom_fields.date_value.date_time"|"custom_fields.description"|"custom_fields.display_value"|"custom_fields.enabled"|"custom_fields.enum_options"|"custom_fields.enum_options.color"|"custom_fields.enum_options.enabled"|"custom_fields.enum_options.name"|"custom_fields.enum_value"|"custom_fields.enum_value.color"|"custom_fields.enum_value.enabled"|"custom_fields.enum_value.name"|"custom_fields.format"|"custom_fields.has_notifications_enabled"|"custom_fields.id_prefix"|"custom_fields.is_formula_field"|"custom_fields.is_global_to_workspace"|"custom_fields.is_value_read_only"|"custom_fields.multi_enum_values"|"custom_fields.multi_enum_values.color"|"custom_fields.multi_enum_values.enabled"|"custom_fields.multi_enum_values.name"|"custom_fields.name"|"custom_fields.number_value"|"custom_fields.people_value"|"custom_fields.people_value.name"|"custom_fields.precision"|"custom_fields.representation_type"|"custom_fields.resource_subtype"|"custom_fields.text_value"|"custom_fields.type"|"dependencies"|"dependents"|"due_at"|"due_on"|"external"|"external.data"|"followers"|"followers.name"|"hearted"|"hearts"|"hearts.user"|"hearts.user.name"|"html_notes"|"is_rendered_as_separator"|"liked"|"likes"|"likes.user"|"likes.user.name"|"memberships"|"memberships.project"|"memberships.project.name"|"memberships.section"|"memberships.section.name"|"modified_at"|"name"|"notes"|"num_hearts"|"num_likes"|"num_subtasks"|"parent"|"parent.created_by"|"parent.name"|"parent.resource_subtype"|"permalink_url"|"projects"|"projects.name"|"resource_subtype"|"start_at"|"start_on"|"tags"|"tags.name"|"workspace"|"workspace.name")[]? (default ()) - This endpoint returns a compact 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.
Return Type
- Inline_response_201_7|error - Successfully created a new task.
get tasks/[string task_gid]
function get tasks/[string task_gid](boolean? opt_pretty, ("actual_time_minutes"|"approval_status"|"assignee"|"assignee.name"|"assignee_section"|"assignee_section.name"|"assignee_status"|"completed"|"completed_at"|"completed_by"|"completed_by.name"|"created_at"|"created_by"|"custom_fields"|"custom_fields.asana_created_field"|"custom_fields.created_by"|"custom_fields.created_by.name"|"custom_fields.currency_code"|"custom_fields.custom_label"|"custom_fields.custom_label_position"|"custom_fields.date_value"|"custom_fields.date_value.date"|"custom_fields.date_value.date_time"|"custom_fields.description"|"custom_fields.display_value"|"custom_fields.enabled"|"custom_fields.enum_options"|"custom_fields.enum_options.color"|"custom_fields.enum_options.enabled"|"custom_fields.enum_options.name"|"custom_fields.enum_value"|"custom_fields.enum_value.color"|"custom_fields.enum_value.enabled"|"custom_fields.enum_value.name"|"custom_fields.format"|"custom_fields.has_notifications_enabled"|"custom_fields.id_prefix"|"custom_fields.is_formula_field"|"custom_fields.is_global_to_workspace"|"custom_fields.is_value_read_only"|"custom_fields.multi_enum_values"|"custom_fields.multi_enum_values.color"|"custom_fields.multi_enum_values.enabled"|"custom_fields.multi_enum_values.name"|"custom_fields.name"|"custom_fields.number_value"|"custom_fields.people_value"|"custom_fields.people_value.name"|"custom_fields.precision"|"custom_fields.representation_type"|"custom_fields.resource_subtype"|"custom_fields.text_value"|"custom_fields.type"|"dependencies"|"dependents"|"due_at"|"due_on"|"external"|"external.data"|"followers"|"followers.name"|"hearted"|"hearts"|"hearts.user"|"hearts.user.name"|"html_notes"|"is_rendered_as_separator"|"liked"|"likes"|"likes.user"|"likes.user.name"|"memberships"|"memberships.project"|"memberships.project.name"|"memberships.section"|"memberships.section.name"|"modified_at"|"name"|"notes"|"num_hearts"|"num_likes"|"num_subtasks"|"parent"|"parent.created_by"|"parent.name"|"parent.resource_subtype"|"permalink_url"|"projects"|"projects.name"|"resource_subtype"|"start_at"|"start_on"|"tags"|"tags.name"|"workspace"|"workspace.name")[]? opt_fields) returns Inline_response_201_7|error
Get a task
Parameters
- opt_pretty boolean? (default ()) - 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 ("actual_time_minutes"|"approval_status"|"assignee"|"assignee.name"|"assignee_section"|"assignee_section.name"|"assignee_status"|"completed"|"completed_at"|"completed_by"|"completed_by.name"|"created_at"|"created_by"|"custom_fields"|"custom_fields.asana_created_field"|"custom_fields.created_by"|"custom_fields.created_by.name"|"custom_fields.currency_code"|"custom_fields.custom_label"|"custom_fields.custom_label_position"|"custom_fields.date_value"|"custom_fields.date_value.date"|"custom_fields.date_value.date_time"|"custom_fields.description"|"custom_fields.display_value"|"custom_fields.enabled"|"custom_fields.enum_options"|"custom_fields.enum_options.color"|"custom_fields.enum_options.enabled"|"custom_fields.enum_options.name"|"custom_fields.enum_value"|"custom_fields.enum_value.color"|"custom_fields.enum_value.enabled"|"custom_fields.enum_value.name"|"custom_fields.format"|"custom_fields.has_notifications_enabled"|"custom_fields.id_prefix"|"custom_fields.is_formula_field"|"custom_fields.is_global_to_workspace"|"custom_fields.is_value_read_only"|"custom_fields.multi_enum_values"|"custom_fields.multi_enum_values.color"|"custom_fields.multi_enum_values.enabled"|"custom_fields.multi_enum_values.name"|"custom_fields.name"|"custom_fields.number_value"|"custom_fields.people_value"|"custom_fields.people_value.name"|"custom_fields.precision"|"custom_fields.representation_type"|"custom_fields.resource_subtype"|"custom_fields.text_value"|"custom_fields.type"|"dependencies"|"dependents"|"due_at"|"due_on"|"external"|"external.data"|"followers"|"followers.name"|"hearted"|"hearts"|"hearts.user"|"hearts.user.name"|"html_notes"|"is_rendered_as_separator"|"liked"|"likes"|"likes.user"|"likes.user.name"|"memberships"|"memberships.project"|"memberships.project.name"|"memberships.section"|"memberships.section.name"|"modified_at"|"name"|"notes"|"num_hearts"|"num_likes"|"num_subtasks"|"parent"|"parent.created_by"|"parent.name"|"parent.resource_subtype"|"permalink_url"|"projects"|"projects.name"|"resource_subtype"|"start_at"|"start_on"|"tags"|"tags.name"|"workspace"|"workspace.name")[]? (default ()) - This endpoint returns a compact 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.
Return Type
- Inline_response_201_7|error - Successfully retrieved the specified task.
put tasks/[string task_gid]
function put tasks/[string task_gid](Tasks_task_gid_body payload, boolean? opt_pretty, ("actual_time_minutes"|"approval_status"|"assignee"|"assignee.name"|"assignee_section"|"assignee_section.name"|"assignee_status"|"completed"|"completed_at"|"completed_by"|"completed_by.name"|"created_at"|"created_by"|"custom_fields"|"custom_fields.asana_created_field"|"custom_fields.created_by"|"custom_fields.created_by.name"|"custom_fields.currency_code"|"custom_fields.custom_label"|"custom_fields.custom_label_position"|"custom_fields.date_value"|"custom_fields.date_value.date"|"custom_fields.date_value.date_time"|"custom_fields.description"|"custom_fields.display_value"|"custom_fields.enabled"|"custom_fields.enum_options"|"custom_fields.enum_options.color"|"custom_fields.enum_options.enabled"|"custom_fields.enum_options.name"|"custom_fields.enum_value"|"custom_fields.enum_value.color"|"custom_fields.enum_value.enabled"|"custom_fields.enum_value.name"|"custom_fields.format"|"custom_fields.has_notifications_enabled"|"custom_fields.id_prefix"|"custom_fields.is_formula_field"|"custom_fields.is_global_to_workspace"|"custom_fields.is_value_read_only"|"custom_fields.multi_enum_values"|"custom_fields.multi_enum_values.color"|"custom_fields.multi_enum_values.enabled"|"custom_fields.multi_enum_values.name"|"custom_fields.name"|"custom_fields.number_value"|"custom_fields.people_value"|"custom_fields.people_value.name"|"custom_fields.precision"|"custom_fields.representation_type"|"custom_fields.resource_subtype"|"custom_fields.text_value"|"custom_fields.type"|"dependencies"|"dependents"|"due_at"|"due_on"|"external"|"external.data"|"followers"|"followers.name"|"hearted"|"hearts"|"hearts.user"|"hearts.user.name"|"html_notes"|"is_rendered_as_separator"|"liked"|"likes"|"likes.user"|"likes.user.name"|"memberships"|"memberships.project"|"memberships.project.name"|"memberships.section"|"memberships.section.name"|"modified_at"|"name"|"notes"|"num_hearts"|"num_likes"|"num_subtasks"|"parent"|"parent.created_by"|"parent.name"|"parent.resource_subtype"|"permalink_url"|"projects"|"projects.name"|"resource_subtype"|"start_at"|"start_on"|"tags"|"tags.name"|"workspace"|"workspace.name")[]? opt_fields) returns Inline_response_201_7|error
Update a task
Parameters
- payload Tasks_task_gid_body - The task to update.
- opt_pretty boolean? (default ()) - 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 ("actual_time_minutes"|"approval_status"|"assignee"|"assignee.name"|"assignee_section"|"assignee_section.name"|"assignee_status"|"completed"|"completed_at"|"completed_by"|"completed_by.name"|"created_at"|"created_by"|"custom_fields"|"custom_fields.asana_created_field"|"custom_fields.created_by"|"custom_fields.created_by.name"|"custom_fields.currency_code"|"custom_fields.custom_label"|"custom_fields.custom_label_position"|"custom_fields.date_value"|"custom_fields.date_value.date"|"custom_fields.date_value.date_time"|"custom_fields.description"|"custom_fields.display_value"|"custom_fields.enabled"|"custom_fields.enum_options"|"custom_fields.enum_options.color"|"custom_fields.enum_options.enabled"|"custom_fields.enum_options.name"|"custom_fields.enum_value"|"custom_fields.enum_value.color"|"custom_fields.enum_value.enabled"|"custom_fields.enum_value.name"|"custom_fields.format"|"custom_fields.has_notifications_enabled"|"custom_fields.id_prefix"|"custom_fields.is_formula_field"|"custom_fields.is_global_to_workspace"|"custom_fields.is_value_read_only"|"custom_fields.multi_enum_values"|"custom_fields.multi_enum_values.color"|"custom_fields.multi_enum_values.enabled"|"custom_fields.multi_enum_values.name"|"custom_fields.name"|"custom_fields.number_value"|"custom_fields.people_value"|"custom_fields.people_value.name"|"custom_fields.precision"|"custom_fields.representation_type"|"custom_fields.resource_subtype"|"custom_fields.text_value"|"custom_fields.type"|"dependencies"|"dependents"|"due_at"|"due_on"|"external"|"external.data"|"followers"|"followers.name"|"hearted"|"hearts"|"hearts.user"|"hearts.user.name"|"html_notes"|"is_rendered_as_separator"|"liked"|"likes"|"likes.user"|"likes.user.name"|"memberships"|"memberships.project"|"memberships.project.name"|"memberships.section"|"memberships.section.name"|"modified_at"|"name"|"notes"|"num_hearts"|"num_likes"|"num_subtasks"|"parent"|"parent.created_by"|"parent.name"|"parent.resource_subtype"|"permalink_url"|"projects"|"projects.name"|"resource_subtype"|"start_at"|"start_on"|"tags"|"tags.name"|"workspace"|"workspace.name")[]? (default ()) - This endpoint returns a compact 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.
Return Type
- Inline_response_201_7|error - Successfully updated the specified task.
delete tasks/[string task_gid]
function delete tasks/[string task_gid](boolean? opt_pretty) returns Inline_response_200_1|error
Delete a task
Parameters
- opt_pretty boolean? (default ()) - 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.
Return Type
- Inline_response_200_1|error - Successfully deleted the specified task.
post tasks/[string task_gid]/duplicate
function post tasks/[string task_gid]/duplicate(Task_gid_duplicate_body payload, boolean? opt_pretty, ("new_project"|"new_project.name"|"new_project_template"|"new_project_template.name"|"new_task"|"new_task.created_by"|"new_task.name"|"new_task.resource_subtype"|"new_task_template"|"new_task_template.name"|"resource_subtype"|"status")[]? opt_fields) returns Inline_response_200_13|error
Duplicate a task
Parameters
- payload Task_gid_duplicate_body - Describes the duplicate's name and the fields that will be duplicated.
- opt_pretty boolean? (default ()) - 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 ("new_project"|"new_project.name"|"new_project_template"|"new_project_template.name"|"new_task"|"new_task.created_by"|"new_task.name"|"new_task.resource_subtype"|"new_task_template"|"new_task_template.name"|"resource_subtype"|"status")[]? (default ()) - This endpoint returns a compact 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.
Return Type
- Inline_response_200_13|error - Successfully created the job to handle duplication.
get projects/[string project_gid]/tasks
function get projects/[string project_gid]/tasks(string? completed_since, boolean? opt_pretty, int? 'limit, string? offset, ("actual_time_minutes"|"approval_status"|"assignee"|"assignee.name"|"assignee_section"|"assignee_section.name"|"assignee_status"|"completed"|"completed_at"|"completed_by"|"completed_by.name"|"created_at"|"created_by"|"custom_fields"|"custom_fields.asana_created_field"|"custom_fields.created_by"|"custom_fields.created_by.name"|"custom_fields.currency_code"|"custom_fields.custom_label"|"custom_fields.custom_label_position"|"custom_fields.date_value"|"custom_fields.date_value.date"|"custom_fields.date_value.date_time"|"custom_fields.description"|"custom_fields.display_value"|"custom_fields.enabled"|"custom_fields.enum_options"|"custom_fields.enum_options.color"|"custom_fields.enum_options.enabled"|"custom_fields.enum_options.name"|"custom_fields.enum_value"|"custom_fields.enum_value.color"|"custom_fields.enum_value.enabled"|"custom_fields.enum_value.name"|"custom_fields.format"|"custom_fields.has_notifications_enabled"|"custom_fields.id_prefix"|"custom_fields.is_formula_field"|"custom_fields.is_global_to_workspace"|"custom_fields.is_value_read_only"|"custom_fields.multi_enum_values"|"custom_fields.multi_enum_values.color"|"custom_fields.multi_enum_values.enabled"|"custom_fields.multi_enum_values.name"|"custom_fields.name"|"custom_fields.number_value"|"custom_fields.people_value"|"custom_fields.people_value.name"|"custom_fields.precision"|"custom_fields.representation_type"|"custom_fields.resource_subtype"|"custom_fields.text_value"|"custom_fields.type"|"dependencies"|"dependents"|"due_at"|"due_on"|"external"|"external.data"|"followers"|"followers.name"|"hearted"|"hearts"|"hearts.user"|"hearts.user.name"|"html_notes"|"is_rendered_as_separator"|"liked"|"likes"|"likes.user"|"likes.user.name"|"memberships"|"memberships.project"|"memberships.project.name"|"memberships.section"|"memberships.section.name"|"modified_at"|"name"|"notes"|"num_hearts"|"num_likes"|"num_subtasks"|"offset"|"parent"|"parent.created_by"|"parent.name"|"parent.resource_subtype"|"path"|"permalink_url"|"projects"|"projects.name"|"resource_subtype"|"start_at"|"start_on"|"tags"|"tags.name"|"uri"|"workspace"|"workspace.name")[]? opt_fields) returns Inline_response_200_39|error
Get tasks from a project
Parameters
- completed_since string? (default ()) - Only return tasks that are either incomplete or that have been completed since this time. Accepts a date-time string or the keyword now.
- opt_pretty boolean? (default ()) - 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.
- 'limit int? (default ()) - Results per page. The number of objects to return per page. The value must be between 1 and 100.
- offset string? (default ()) - Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.'
- opt_fields ("actual_time_minutes"|"approval_status"|"assignee"|"assignee.name"|"assignee_section"|"assignee_section.name"|"assignee_status"|"completed"|"completed_at"|"completed_by"|"completed_by.name"|"created_at"|"created_by"|"custom_fields"|"custom_fields.asana_created_field"|"custom_fields.created_by"|"custom_fields.created_by.name"|"custom_fields.currency_code"|"custom_fields.custom_label"|"custom_fields.custom_label_position"|"custom_fields.date_value"|"custom_fields.date_value.date"|"custom_fields.date_value.date_time"|"custom_fields.description"|"custom_fields.display_value"|"custom_fields.enabled"|"custom_fields.enum_options"|"custom_fields.enum_options.color"|"custom_fields.enum_options.enabled"|"custom_fields.enum_options.name"|"custom_fields.enum_value"|"custom_fields.enum_value.color"|"custom_fields.enum_value.enabled"|"custom_fields.enum_value.name"|"custom_fields.format"|"custom_fields.has_notifications_enabled"|"custom_fields.id_prefix"|"custom_fields.is_formula_field"|"custom_fields.is_global_to_workspace"|"custom_fields.is_value_read_only"|"custom_fields.multi_enum_values"|"custom_fields.multi_enum_values.color"|"custom_fields.multi_enum_values.enabled"|"custom_fields.multi_enum_values.name"|"custom_fields.name"|"custom_fields.number_value"|"custom_fields.people_value"|"custom_fields.people_value.name"|"custom_fields.precision"|"custom_fields.representation_type"|"custom_fields.resource_subtype"|"custom_fields.text_value"|"custom_fields.type"|"dependencies"|"dependents"|"due_at"|"due_on"|"external"|"external.data"|"followers"|"followers.name"|"hearted"|"hearts"|"hearts.user"|"hearts.user.name"|"html_notes"|"is_rendered_as_separator"|"liked"|"likes"|"likes.user"|"likes.user.name"|"memberships"|"memberships.project"|"memberships.project.name"|"memberships.section"|"memberships.section.name"|"modified_at"|"name"|"notes"|"num_hearts"|"num_likes"|"num_subtasks"|"offset"|"parent"|"parent.created_by"|"parent.name"|"parent.resource_subtype"|"path"|"permalink_url"|"projects"|"projects.name"|"resource_subtype"|"start_at"|"start_on"|"tags"|"tags.name"|"uri"|"workspace"|"workspace.name")[]? (default ()) - This endpoint returns a compact 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.
Return Type
- Inline_response_200_39|error - Successfully retrieved the requested project's tasks.
get sections/[string section_gid]/tasks
function get sections/[string section_gid]/tasks(boolean? opt_pretty, int? 'limit, string? offset, string? completed_since, ("actual_time_minutes"|"approval_status"|"assignee"|"assignee.name"|"assignee_section"|"assignee_section.name"|"assignee_status"|"completed"|"completed_at"|"completed_by"|"completed_by.name"|"created_at"|"created_by"|"custom_fields"|"custom_fields.asana_created_field"|"custom_fields.created_by"|"custom_fields.created_by.name"|"custom_fields.currency_code"|"custom_fields.custom_label"|"custom_fields.custom_label_position"|"custom_fields.date_value"|"custom_fields.date_value.date"|"custom_fields.date_value.date_time"|"custom_fields.description"|"custom_fields.display_value"|"custom_fields.enabled"|"custom_fields.enum_options"|"custom_fields.enum_options.color"|"custom_fields.enum_options.enabled"|"custom_fields.enum_options.name"|"custom_fields.enum_value"|"custom_fields.enum_value.color"|"custom_fields.enum_value.enabled"|"custom_fields.enum_value.name"|"custom_fields.format"|"custom_fields.has_notifications_enabled"|"custom_fields.id_prefix"|"custom_fields.is_formula_field"|"custom_fields.is_global_to_workspace"|"custom_fields.is_value_read_only"|"custom_fields.multi_enum_values"|"custom_fields.multi_enum_values.color"|"custom_fields.multi_enum_values.enabled"|"custom_fields.multi_enum_values.name"|"custom_fields.name"|"custom_fields.number_value"|"custom_fields.people_value"|"custom_fields.people_value.name"|"custom_fields.precision"|"custom_fields.representation_type"|"custom_fields.resource_subtype"|"custom_fields.text_value"|"custom_fields.type"|"dependencies"|"dependents"|"due_at"|"due_on"|"external"|"external.data"|"followers"|"followers.name"|"hearted"|"hearts"|"hearts.user"|"hearts.user.name"|"html_notes"|"is_rendered_as_separator"|"liked"|"likes"|"likes.user"|"likes.user.name"|"memberships"|"memberships.project"|"memberships.project.name"|"memberships.section"|"memberships.section.name"|"modified_at"|"name"|"notes"|"num_hearts"|"num_likes"|"num_subtasks"|"offset"|"parent"|"parent.created_by"|"parent.name"|"parent.resource_subtype"|"path"|"permalink_url"|"projects"|"projects.name"|"resource_subtype"|"start_at"|"start_on"|"tags"|"tags.name"|"uri"|"workspace"|"workspace.name")[]? opt_fields) returns Inline_response_200_39|error
Get tasks from a section
Parameters
- opt_pretty boolean? (default ()) - 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.
- 'limit int? (default ()) - Results per page. The number of objects to return per page. The value must be between 1 and 100.
- offset string? (default ()) - Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.'
- completed_since string? (default ()) - Only return tasks that are either incomplete or that have been completed since this time. Accepts a date-time string or the keyword now.
- opt_fields ("actual_time_minutes"|"approval_status"|"assignee"|"assignee.name"|"assignee_section"|"assignee_section.name"|"assignee_status"|"completed"|"completed_at"|"completed_by"|"completed_by.name"|"created_at"|"created_by"|"custom_fields"|"custom_fields.asana_created_field"|"custom_fields.created_by"|"custom_fields.created_by.name"|"custom_fields.currency_code"|"custom_fields.custom_label"|"custom_fields.custom_label_position"|"custom_fields.date_value"|"custom_fields.date_value.date"|"custom_fields.date_value.date_time"|"custom_fields.description"|"custom_fields.display_value"|"custom_fields.enabled"|"custom_fields.enum_options"|"custom_fields.enum_options.color"|"custom_fields.enum_options.enabled"|"custom_fields.enum_options.name"|"custom_fields.enum_value"|"custom_fields.enum_value.color"|"custom_fields.enum_value.enabled"|"custom_fields.enum_value.name"|"custom_fields.format"|"custom_fields.has_notifications_enabled"|"custom_fields.id_prefix"|"custom_fields.is_formula_field"|"custom_fields.is_global_to_workspace"|"custom_fields.is_value_read_only"|"custom_fields.multi_enum_values"|"custom_fields.multi_enum_values.color"|"custom_fields.multi_enum_values.enabled"|"custom_fields.multi_enum_values.name"|"custom_fields.name"|"custom_fields.number_value"|"custom_fields.people_value"|"custom_fields.people_value.name"|"custom_fields.precision"|"custom_fields.representation_type"|"custom_fields.resource_subtype"|"custom_fields.text_value"|"custom_fields.type"|"dependencies"|"dependents"|"due_at"|"due_on"|"external"|"external.data"|"followers"|"followers.name"|"hearted"|"hearts"|"hearts.user"|"hearts.user.name"|"html_notes"|"is_rendered_as_separator"|"liked"|"likes"|"likes.user"|"likes.user.name"|"memberships"|"memberships.project"|"memberships.project.name"|"memberships.section"|"memberships.section.name"|"modified_at"|"name"|"notes"|"num_hearts"|"num_likes"|"num_subtasks"|"offset"|"parent"|"parent.created_by"|"parent.name"|"parent.resource_subtype"|"path"|"permalink_url"|"projects"|"projects.name"|"resource_subtype"|"start_at"|"start_on"|"tags"|"tags.name"|"uri"|"workspace"|"workspace.name")[]? (default ()) - This endpoint returns a compact 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.
Return Type
- Inline_response_200_39|error - Successfully retrieved the section's tasks.
get tags/[string tag_gid]/tasks
function get tags/[string tag_gid]/tasks(boolean? opt_pretty, int? 'limit, string? offset, ("actual_time_minutes"|"approval_status"|"assignee"|"assignee.name"|"assignee_section"|"assignee_section.name"|"assignee_status"|"completed"|"completed_at"|"completed_by"|"completed_by.name"|"created_at"|"created_by"|"custom_fields"|"custom_fields.asana_created_field"|"custom_fields.created_by"|"custom_fields.created_by.name"|"custom_fields.currency_code"|"custom_fields.custom_label"|"custom_fields.custom_label_position"|"custom_fields.date_value"|"custom_fields.date_value.date"|"custom_fields.date_value.date_time"|"custom_fields.description"|"custom_fields.display_value"|"custom_fields.enabled"|"custom_fields.enum_options"|"custom_fields.enum_options.color"|"custom_fields.enum_options.enabled"|"custom_fields.enum_options.name"|"custom_fields.enum_value"|"custom_fields.enum_value.color"|"custom_fields.enum_value.enabled"|"custom_fields.enum_value.name"|"custom_fields.format"|"custom_fields.has_notifications_enabled"|"custom_fields.id_prefix"|"custom_fields.is_formula_field"|"custom_fields.is_global_to_workspace"|"custom_fields.is_value_read_only"|"custom_fields.multi_enum_values"|"custom_fields.multi_enum_values.color"|"custom_fields.multi_enum_values.enabled"|"custom_fields.multi_enum_values.name"|"custom_fields.name"|"custom_fields.number_value"|"custom_fields.people_value"|"custom_fields.people_value.name"|"custom_fields.precision"|"custom_fields.representation_type"|"custom_fields.resource_subtype"|"custom_fields.text_value"|"custom_fields.type"|"dependencies"|"dependents"|"due_at"|"due_on"|"external"|"external.data"|"followers"|"followers.name"|"hearted"|"hearts"|"hearts.user"|"hearts.user.name"|"html_notes"|"is_rendered_as_separator"|"liked"|"likes"|"likes.user"|"likes.user.name"|"memberships"|"memberships.project"|"memberships.project.name"|"memberships.section"|"memberships.section.name"|"modified_at"|"name"|"notes"|"num_hearts"|"num_likes"|"num_subtasks"|"offset"|"parent"|"parent.created_by"|"parent.name"|"parent.resource_subtype"|"path"|"permalink_url"|"projects"|"projects.name"|"resource_subtype"|"start_at"|"start_on"|"tags"|"tags.name"|"uri"|"workspace"|"workspace.name")[]? opt_fields) returns Inline_response_200_39|error
Get tasks from a tag
Parameters
- opt_pretty boolean? (default ()) - 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.
- 'limit int? (default ()) - Results per page. The number of objects to return per page. The value must be between 1 and 100.
- offset string? (default ()) - Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.'
- opt_fields ("actual_time_minutes"|"approval_status"|"assignee"|"assignee.name"|"assignee_section"|"assignee_section.name"|"assignee_status"|"completed"|"completed_at"|"completed_by"|"completed_by.name"|"created_at"|"created_by"|"custom_fields"|"custom_fields.asana_created_field"|"custom_fields.created_by"|"custom_fields.created_by.name"|"custom_fields.currency_code"|"custom_fields.custom_label"|"custom_fields.custom_label_position"|"custom_fields.date_value"|"custom_fields.date_value.date"|"custom_fields.date_value.date_time"|"custom_fields.description"|"custom_fields.display_value"|"custom_fields.enabled"|"custom_fields.enum_options"|"custom_fields.enum_options.color"|"custom_fields.enum_options.enabled"|"custom_fields.enum_options.name"|"custom_fields.enum_value"|"custom_fields.enum_value.color"|"custom_fields.enum_value.enabled"|"custom_fields.enum_value.name"|"custom_fields.format"|"custom_fields.has_notifications_enabled"|"custom_fields.id_prefix"|"custom_fields.is_formula_field"|"custom_fields.is_global_to_workspace"|"custom_fields.is_value_read_only"|"custom_fields.multi_enum_values"|"custom_fields.multi_enum_values.color"|"custom_fields.multi_enum_values.enabled"|"custom_fields.multi_enum_values.name"|"custom_fields.name"|"custom_fields.number_value"|"custom_fields.people_value"|"custom_fields.people_value.name"|"custom_fields.precision"|"custom_fields.representation_type"|"custom_fields.resource_subtype"|"custom_fields.text_value"|"custom_fields.type"|"dependencies"|"dependents"|"due_at"|"due_on"|"external"|"external.data"|"followers"|"followers.name"|"hearted"|"hearts"|"hearts.user"|"hearts.user.name"|"html_notes"|"is_rendered_as_separator"|"liked"|"likes"|"likes.user"|"likes.user.name"|"memberships"|"memberships.project"|"memberships.project.name"|"memberships.section"|"memberships.section.name"|"modified_at"|"name"|"notes"|"num_hearts"|"num_likes"|"num_subtasks"|"offset"|"parent"|"parent.created_by"|"parent.name"|"parent.resource_subtype"|"path"|"permalink_url"|"projects"|"projects.name"|"resource_subtype"|"start_at"|"start_on"|"tags"|"tags.name"|"uri"|"workspace"|"workspace.name")[]? (default ()) - This endpoint returns a compact 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.
Return Type
- Inline_response_200_39|error - Successfully retrieved the tasks associated with the specified tag.
get user_task_lists/[string user_task_list_gid]/tasks
function get user_task_lists/[string user_task_list_gid]/tasks(string? completed_since, boolean? opt_pretty, int? 'limit, string? offset, ("actual_time_minutes"|"approval_status"|"assignee"|"assignee.name"|"assignee_section"|"assignee_section.name"|"assignee_status"|"completed"|"completed_at"|"completed_by"|"completed_by.name"|"created_at"|"created_by"|"custom_fields"|"custom_fields.asana_created_field"|"custom_fields.created_by"|"custom_fields.created_by.name"|"custom_fields.currency_code"|"custom_fields.custom_label"|"custom_fields.custom_label_position"|"custom_fields.date_value"|"custom_fields.date_value.date"|"custom_fields.date_value.date_time"|"custom_fields.description"|"custom_fields.display_value"|"custom_fields.enabled"|"custom_fields.enum_options"|"custom_fields.enum_options.color"|"custom_fields.enum_options.enabled"|"custom_fields.enum_options.name"|"custom_fields.enum_value"|"custom_fields.enum_value.color"|"custom_fields.enum_value.enabled"|"custom_fields.enum_value.name"|"custom_fields.format"|"custom_fields.has_notifications_enabled"|"custom_fields.id_prefix"|"custom_fields.is_formula_field"|"custom_fields.is_global_to_workspace"|"custom_fields.is_value_read_only"|"custom_fields.multi_enum_values"|"custom_fields.multi_enum_values.color"|"custom_fields.multi_enum_values.enabled"|"custom_fields.multi_enum_values.name"|"custom_fields.name"|"custom_fields.number_value"|"custom_fields.people_value"|"custom_fields.people_value.name"|"custom_fields.precision"|"custom_fields.representation_type"|"custom_fields.resource_subtype"|"custom_fields.text_value"|"custom_fields.type"|"dependencies"|"dependents"|"due_at"|"due_on"|"external"|"external.data"|"followers"|"followers.name"|"hearted"|"hearts"|"hearts.user"|"hearts.user.name"|"html_notes"|"is_rendered_as_separator"|"liked"|"likes"|"likes.user"|"likes.user.name"|"memberships"|"memberships.project"|"memberships.project.name"|"memberships.section"|"memberships.section.name"|"modified_at"|"name"|"notes"|"num_hearts"|"num_likes"|"num_subtasks"|"offset"|"parent"|"parent.created_by"|"parent.name"|"parent.resource_subtype"|"path"|"permalink_url"|"projects"|"projects.name"|"resource_subtype"|"start_at"|"start_on"|"tags"|"tags.name"|"uri"|"workspace"|"workspace.name")[]? opt_fields) returns Inline_response_200_39|error
Get tasks from a user task list
Parameters
- completed_since string? (default ()) - Only return tasks that are either incomplete or that have been completed since this time. Accepts a date-time string or the keyword now.
- opt_pretty boolean? (default ()) - 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.
- 'limit int? (default ()) - Results per page. The number of objects to return per page. The value must be between 1 and 100.
- offset string? (default ()) - Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.'
- opt_fields ("actual_time_minutes"|"approval_status"|"assignee"|"assignee.name"|"assignee_section"|"assignee_section.name"|"assignee_status"|"completed"|"completed_at"|"completed_by"|"completed_by.name"|"created_at"|"created_by"|"custom_fields"|"custom_fields.asana_created_field"|"custom_fields.created_by"|"custom_fields.created_by.name"|"custom_fields.currency_code"|"custom_fields.custom_label"|"custom_fields.custom_label_position"|"custom_fields.date_value"|"custom_fields.date_value.date"|"custom_fields.date_value.date_time"|"custom_fields.description"|"custom_fields.display_value"|"custom_fields.enabled"|"custom_fields.enum_options"|"custom_fields.enum_options.color"|"custom_fields.enum_options.enabled"|"custom_fields.enum_options.name"|"custom_fields.enum_value"|"custom_fields.enum_value.color"|"custom_fields.enum_value.enabled"|"custom_fields.enum_value.name"|"custom_fields.format"|"custom_fields.has_notifications_enabled"|"custom_fields.id_prefix"|"custom_fields.is_formula_field"|"custom_fields.is_global_to_workspace"|"custom_fields.is_value_read_only"|"custom_fields.multi_enum_values"|"custom_fields.multi_enum_values.color"|"custom_fields.multi_enum_values.enabled"|"custom_fields.multi_enum_values.name"|"custom_fields.name"|"custom_fields.number_value"|"custom_fields.people_value"|"custom_fields.people_value.name"|"custom_fields.precision"|"custom_fields.representation_type"|"custom_fields.resource_subtype"|"custom_fields.text_value"|"custom_fields.type"|"dependencies"|"dependents"|"due_at"|"due_on"|"external"|"external.data"|"followers"|"followers.name"|"hearted"|"hearts"|"hearts.user"|"hearts.user.name"|"html_notes"|"is_rendered_as_separator"|"liked"|"likes"|"likes.user"|"likes.user.name"|"memberships"|"memberships.project"|"memberships.project.name"|"memberships.section"|"memberships.section.name"|"modified_at"|"name"|"notes"|"num_hearts"|"num_likes"|"num_subtasks"|"offset"|"parent"|"parent.created_by"|"parent.name"|"parent.resource_subtype"|"path"|"permalink_url"|"projects"|"projects.name"|"resource_subtype"|"start_at"|"start_on"|"tags"|"tags.name"|"uri"|"workspace"|"workspace.name")[]? (default ()) - This endpoint returns a compact 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.
Return Type
- Inline_response_200_39|error - Successfully retrieved the user task list's tasks.
get tasks/[string task_gid]/subtasks
function get tasks/[string task_gid]/subtasks(boolean? opt_pretty, int? 'limit, string? offset, ("actual_time_minutes"|"approval_status"|"assignee"|"assignee.name"|"assignee_section"|"assignee_section.name"|"assignee_status"|"completed"|"completed_at"|"completed_by"|"completed_by.name"|"created_at"|"created_by"|"custom_fields"|"custom_fields.asana_created_field"|"custom_fields.created_by"|"custom_fields.created_by.name"|"custom_fields.currency_code"|"custom_fields.custom_label"|"custom_fields.custom_label_position"|"custom_fields.date_value"|"custom_fields.date_value.date"|"custom_fields.date_value.date_time"|"custom_fields.description"|"custom_fields.display_value"|"custom_fields.enabled"|"custom_fields.enum_options"|"custom_fields.enum_options.color"|"custom_fields.enum_options.enabled"|"custom_fields.enum_options.name"|"custom_fields.enum_value"|"custom_fields.enum_value.color"|"custom_fields.enum_value.enabled"|"custom_fields.enum_value.name"|"custom_fields.format"|"custom_fields.has_notifications_enabled"|"custom_fields.id_prefix"|"custom_fields.is_formula_field"|"custom_fields.is_global_to_workspace"|"custom_fields.is_value_read_only"|"custom_fields.multi_enum_values"|"custom_fields.multi_enum_values.color"|"custom_fields.multi_enum_values.enabled"|"custom_fields.multi_enum_values.name"|"custom_fields.name"|"custom_fields.number_value"|"custom_fields.people_value"|"custom_fields.people_value.name"|"custom_fields.precision"|"custom_fields.representation_type"|"custom_fields.resource_subtype"|"custom_fields.text_value"|"custom_fields.type"|"dependencies"|"dependents"|"due_at"|"due_on"|"external"|"external.data"|"followers"|"followers.name"|"hearted"|"hearts"|"hearts.user"|"hearts.user.name"|"html_notes"|"is_rendered_as_separator"|"liked"|"likes"|"likes.user"|"likes.user.name"|"memberships"|"memberships.project"|"memberships.project.name"|"memberships.section"|"memberships.section.name"|"modified_at"|"name"|"notes"|"num_hearts"|"num_likes"|"num_subtasks"|"offset"|"parent"|"parent.created_by"|"parent.name"|"parent.resource_subtype"|"path"|"permalink_url"|"projects"|"projects.name"|"resource_subtype"|"start_at"|"start_on"|"tags"|"tags.name"|"uri"|"workspace"|"workspace.name")[]? opt_fields) returns Inline_response_200_39|error
Get subtasks from a task
Parameters
- opt_pretty boolean? (default ()) - 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.
- 'limit int? (default ()) - Results per page. The number of objects to return per page. The value must be between 1 and 100.
- offset string? (default ()) - Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.'
- opt_fields ("actual_time_minutes"|"approval_status"|"assignee"|"assignee.name"|"assignee_section"|"assignee_section.name"|"assignee_status"|"completed"|"completed_at"|"completed_by"|"completed_by.name"|"created_at"|"created_by"|"custom_fields"|"custom_fields.asana_created_field"|"custom_fields.created_by"|"custom_fields.created_by.name"|"custom_fields.currency_code"|"custom_fields.custom_label"|"custom_fields.custom_label_position"|"custom_fields.date_value"|"custom_fields.date_value.date"|"custom_fields.date_value.date_time"|"custom_fields.description"|"custom_fields.display_value"|"custom_fields.enabled"|"custom_fields.enum_options"|"custom_fields.enum_options.color"|"custom_fields.enum_options.enabled"|"custom_fields.enum_options.name"|"custom_fields.enum_value"|"custom_fields.enum_value.color"|"custom_fields.enum_value.enabled"|"custom_fields.enum_value.name"|"custom_fields.format"|"custom_fields.has_notifications_enabled"|"custom_fields.id_prefix"|"custom_fields.is_formula_field"|"custom_fields.is_global_to_workspace"|"custom_fields.is_value_read_only"|"custom_fields.multi_enum_values"|"custom_fields.multi_enum_values.color"|"custom_fields.multi_enum_values.enabled"|"custom_fields.multi_enum_values.name"|"custom_fields.name"|"custom_fields.number_value"|"custom_fields.people_value"|"custom_fields.people_value.name"|"custom_fields.precision"|"custom_fields.representation_type"|"custom_fields.resource_subtype"|"custom_fields.text_value"|"custom_fields.type"|"dependencies"|"dependents"|"due_at"|"due_on"|"external"|"external.data"|"followers"|"followers.name"|"hearted"|"hearts"|"hearts.user"|"hearts.user.name"|"html_notes"|"is_rendered_as_separator"|"liked"|"likes"|"likes.user"|"likes.user.name"|"memberships"|"memberships.project"|"memberships.project.name"|"memberships.section"|"memberships.section.name"|"modified_at"|"name"|"notes"|"num_hearts"|"num_likes"|"num_subtasks"|"offset"|"parent"|"parent.created_by"|"parent.name"|"parent.resource_subtype"|"path"|"permalink_url"|"projects"|"projects.name"|"resource_subtype"|"start_at"|"start_on"|"tags"|"tags.name"|"uri"|"workspace"|"workspace.name")[]? (default ()) - This endpoint returns a compact 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.
Return Type
- Inline_response_200_39|error - Successfully retrieved the specified task's subtasks.
post tasks/[string task_gid]/subtasks
function post tasks/[string task_gid]/subtasks(Task_gid_subtasks_body payload, boolean? opt_pretty, ("actual_time_minutes"|"approval_status"|"assignee"|"assignee.name"|"assignee_section"|"assignee_section.name"|"assignee_status"|"completed"|"completed_at"|"completed_by"|"completed_by.name"|"created_at"|"created_by"|"custom_fields"|"custom_fields.asana_created_field"|"custom_fields.created_by"|"custom_fields.created_by.name"|"custom_fields.currency_code"|"custom_fields.custom_label"|"custom_fields.custom_label_position"|"custom_fields.date_value"|"custom_fields.date_value.date"|"custom_fields.date_value.date_time"|"custom_fields.description"|"custom_fields.display_value"|"custom_fields.enabled"|"custom_fields.enum_options"|"custom_fields.enum_options.color"|"custom_fields.enum_options.enabled"|"custom_fields.enum_options.name"|"custom_fields.enum_value"|"custom_fields.enum_value.color"|"custom_fields.enum_value.enabled"|"custom_fields.enum_value.name"|"custom_fields.format"|"custom_fields.has_notifications_enabled"|"custom_fields.id_prefix"|"custom_fields.is_formula_field"|"custom_fields.is_global_to_workspace"|"custom_fields.is_value_read_only"|"custom_fields.multi_enum_values"|"custom_fields.multi_enum_values.color"|"custom_fields.multi_enum_values.enabled"|"custom_fields.multi_enum_values.name"|"custom_fields.name"|"custom_fields.number_value"|"custom_fields.people_value"|"custom_fields.people_value.name"|"custom_fields.precision"|"custom_fields.representation_type"|"custom_fields.resource_subtype"|"custom_fields.text_value"|"custom_fields.type"|"dependencies"|"dependents"|"due_at"|"due_on"|"external"|"external.data"|"followers"|"followers.name"|"hearted"|"hearts"|"hearts.user"|"hearts.user.name"|"html_notes"|"is_rendered_as_separator"|"liked"|"likes"|"likes.user"|"likes.user.name"|"memberships"|"memberships.project"|"memberships.project.name"|"memberships.section"|"memberships.section.name"|"modified_at"|"name"|"notes"|"num_hearts"|"num_likes"|"num_subtasks"|"parent"|"parent.created_by"|"parent.name"|"parent.resource_subtype"|"permalink_url"|"projects"|"projects.name"|"resource_subtype"|"start_at"|"start_on"|"tags"|"tags.name"|"workspace"|"workspace.name")[]? opt_fields) returns Inline_response_201_7|error
Create a subtask
Parameters
- payload Task_gid_subtasks_body - The new subtask to create.
- opt_pretty boolean? (default ()) - 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 ("actual_time_minutes"|"approval_status"|"assignee"|"assignee.name"|"assignee_section"|"assignee_section.name"|"assignee_status"|"completed"|"completed_at"|"completed_by"|"completed_by.name"|"created_at"|"created_by"|"custom_fields"|"custom_fields.asana_created_field"|"custom_fields.created_by"|"custom_fields.created_by.name"|"custom_fields.currency_code"|"custom_fields.custom_label"|"custom_fields.custom_label_position"|"custom_fields.date_value"|"custom_fields.date_value.date"|"custom_fields.date_value.date_time"|"custom_fields.description"|"custom_fields.display_value"|"custom_fields.enabled"|"custom_fields.enum_options"|"custom_fields.enum_options.color"|"custom_fields.enum_options.enabled"|"custom_fields.enum_options.name"|"custom_fields.enum_value"|"custom_fields.enum_value.color"|"custom_fields.enum_value.enabled"|"custom_fields.enum_value.name"|"custom_fields.format"|"custom_fields.has_notifications_enabled"|"custom_fields.id_prefix"|"custom_fields.is_formula_field"|"custom_fields.is_global_to_workspace"|"custom_fields.is_value_read_only"|"custom_fields.multi_enum_values"|"custom_fields.multi_enum_values.color"|"custom_fields.multi_enum_values.enabled"|"custom_fields.multi_enum_values.name"|"custom_fields.name"|"custom_fields.number_value"|"custom_fields.people_value"|"custom_fields.people_value.name"|"custom_fields.precision"|"custom_fields.representation_type"|"custom_fields.resource_subtype"|"custom_fields.text_value"|"custom_fields.type"|"dependencies"|"dependents"|"due_at"|"due_on"|"external"|"external.data"|"followers"|"followers.name"|"hearted"|"hearts"|"hearts.user"|"hearts.user.name"|"html_notes"|"is_rendered_as_separator"|"liked"|"likes"|"likes.user"|"likes.user.name"|"memberships"|"memberships.project"|"memberships.project.name"|"memberships.section"|"memberships.section.name"|"modified_at"|"name"|"notes"|"num_hearts"|"num_likes"|"num_subtasks"|"parent"|"parent.created_by"|"parent.name"|"parent.resource_subtype"|"permalink_url"|"projects"|"projects.name"|"resource_subtype"|"start_at"|"start_on"|"tags"|"tags.name"|"workspace"|"workspace.name")[]? (default ()) - This endpoint returns a compact 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.
Return Type
- Inline_response_201_7|error - Successfully created the specified subtask.
post tasks/[string task_gid]/setParent
function post tasks/[string task_gid]/setParent(Task_gid_setParent_body payload, boolean? opt_pretty, ("actual_time_minutes"|"approval_status"|"assignee"|"assignee.name"|"assignee_section"|"assignee_section.name"|"assignee_status"|"completed"|"completed_at"|"completed_by"|"completed_by.name"|"created_at"|"created_by"|"custom_fields"|"custom_fields.asana_created_field"|"custom_fields.created_by"|"custom_fields.created_by.name"|"custom_fields.currency_code"|"custom_fields.custom_label"|"custom_fields.custom_label_position"|"custom_fields.date_value"|"custom_fields.date_value.date"|"custom_fields.date_value.date_time"|"custom_fields.description"|"custom_fields.display_value"|"custom_fields.enabled"|"custom_fields.enum_options"|"custom_fields.enum_options.color"|"custom_fields.enum_options.enabled"|"custom_fields.enum_options.name"|"custom_fields.enum_value"|"custom_fields.enum_value.color"|"custom_fields.enum_value.enabled"|"custom_fields.enum_value.name"|"custom_fields.format"|"custom_fields.has_notifications_enabled"|"custom_fields.id_prefix"|"custom_fields.is_formula_field"|"custom_fields.is_global_to_workspace"|"custom_fields.is_value_read_only"|"custom_fields.multi_enum_values"|"custom_fields.multi_enum_values.color"|"custom_fields.multi_enum_values.enabled"|"custom_fields.multi_enum_values.name"|"custom_fields.name"|"custom_fields.number_value"|"custom_fields.people_value"|"custom_fields.people_value.name"|"custom_fields.precision"|"custom_fields.representation_type"|"custom_fields.resource_subtype"|"custom_fields.text_value"|"custom_fields.type"|"dependencies"|"dependents"|"due_at"|"due_on"|"external"|"external.data"|"followers"|"followers.name"|"hearted"|"hearts"|"hearts.user"|"hearts.user.name"|"html_notes"|"is_rendered_as_separator"|"liked"|"likes"|"likes.user"|"likes.user.name"|"memberships"|"memberships.project"|"memberships.project.name"|"memberships.section"|"memberships.section.name"|"modified_at"|"name"|"notes"|"num_hearts"|"num_likes"|"num_subtasks"|"parent"|"parent.created_by"|"parent.name"|"parent.resource_subtype"|"permalink_url"|"projects"|"projects.name"|"resource_subtype"|"start_at"|"start_on"|"tags"|"tags.name"|"workspace"|"workspace.name")[]? opt_fields) returns Inline_response_201_7|error
Set the parent of a task
Parameters
- payload Task_gid_setParent_body - The new parent of the subtask.
- opt_pretty boolean? (default ()) - 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 ("actual_time_minutes"|"approval_status"|"assignee"|"assignee.name"|"assignee_section"|"assignee_section.name"|"assignee_status"|"completed"|"completed_at"|"completed_by"|"completed_by.name"|"created_at"|"created_by"|"custom_fields"|"custom_fields.asana_created_field"|"custom_fields.created_by"|"custom_fields.created_by.name"|"custom_fields.currency_code"|"custom_fields.custom_label"|"custom_fields.custom_label_position"|"custom_fields.date_value"|"custom_fields.date_value.date"|"custom_fields.date_value.date_time"|"custom_fields.description"|"custom_fields.display_value"|"custom_fields.enabled"|"custom_fields.enum_options"|"custom_fields.enum_options.color"|"custom_fields.enum_options.enabled"|"custom_fields.enum_options.name"|"custom_fields.enum_value"|"custom_fields.enum_value.color"|"custom_fields.enum_value.enabled"|"custom_fields.enum_value.name"|"custom_fields.format"|"custom_fields.has_notifications_enabled"|"custom_fields.id_prefix"|"custom_fields.is_formula_field"|"custom_fields.is_global_to_workspace"|"custom_fields.is_value_read_only"|"custom_fields.multi_enum_values"|"custom_fields.multi_enum_values.color"|"custom_fields.multi_enum_values.enabled"|"custom_fields.multi_enum_values.name"|"custom_fields.name"|"custom_fields.number_value"|"custom_fields.people_value"|"custom_fields.people_value.name"|"custom_fields.precision"|"custom_fields.representation_type"|"custom_fields.resource_subtype"|"custom_fields.text_value"|"custom_fields.type"|"dependencies"|"dependents"|"due_at"|"due_on"|"external"|"external.data"|"followers"|"followers.name"|"hearted"|"hearts"|"hearts.user"|"hearts.user.name"|"html_notes"|"is_rendered_as_separator"|"liked"|"likes"|"likes.user"|"likes.user.name"|"memberships"|"memberships.project"|"memberships.project.name"|"memberships.section"|"memberships.section.name"|"modified_at"|"name"|"notes"|"num_hearts"|"num_likes"|"num_subtasks"|"parent"|"parent.created_by"|"parent.name"|"parent.resource_subtype"|"permalink_url"|"projects"|"projects.name"|"resource_subtype"|"start_at"|"start_on"|"tags"|"tags.name"|"workspace"|"workspace.name")[]? (default ()) - This endpoint returns a compact 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.
Return Type
- Inline_response_201_7|error - Successfully changed the parent of the specified subtask.
get tasks/[string task_gid]/dependencies
function get tasks/[string task_gid]/dependencies(boolean? opt_pretty, int? 'limit, string? offset, ("actual_time_minutes"|"approval_status"|"assignee"|"assignee.name"|"assignee_section"|"assignee_section.name"|"assignee_status"|"completed"|"completed_at"|"completed_by"|"completed_by.name"|"created_at"|"created_by"|"custom_fields"|"custom_fields.asana_created_field"|"custom_fields.created_by"|"custom_fields.created_by.name"|"custom_fields.currency_code"|"custom_fields.custom_label"|"custom_fields.custom_label_position"|"custom_fields.date_value"|"custom_fields.date_value.date"|"custom_fields.date_value.date_time"|"custom_fields.description"|"custom_fields.display_value"|"custom_fields.enabled"|"custom_fields.enum_options"|"custom_fields.enum_options.color"|"custom_fields.enum_options.enabled"|"custom_fields.enum_options.name"|"custom_fields.enum_value"|"custom_fields.enum_value.color"|"custom_fields.enum_value.enabled"|"custom_fields.enum_value.name"|"custom_fields.format"|"custom_fields.has_notifications_enabled"|"custom_fields.id_prefix"|"custom_fields.is_formula_field"|"custom_fields.is_global_to_workspace"|"custom_fields.is_value_read_only"|"custom_fields.multi_enum_values"|"custom_fields.multi_enum_values.color"|"custom_fields.multi_enum_values.enabled"|"custom_fields.multi_enum_values.name"|"custom_fields.name"|"custom_fields.number_value"|"custom_fields.people_value"|"custom_fields.people_value.name"|"custom_fields.precision"|"custom_fields.representation_type"|"custom_fields.resource_subtype"|"custom_fields.text_value"|"custom_fields.type"|"dependencies"|"dependents"|"due_at"|"due_on"|"external"|"external.data"|"followers"|"followers.name"|"hearted"|"hearts"|"hearts.user"|"hearts.user.name"|"html_notes"|"is_rendered_as_separator"|"liked"|"likes"|"likes.user"|"likes.user.name"|"memberships"|"memberships.project"|"memberships.project.name"|"memberships.section"|"memberships.section.name"|"modified_at"|"name"|"notes"|"num_hearts"|"num_likes"|"num_subtasks"|"offset"|"parent"|"parent.created_by"|"parent.name"|"parent.resource_subtype"|"path"|"permalink_url"|"projects"|"projects.name"|"resource_subtype"|"start_at"|"start_on"|"tags"|"tags.name"|"uri"|"workspace"|"workspace.name")[]? opt_fields) returns Inline_response_200_39|error
Get dependencies from a task
Parameters
- opt_pretty boolean? (default ()) - 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.
- 'limit int? (default ()) - Results per page. The number of objects to return per page. The value must be between 1 and 100.
- offset string? (default ()) - Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.'
- opt_fields ("actual_time_minutes"|"approval_status"|"assignee"|"assignee.name"|"assignee_section"|"assignee_section.name"|"assignee_status"|"completed"|"completed_at"|"completed_by"|"completed_by.name"|"created_at"|"created_by"|"custom_fields"|"custom_fields.asana_created_field"|"custom_fields.created_by"|"custom_fields.created_by.name"|"custom_fields.currency_code"|"custom_fields.custom_label"|"custom_fields.custom_label_position"|"custom_fields.date_value"|"custom_fields.date_value.date"|"custom_fields.date_value.date_time"|"custom_fields.description"|"custom_fields.display_value"|"custom_fields.enabled"|"custom_fields.enum_options"|"custom_fields.enum_options.color"|"custom_fields.enum_options.enabled"|"custom_fields.enum_options.name"|"custom_fields.enum_value"|"custom_fields.enum_value.color"|"custom_fields.enum_value.enabled"|"custom_fields.enum_value.name"|"custom_fields.format"|"custom_fields.has_notifications_enabled"|"custom_fields.id_prefix"|"custom_fields.is_formula_field"|"custom_fields.is_global_to_workspace"|"custom_fields.is_value_read_only"|"custom_fields.multi_enum_values"|"custom_fields.multi_enum_values.color"|"custom_fields.multi_enum_values.enabled"|"custom_fields.multi_enum_values.name"|"custom_fields.name"|"custom_fields.number_value"|"custom_fields.people_value"|"custom_fields.people_value.name"|"custom_fields.precision"|"custom_fields.representation_type"|"custom_fields.resource_subtype"|"custom_fields.text_value"|"custom_fields.type"|"dependencies"|"dependents"|"due_at"|"due_on"|"external"|"external.data"|"followers"|"followers.name"|"hearted"|"hearts"|"hearts.user"|"hearts.user.name"|"html_notes"|"is_rendered_as_separator"|"liked"|"likes"|"likes.user"|"likes.user.name"|"memberships"|"memberships.project"|"memberships.project.name"|"memberships.section"|"memberships.section.name"|"modified_at"|"name"|"notes"|"num_hearts"|"num_likes"|"num_subtasks"|"offset"|"parent"|"parent.created_by"|"parent.name"|"parent.resource_subtype"|"path"|"permalink_url"|"projects"|"projects.name"|"resource_subtype"|"start_at"|"start_on"|"tags"|"tags.name"|"uri"|"workspace"|"workspace.name")[]? (default ()) - This endpoint returns a compact 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.
Return Type
- Inline_response_200_39|error - Successfully retrieved the specified task's dependencies.
post tasks/[string task_gid]/addDependencies
function post tasks/[string task_gid]/addDependencies(Task_gid_addDependencies_body payload, boolean? opt_pretty) returns Inline_response_200_1|error
Set dependencies for a task
Parameters
- payload Task_gid_addDependencies_body - The list of tasks to set as dependencies.
- opt_pretty boolean? (default ()) - 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.
Return Type
- Inline_response_200_1|error - Successfully set the specified dependencies on the task.
post tasks/[string task_gid]/removeDependencies
function post tasks/[string task_gid]/removeDependencies(Task_gid_removeDependencies_body payload, boolean? opt_pretty) returns Inline_response_200_1|error
Unlink dependencies from a task
Parameters
- payload Task_gid_removeDependencies_body - The list of tasks to unlink as dependencies.
- opt_pretty boolean? (default ()) - 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.
Return Type
- Inline_response_200_1|error - Successfully unlinked the dependencies from the specified task.
get tasks/[string task_gid]/dependents
function get tasks/[string task_gid]/dependents(boolean? opt_pretty, int? 'limit, string? offset, ("actual_time_minutes"|"approval_status"|"assignee"|"assignee.name"|"assignee_section"|"assignee_section.name"|"assignee_status"|"completed"|"completed_at"|"completed_by"|"completed_by.name"|"created_at"|"created_by"|"custom_fields"|"custom_fields.asana_created_field"|"custom_fields.created_by"|"custom_fields.created_by.name"|"custom_fields.currency_code"|"custom_fields.custom_label"|"custom_fields.custom_label_position"|"custom_fields.date_value"|"custom_fields.date_value.date"|"custom_fields.date_value.date_time"|"custom_fields.description"|"custom_fields.display_value"|"custom_fields.enabled"|"custom_fields.enum_options"|"custom_fields.enum_options.color"|"custom_fields.enum_options.enabled"|"custom_fields.enum_options.name"|"custom_fields.enum_value"|"custom_fields.enum_value.color"|"custom_fields.enum_value.enabled"|"custom_fields.enum_value.name"|"custom_fields.format"|"custom_fields.has_notifications_enabled"|"custom_fields.id_prefix"|"custom_fields.is_formula_field"|"custom_fields.is_global_to_workspace"|"custom_fields.is_value_read_only"|"custom_fields.multi_enum_values"|"custom_fields.multi_enum_values.color"|"custom_fields.multi_enum_values.enabled"|"custom_fields.multi_enum_values.name"|"custom_fields.name"|"custom_fields.number_value"|"custom_fields.people_value"|"custom_fields.people_value.name"|"custom_fields.precision"|"custom_fields.representation_type"|"custom_fields.resource_subtype"|"custom_fields.text_value"|"custom_fields.type"|"dependencies"|"dependents"|"due_at"|"due_on"|"external"|"external.data"|"followers"|"followers.name"|"hearted"|"hearts"|"hearts.user"|"hearts.user.name"|"html_notes"|"is_rendered_as_separator"|"liked"|"likes"|"likes.user"|"likes.user.name"|"memberships"|"memberships.project"|"memberships.project.name"|"memberships.section"|"memberships.section.name"|"modified_at"|"name"|"notes"|"num_hearts"|"num_likes"|"num_subtasks"|"offset"|"parent"|"parent.created_by"|"parent.name"|"parent.resource_subtype"|"path"|"permalink_url"|"projects"|"projects.name"|"resource_subtype"|"start_at"|"start_on"|"tags"|"tags.name"|"uri"|"workspace"|"workspace.name")[]? opt_fields) returns Inline_response_200_39|error
Get dependents from a task
Parameters
- opt_pretty boolean? (default ()) - 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.
- 'limit int? (default ()) - Results per page. The number of objects to return per page. The value must be between 1 and 100.
- offset string? (default ()) - Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.'
- opt_fields ("actual_time_minutes"|"approval_status"|"assignee"|"assignee.name"|"assignee_section"|"assignee_section.name"|"assignee_status"|"completed"|"completed_at"|"completed_by"|"completed_by.name"|"created_at"|"created_by"|"custom_fields"|"custom_fields.asana_created_field"|"custom_fields.created_by"|"custom_fields.created_by.name"|"custom_fields.currency_code"|"custom_fields.custom_label"|"custom_fields.custom_label_position"|"custom_fields.date_value"|"custom_fields.date_value.date"|"custom_fields.date_value.date_time"|"custom_fields.description"|"custom_fields.display_value"|"custom_fields.enabled"|"custom_fields.enum_options"|"custom_fields.enum_options.color"|"custom_fields.enum_options.enabled"|"custom_fields.enum_options.name"|"custom_fields.enum_value"|"custom_fields.enum_value.color"|"custom_fields.enum_value.enabled"|"custom_fields.enum_value.name"|"custom_fields.format"|"custom_fields.has_notifications_enabled"|"custom_fields.id_prefix"|"custom_fields.is_formula_field"|"custom_fields.is_global_to_workspace"|"custom_fields.is_value_read_only"|"custom_fields.multi_enum_values"|"custom_fields.multi_enum_values.color"|"custom_fields.multi_enum_values.enabled"|"custom_fields.multi_enum_values.name"|"custom_fields.name"|"custom_fields.number_value"|"custom_fields.people_value"|"custom_fields.people_value.name"|"custom_fields.precision"|"custom_fields.representation_type"|"custom_fields.resource_subtype"|"custom_fields.text_value"|"custom_fields.type"|"dependencies"|"dependents"|"due_at"|"due_on"|"external"|"external.data"|"followers"|"followers.name"|"hearted"|"hearts"|"hearts.user"|"hearts.user.name"|"html_notes"|"is_rendered_as_separator"|"liked"|"likes"|"likes.user"|"likes.user.name"|"memberships"|"memberships.project"|"memberships.project.name"|"memberships.section"|"memberships.section.name"|"modified_at"|"name"|"notes"|"num_hearts"|"num_likes"|"num_subtasks"|"offset"|"parent"|"parent.created_by"|"parent.name"|"parent.resource_subtype"|"path"|"permalink_url"|"projects"|"projects.name"|"resource_subtype"|"start_at"|"start_on"|"tags"|"tags.name"|"uri"|"workspace"|"workspace.name")[]? (default ()) - This endpoint returns a compact 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.
Return Type
- Inline_response_200_39|error - Successfully retrieved the specified dependents of the task.
post tasks/[string task_gid]/addDependents
function post tasks/[string task_gid]/addDependents(Task_gid_addDependents_body payload, boolean? opt_pretty) returns Inline_response_200_1|error
Set dependents for a task
Parameters
- payload Task_gid_addDependents_body - The list of tasks to add as dependents.
- opt_pretty boolean? (default ()) - 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.
Return Type
- Inline_response_200_1|error - Successfully set the specified dependents on the given task.
post tasks/[string task_gid]/removeDependents
function post tasks/[string task_gid]/removeDependents(Task_gid_removeDependents_body payload, boolean? opt_pretty) returns Inline_response_200_1|error
Unlink dependents from a task
Parameters
- payload Task_gid_removeDependents_body - The list of tasks to remove as dependents.
- opt_pretty boolean? (default ()) - 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.
Return Type
- Inline_response_200_1|error - Successfully unlinked the specified tasks as dependents.
post tasks/[string task_gid]/addProject
function post tasks/[string task_gid]/addProject(Task_gid_addProject_body payload, boolean? opt_pretty) returns Inline_response_200_1|error
Add a project to a task
Parameters
- payload Task_gid_addProject_body - The project to add the task to.
- opt_pretty boolean? (default ()) - 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.
Return Type
- Inline_response_200_1|error - Successfully added the specified project to the task.
post tasks/[string task_gid]/removeProject
function post tasks/[string task_gid]/removeProject(Task_gid_removeProject_body payload, boolean? opt_pretty) returns Inline_response_200_1|error
Remove a project from a task
Parameters
- payload Task_gid_removeProject_body - The project to remove the task from.
- opt_pretty boolean? (default ()) - 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.
Return Type
- Inline_response_200_1|error - Successfully removed the specified project from the task.
post tasks/[string task_gid]/addTag
function post tasks/[string task_gid]/addTag(Task_gid_addTag_body payload, boolean? opt_pretty) returns Inline_response_200_1|error
Add a tag to a task
Parameters
- payload Task_gid_addTag_body - The tag to add to the task.
- opt_pretty boolean? (default ()) - 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.
Return Type
- Inline_response_200_1|error - Successfully added the specified tag to the task.
post tasks/[string task_gid]/removeTag
function post tasks/[string task_gid]/removeTag(Task_gid_removeTag_body payload, boolean? opt_pretty) returns Inline_response_200_1|error
Remove a tag from a task
Parameters
- payload Task_gid_removeTag_body - The tag to remove from the task.
- opt_pretty boolean? (default ()) - 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.
Return Type
- Inline_response_200_1|error - Successfully removed the specified tag from the task.
post tasks/[string task_gid]/addFollowers
function post tasks/[string task_gid]/addFollowers(Task_gid_addFollowers_body payload, boolean? opt_pretty, ("actual_time_minutes"|"approval_status"|"assignee"|"assignee.name"|"assignee_section"|"assignee_section.name"|"assignee_status"|"completed"|"completed_at"|"completed_by"|"completed_by.name"|"created_at"|"created_by"|"custom_fields"|"custom_fields.asana_created_field"|"custom_fields.created_by"|"custom_fields.created_by.name"|"custom_fields.currency_code"|"custom_fields.custom_label"|"custom_fields.custom_label_position"|"custom_fields.date_value"|"custom_fields.date_value.date"|"custom_fields.date_value.date_time"|"custom_fields.description"|"custom_fields.display_value"|"custom_fields.enabled"|"custom_fields.enum_options"|"custom_fields.enum_options.color"|"custom_fields.enum_options.enabled"|"custom_fields.enum_options.name"|"custom_fields.enum_value"|"custom_fields.enum_value.color"|"custom_fields.enum_value.enabled"|"custom_fields.enum_value.name"|"custom_fields.format"|"custom_fields.has_notifications_enabled"|"custom_fields.id_prefix"|"custom_fields.is_formula_field"|"custom_fields.is_global_to_workspace"|"custom_fields.is_value_read_only"|"custom_fields.multi_enum_values"|"custom_fields.multi_enum_values.color"|"custom_fields.multi_enum_values.enabled"|"custom_fields.multi_enum_values.name"|"custom_fields.name"|"custom_fields.number_value"|"custom_fields.people_value"|"custom_fields.people_value.name"|"custom_fields.precision"|"custom_fields.representation_type"|"custom_fields.resource_subtype"|"custom_fields.text_value"|"custom_fields.type"|"dependencies"|"dependents"|"due_at"|"due_on"|"external"|"external.data"|"followers"|"followers.name"|"hearted"|"hearts"|"hearts.user"|"hearts.user.name"|"html_notes"|"is_rendered_as_separator"|"liked"|"likes"|"likes.user"|"likes.user.name"|"memberships"|"memberships.project"|"memberships.project.name"|"memberships.section"|"memberships.section.name"|"modified_at"|"name"|"notes"|"num_hearts"|"num_likes"|"num_subtasks"|"parent"|"parent.created_by"|"parent.name"|"parent.resource_subtype"|"permalink_url"|"projects"|"projects.name"|"resource_subtype"|"start_at"|"start_on"|"tags"|"tags.name"|"workspace"|"workspace.name")[]? opt_fields) returns Inline_response_201_7|error
Add followers to a task
Parameters
- payload Task_gid_addFollowers_body - The followers to add to the task.
- opt_pretty boolean? (default ()) - 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 ("actual_time_minutes"|"approval_status"|"assignee"|"assignee.name"|"assignee_section"|"assignee_section.name"|"assignee_status"|"completed"|"completed_at"|"completed_by"|"completed_by.name"|"created_at"|"created_by"|"custom_fields"|"custom_fields.asana_created_field"|"custom_fields.created_by"|"custom_fields.created_by.name"|"custom_fields.currency_code"|"custom_fields.custom_label"|"custom_fields.custom_label_position"|"custom_fields.date_value"|"custom_fields.date_value.date"|"custom_fields.date_value.date_time"|"custom_fields.description"|"custom_fields.display_value"|"custom_fields.enabled"|"custom_fields.enum_options"|"custom_fields.enum_options.color"|"custom_fields.enum_options.enabled"|"custom_fields.enum_options.name"|"custom_fields.enum_value"|"custom_fields.enum_value.color"|"custom_fields.enum_value.enabled"|"custom_fields.enum_value.name"|"custom_fields.format"|"custom_fields.has_notifications_enabled"|"custom_fields.id_prefix"|"custom_fields.is_formula_field"|"custom_fields.is_global_to_workspace"|"custom_fields.is_value_read_only"|"custom_fields.multi_enum_values"|"custom_fields.multi_enum_values.color"|"custom_fields.multi_enum_values.enabled"|"custom_fields.multi_enum_values.name"|"custom_fields.name"|"custom_fields.number_value"|"custom_fields.people_value"|"custom_fields.people_value.name"|"custom_fields.precision"|"custom_fields.representation_type"|"custom_fields.resource_subtype"|"custom_fields.text_value"|"custom_fields.type"|"dependencies"|"dependents"|"due_at"|"due_on"|"external"|"external.data"|"followers"|"followers.name"|"hearted"|"hearts"|"hearts.user"|"hearts.user.name"|"html_notes"|"is_rendered_as_separator"|"liked"|"likes"|"likes.user"|"likes.user.name"|"memberships"|"memberships.project"|"memberships.project.name"|"memberships.section"|"memberships.section.name"|"modified_at"|"name"|"notes"|"num_hearts"|"num_likes"|"num_subtasks"|"parent"|"parent.created_by"|"parent.name"|"parent.resource_subtype"|"permalink_url"|"projects"|"projects.name"|"resource_subtype"|"start_at"|"start_on"|"tags"|"tags.name"|"workspace"|"workspace.name")[]? (default ()) - This endpoint returns a compact 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.
Return Type
- Inline_response_201_7|error - Successfully added the specified followers to the task.
post tasks/[string task_gid]/removeFollowers
function post tasks/[string task_gid]/removeFollowers(Task_gid_removeFollowers_body payload, boolean? opt_pretty, ("actual_time_minutes"|"approval_status"|"assignee"|"assignee.name"|"assignee_section"|"assignee_section.name"|"assignee_status"|"completed"|"completed_at"|"completed_by"|"completed_by.name"|"created_at"|"created_by"|"custom_fields"|"custom_fields.asana_created_field"|"custom_fields.created_by"|"custom_fields.created_by.name"|"custom_fields.currency_code"|"custom_fields.custom_label"|"custom_fields.custom_label_position"|"custom_fields.date_value"|"custom_fields.date_value.date"|"custom_fields.date_value.date_time"|"custom_fields.description"|"custom_fields.display_value"|"custom_fields.enabled"|"custom_fields.enum_options"|"custom_fields.enum_options.color"|"custom_fields.enum_options.enabled"|"custom_fields.enum_options.name"|"custom_fields.enum_value"|"custom_fields.enum_value.color"|"custom_fields.enum_value.enabled"|"custom_fields.enum_value.name"|"custom_fields.format"|"custom_fields.has_notifications_enabled"|"custom_fields.id_prefix"|"custom_fields.is_formula_field"|"custom_fields.is_global_to_workspace"|"custom_fields.is_value_read_only"|"custom_fields.multi_enum_values"|"custom_fields.multi_enum_values.color"|"custom_fields.multi_enum_values.enabled"|"custom_fields.multi_enum_values.name"|"custom_fields.name"|"custom_fields.number_value"|"custom_fields.people_value"|"custom_fields.people_value.name"|"custom_fields.precision"|"custom_fields.representation_type"|"custom_fields.resource_subtype"|"custom_fields.text_value"|"custom_fields.type"|"dependencies"|"dependents"|"due_at"|"due_on"|"external"|"external.data"|"followers"|"followers.name"|"hearted"|"hearts"|"hearts.user"|"hearts.user.name"|"html_notes"|"is_rendered_as_separator"|"liked"|"likes"|"likes.user"|"likes.user.name"|"memberships"|"memberships.project"|"memberships.project.name"|"memberships.section"|"memberships.section.name"|"modified_at"|"name"|"notes"|"num_hearts"|"num_likes"|"num_subtasks"|"parent"|"parent.created_by"|"parent.name"|"parent.resource_subtype"|"permalink_url"|"projects"|"projects.name"|"resource_subtype"|"start_at"|"start_on"|"tags"|"tags.name"|"workspace"|"workspace.name")[]? opt_fields) returns Inline_response_201_7|error
Remove followers from a task
Parameters
- payload Task_gid_removeFollowers_body - The followers to remove from the task.
- opt_pretty boolean? (default ()) - 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 ("actual_time_minutes"|"approval_status"|"assignee"|"assignee.name"|"assignee_section"|"assignee_section.name"|"assignee_status"|"completed"|"completed_at"|"completed_by"|"completed_by.name"|"created_at"|"created_by"|"custom_fields"|"custom_fields.asana_created_field"|"custom_fields.created_by"|"custom_fields.created_by.name"|"custom_fields.currency_code"|"custom_fields.custom_label"|"custom_fields.custom_label_position"|"custom_fields.date_value"|"custom_fields.date_value.date"|"custom_fields.date_value.date_time"|"custom_fields.description"|"custom_fields.display_value"|"custom_fields.enabled"|"custom_fields.enum_options"|"custom_fields.enum_options.color"|"custom_fields.enum_options.enabled"|"custom_fields.enum_options.name"|"custom_fields.enum_value"|"custom_fields.enum_value.color"|"custom_fields.enum_value.enabled"|"custom_fields.enum_value.name"|"custom_fields.format"|"custom_fields.has_notifications_enabled"|"custom_fields.id_prefix"|"custom_fields.is_formula_field"|"custom_fields.is_global_to_workspace"|"custom_fields.is_value_read_only"|"custom_fields.multi_enum_values"|"custom_fields.multi_enum_values.color"|"custom_fields.multi_enum_values.enabled"|"custom_fields.multi_enum_values.name"|"custom_fields.name"|"custom_fields.number_value"|"custom_fields.people_value"|"custom_fields.people_value.name"|"custom_fields.precision"|"custom_fields.representation_type"|"custom_fields.resource_subtype"|"custom_fields.text_value"|"custom_fields.type"|"dependencies"|"dependents"|"due_at"|"due_on"|"external"|"external.data"|"followers"|"followers.name"|"hearted"|"hearts"|"hearts.user"|"hearts.user.name"|"html_notes"|"is_rendered_as_separator"|"liked"|"likes"|"likes.user"|"likes.user.name"|"memberships"|"memberships.project"|"memberships.project.name"|"memberships.section"|"memberships.section.name"|"modified_at"|"name"|"notes"|"num_hearts"|"num_likes"|"num_subtasks"|"parent"|"parent.created_by"|"parent.name"|"parent.resource_subtype"|"permalink_url"|"projects"|"projects.name"|"resource_subtype"|"start_at"|"start_on"|"tags"|"tags.name"|"workspace"|"workspace.name")[]? (default ()) - This endpoint returns a compact 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.
Return Type
- Inline_response_201_7|error - Successfully removed the specified followers from the task.
get workspaces/[string workspace_gid]/tasks/custom_id/[string custom_id]
function get workspaces/[string workspace_gid]/tasks/custom_id/[string custom_id]() returns Inline_response_201_7|error
Get a task for a given custom ID
Return Type
- Inline_response_201_7|error - Successfully retrieved task for given custom ID.
get workspaces/[string workspace_gid]/tasks/search
function get workspaces/[string workspace_gid]/tasks/search(boolean? opt_pretty, string? text, "default_task"|"milestone" resource_subtype, string? assigneeAny, string? assigneeNot, string? portfoliosAny, string? projectsAny, string? projectsNot, string? projectsAll, string? sectionsAny, string? sectionsNot, string? sectionsAll, string? tagsAny, string? tagsNot, string? tagsAll, string? teamsAny, string? followersNot, string? created_byAny, string? created_byNot, string? assigned_byAny, string? assigned_byNot, string? liked_byNot, string? commented_on_byNot, string? due_onBefore, string? due_onAfter, string? due_on, string? due_atBefore, string? due_atAfter, string? start_onBefore, string? start_onAfter, string? start_on, string? created_onBefore, string? created_onAfter, string? created_on, string? created_atBefore, string? created_atAfter, string? completed_onBefore, string? completed_onAfter, string? completed_on, string? completed_atBefore, string? completed_atAfter, string? modified_onBefore, string? modified_onAfter, string? modified_on, string? modified_atBefore, string? modified_atAfter, boolean? is_blocking, boolean? is_blocked, boolean? has_attachment, boolean? completed, boolean? is_subtask, "due_date"|"created_at"|"completed_at"|"likes"|"modified_at" sort_by, boolean sort_ascending, ("actual_time_minutes"|"approval_status"|"assignee"|"assignee.name"|"assignee_section"|"assignee_section.name"|"assignee_status"|"completed"|"completed_at"|"completed_by"|"completed_by.name"|"created_at"|"created_by"|"custom_fields"|"custom_fields.asana_created_field"|"custom_fields.created_by"|"custom_fields.created_by.name"|"custom_fields.currency_code"|"custom_fields.custom_label"|"custom_fields.custom_label_position"|"custom_fields.date_value"|"custom_fields.date_value.date"|"custom_fields.date_value.date_time"|"custom_fields.description"|"custom_fields.display_value"|"custom_fields.enabled"|"custom_fields.enum_options"|"custom_fields.enum_options.color"|"custom_fields.enum_options.enabled"|"custom_fields.enum_options.name"|"custom_fields.enum_value"|"custom_fields.enum_value.color"|"custom_fields.enum_value.enabled"|"custom_fields.enum_value.name"|"custom_fields.format"|"custom_fields.has_notifications_enabled"|"custom_fields.id_prefix"|"custom_fields.is_formula_field"|"custom_fields.is_global_to_workspace"|"custom_fields.is_value_read_only"|"custom_fields.multi_enum_values"|"custom_fields.multi_enum_values.color"|"custom_fields.multi_enum_values.enabled"|"custom_fields.multi_enum_values.name"|"custom_fields.name"|"custom_fields.number_value"|"custom_fields.people_value"|"custom_fields.people_value.name"|"custom_fields.precision"|"custom_fields.representation_type"|"custom_fields.resource_subtype"|"custom_fields.text_value"|"custom_fields.type"|"dependencies"|"dependents"|"due_at"|"due_on"|"external"|"external.data"|"followers"|"followers.name"|"hearted"|"hearts"|"hearts.user"|"hearts.user.name"|"html_notes"|"is_rendered_as_separator"|"liked"|"likes"|"likes.user"|"likes.user.name"|"memberships"|"memberships.project"|"memberships.project.name"|"memberships.section"|"memberships.section.name"|"modified_at"|"name"|"notes"|"num_hearts"|"num_likes"|"num_subtasks"|"parent"|"parent.created_by"|"parent.name"|"parent.resource_subtype"|"permalink_url"|"projects"|"projects.name"|"resource_subtype"|"start_at"|"start_on"|"tags"|"tags.name"|"workspace"|"workspace.name")[]? opt_fields) returns Inline_response_200_40|error
Search tasks in a workspace
Parameters
- opt_pretty boolean? (default ()) - 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.
- text string? (default ()) - Performs full-text search on both task name and description
- resource_subtype "default_task"|"milestone" (default "milestone") - Filters results by the task's resource_subtype
- assigneeAny string? (default ()) - Comma-separated list of user identifiers
- assigneeNot string? (default ()) - Comma-separated list of user identifiers
- portfoliosAny string? (default ()) - Comma-separated list of portfolio IDs
- projectsAny string? (default ()) - Comma-separated list of project IDs
- projectsNot string? (default ()) - Comma-separated list of project IDs
- projectsAll string? (default ()) - Comma-separated list of project IDs
- sectionsAny string? (default ()) - Comma-separated list of section or column IDs
- sectionsNot string? (default ()) - Comma-separated list of section or column IDs
- sectionsAll string? (default ()) - Comma-separated list of section or column IDs
- tagsAny string? (default ()) - Comma-separated list of tag IDs
- tagsNot string? (default ()) - Comma-separated list of tag IDs
- tagsAll string? (default ()) - Comma-separated list of tag IDs
- teamsAny string? (default ()) - Comma-separated list of team IDs
- followersNot string? (default ()) - Comma-separated list of user identifiers
- created_byAny string? (default ()) - Comma-separated list of user identifiers
- created_byNot string? (default ()) - Comma-separated list of user identifiers
- assigned_byAny string? (default ()) - Comma-separated list of user identifiers
- assigned_byNot string? (default ()) - Comma-separated list of user identifiers
- liked_byNot string? (default ()) - Comma-separated list of user identifiers
- commented_on_byNot string? (default ()) - Comma-separated list of user identifiers
- due_onBefore string? (default ()) - ISO 8601 date string
- due_onAfter string? (default ()) - ISO 8601 date string
- due_on string? (default ()) - ISO 8601 date string or
null
- due_atBefore string? (default ()) - ISO 8601 datetime string
- due_atAfter string? (default ()) - ISO 8601 datetime string
- start_onBefore string? (default ()) - ISO 8601 date string
- start_onAfter string? (default ()) - ISO 8601 date string
- start_on string? (default ()) - ISO 8601 date string or
null
- created_onBefore string? (default ()) - ISO 8601 date string
- created_onAfter string? (default ()) - ISO 8601 date string
- created_on string? (default ()) - ISO 8601 date string or
null
- created_atBefore string? (default ()) - ISO 8601 datetime string
- created_atAfter string? (default ()) - ISO 8601 datetime string
- completed_onBefore string? (default ()) - ISO 8601 date string
- completed_onAfter string? (default ()) - ISO 8601 date string
- completed_on string? (default ()) - ISO 8601 date string or
null
- completed_atBefore string? (default ()) - ISO 8601 datetime string
- completed_atAfter string? (default ()) - ISO 8601 datetime string
- modified_onBefore string? (default ()) - ISO 8601 date string
- modified_onAfter string? (default ()) - ISO 8601 date string
- modified_on string? (default ()) - ISO 8601 date string or
null
- modified_atBefore string? (default ()) - ISO 8601 datetime string
- modified_atAfter string? (default ()) - ISO 8601 datetime string
- is_blocking boolean? (default ()) - Filter to incomplete tasks with dependents
- is_blocked boolean? (default ()) - Filter to tasks with incomplete dependencies
- has_attachment boolean? (default ()) - Filter to tasks with attachments
- completed boolean? (default ()) - Filter to completed tasks
- is_subtask boolean? (default ()) - Filter to subtasks
- sort_by "due_date"|"created_at"|"completed_at"|"likes"|"modified_at" (default "modified_at") - One of
due_date
,created_at
,completed_at
,likes
, ormodified_at
, defaults tomodified_at
- sort_ascending boolean (default false) - Default
false
- opt_fields ("actual_time_minutes"|"approval_status"|"assignee"|"assignee.name"|"assignee_section"|"assignee_section.name"|"assignee_status"|"completed"|"completed_at"|"completed_by"|"completed_by.name"|"created_at"|"created_by"|"custom_fields"|"custom_fields.asana_created_field"|"custom_fields.created_by"|"custom_fields.created_by.name"|"custom_fields.currency_code"|"custom_fields.custom_label"|"custom_fields.custom_label_position"|"custom_fields.date_value"|"custom_fields.date_value.date"|"custom_fields.date_value.date_time"|"custom_fields.description"|"custom_fields.display_value"|"custom_fields.enabled"|"custom_fields.enum_options"|"custom_fields.enum_options.color"|"custom_fields.enum_options.enabled"|"custom_fields.enum_options.name"|"custom_fields.enum_value"|"custom_fields.enum_value.color"|"custom_fields.enum_value.enabled"|"custom_fields.enum_value.name"|"custom_fields.format"|"custom_fields.has_notifications_enabled"|"custom_fields.id_prefix"|"custom_fields.is_formula_field"|"custom_fields.is_global_to_workspace"|"custom_fields.is_value_read_only"|"custom_fields.multi_enum_values"|"custom_fields.multi_enum_values.color"|"custom_fields.multi_enum_values.enabled"|"custom_fields.multi_enum_values.name"|"custom_fields.name"|"custom_fields.number_value"|"custom_fields.people_value"|"custom_fields.people_value.name"|"custom_fields.precision"|"custom_fields.representation_type"|"custom_fields.resource_subtype"|"custom_fields.text_value"|"custom_fields.type"|"dependencies"|"dependents"|"due_at"|"due_on"|"external"|"external.data"|"followers"|"followers.name"|"hearted"|"hearts"|"hearts.user"|"hearts.user.name"|"html_notes"|"is_rendered_as_separator"|"liked"|"likes"|"likes.user"|"likes.user.name"|"memberships"|"memberships.project"|"memberships.project.name"|"memberships.section"|"memberships.section.name"|"modified_at"|"name"|"notes"|"num_hearts"|"num_likes"|"num_subtasks"|"parent"|"parent.created_by"|"parent.name"|"parent.resource_subtype"|"permalink_url"|"projects"|"projects.name"|"resource_subtype"|"start_at"|"start_on"|"tags"|"tags.name"|"workspace"|"workspace.name")[]? (default ()) - This endpoint returns a compact 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.
Return Type
- Inline_response_200_40|error - Successfully retrieved the section's tasks.
get team_memberships/[string team_membership_gid]
function get team_memberships/[string team_membership_gid](boolean? opt_pretty, ("is_admin"|"is_guest"|"is_limited_access"|"team"|"team.name"|"user"|"user.name")[]? opt_fields) returns Inline_response_200_41|error
Get a team membership
Parameters
- opt_pretty boolean? (default ()) - 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 ("is_admin"|"is_guest"|"is_limited_access"|"team"|"team.name"|"user"|"user.name")[]? (default ()) - This endpoint returns a compact 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.
Return Type
- Inline_response_200_41|error - Successfully retrieved the requested team membership.
get team_memberships
function get team_memberships(boolean? opt_pretty, int? 'limit, string? offset, string? team, string? user, string? workspace, ("is_admin"|"is_guest"|"is_limited_access"|"offset"|"path"|"team"|"team.name"|"uri"|"user"|"user.name")[]? opt_fields) returns Inline_response_200_42|error
Get team memberships
Parameters
- opt_pretty boolean? (default ()) - 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.
- 'limit int? (default ()) - Results per page. The number of objects to return per page. The value must be between 1 and 100.
- offset string? (default ()) - Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.'
- team string? (default ()) - Globally unique identifier for the team.
- user string? (default ()) - A string identifying a user. This can either be the string "me", an email, or the gid of a user. This parameter must be used with the workspace parameter.
- workspace string? (default ()) - Globally unique identifier for the workspace. This parameter must be used with the user parameter.
- opt_fields ("is_admin"|"is_guest"|"is_limited_access"|"offset"|"path"|"team"|"team.name"|"uri"|"user"|"user.name")[]? (default ()) - This endpoint returns a compact 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.
Return Type
- Inline_response_200_42|error - Successfully retrieved the requested team memberships.
get teams/[string team_gid]/team_memberships
function get teams/[string team_gid]/team_memberships(boolean? opt_pretty, int? 'limit, string? offset, ("is_admin"|"is_guest"|"is_limited_access"|"offset"|"path"|"team"|"team.name"|"uri"|"user"|"user.name")[]? opt_fields) returns Inline_response_200_42|error
Get memberships from a team
Parameters
- opt_pretty boolean? (default ()) - 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.
- 'limit int? (default ()) - Results per page. The number of objects to return per page. The value must be between 1 and 100.
- offset string? (default ()) - Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.'
- opt_fields ("is_admin"|"is_guest"|"is_limited_access"|"offset"|"path"|"team"|"team.name"|"uri"|"user"|"user.name")[]? (default ()) - This endpoint returns a compact 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.
Return Type
- Inline_response_200_42|error - Successfully retrieved the requested team's memberships.
get users/[string user_gid]/team_memberships
function get users/[string user_gid]/team_memberships(string workspace, boolean? opt_pretty, int? 'limit, string? offset, ("is_admin"|"is_guest"|"is_limited_access"|"offset"|"path"|"team"|"team.name"|"uri"|"user"|"user.name")[]? opt_fields) returns Inline_response_200_42|error
Get memberships from a user
Parameters
- workspace string - Globally unique identifier for the workspace.
- opt_pretty boolean? (default ()) - 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.
- 'limit int? (default ()) - Results per page. The number of objects to return per page. The value must be between 1 and 100.
- offset string? (default ()) - Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.'
- opt_fields ("is_admin"|"is_guest"|"is_limited_access"|"offset"|"path"|"team"|"team.name"|"uri"|"user"|"user.name")[]? (default ()) - This endpoint returns a compact 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.
Return Type
- Inline_response_200_42|error - Successfully retrieved the requested users's memberships.
post teams
function post teams(Teams_body payload, boolean? opt_pretty, ("description"|"edit_team_name_or_description_access_level"|"edit_team_visibility_or_trash_team_access_level"|"guest_invite_management_access_level"|"html_description"|"join_request_management_access_level"|"member_invite_management_access_level"|"name"|"organization"|"organization.name"|"permalink_url"|"team_member_removal_access_level"|"visibility")[]? opt_fields) returns Inline_response_201_8|error
Create a team
Parameters
- payload Teams_body - The team to create.
- opt_pretty boolean? (default ()) - 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 ("description"|"edit_team_name_or_description_access_level"|"edit_team_visibility_or_trash_team_access_level"|"guest_invite_management_access_level"|"html_description"|"join_request_management_access_level"|"member_invite_management_access_level"|"name"|"organization"|"organization.name"|"permalink_url"|"team_member_removal_access_level"|"visibility")[]? (default ()) - This endpoint returns a compact 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.
Return Type
- Inline_response_201_8|error - Successfully created a new team.
get teams/[string team_gid]
function get teams/[string team_gid](boolean? opt_pretty, ("description"|"edit_team_name_or_description_access_level"|"edit_team_visibility_or_trash_team_access_level"|"guest_invite_management_access_level"|"html_description"|"join_request_management_access_level"|"member_invite_management_access_level"|"name"|"organization"|"organization.name"|"permalink_url"|"team_member_removal_access_level"|"visibility")[]? opt_fields) returns Inline_response_201_8|error
Get a team
Parameters
- opt_pretty boolean? (default ()) - 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 ("description"|"edit_team_name_or_description_access_level"|"edit_team_visibility_or_trash_team_access_level"|"guest_invite_management_access_level"|"html_description"|"join_request_management_access_level"|"member_invite_management_access_level"|"name"|"organization"|"organization.name"|"permalink_url"|"team_member_removal_access_level"|"visibility")[]? (default ()) - This endpoint returns a compact 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.
Return Type
- Inline_response_201_8|error - Successfully retrieved the record for a single team.
put teams/[string team_gid]
function put teams/[string team_gid](Teams_team_gid_body payload, boolean? opt_pretty, ("description"|"edit_team_name_or_description_access_level"|"edit_team_visibility_or_trash_team_access_level"|"guest_invite_management_access_level"|"html_description"|"join_request_management_access_level"|"member_invite_management_access_level"|"name"|"organization"|"organization.name"|"permalink_url"|"team_member_removal_access_level"|"visibility")[]? opt_fields) returns Inline_response_201_8|error
Update a team
Parameters
- payload Teams_team_gid_body - The team to update.
- opt_pretty boolean? (default ()) - 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 ("description"|"edit_team_name_or_description_access_level"|"edit_team_visibility_or_trash_team_access_level"|"guest_invite_management_access_level"|"html_description"|"join_request_management_access_level"|"member_invite_management_access_level"|"name"|"organization"|"organization.name"|"permalink_url"|"team_member_removal_access_level"|"visibility")[]? (default ()) - This endpoint returns a compact 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.
Return Type
- Inline_response_201_8|error - Successfully updated the team.
get workspaces/[string workspace_gid]/teams
function get workspaces/[string workspace_gid]/teams(boolean? opt_pretty, int? 'limit, string? offset, ("description"|"edit_team_name_or_description_access_level"|"edit_team_visibility_or_trash_team_access_level"|"guest_invite_management_access_level"|"html_description"|"join_request_management_access_level"|"member_invite_management_access_level"|"name"|"offset"|"organization"|"organization.name"|"path"|"permalink_url"|"team_member_removal_access_level"|"uri"|"visibility")[]? opt_fields) returns Inline_response_200_43|error
Get teams in a workspace
Parameters
- opt_pretty boolean? (default ()) - 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.
- 'limit int? (default ()) - Results per page. The number of objects to return per page. The value must be between 1 and 100.
- offset string? (default ()) - Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.'
- opt_fields ("description"|"edit_team_name_or_description_access_level"|"edit_team_visibility_or_trash_team_access_level"|"guest_invite_management_access_level"|"html_description"|"join_request_management_access_level"|"member_invite_management_access_level"|"name"|"offset"|"organization"|"organization.name"|"path"|"permalink_url"|"team_member_removal_access_level"|"uri"|"visibility")[]? (default ()) - This endpoint returns a compact 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.
Return Type
- Inline_response_200_43|error - Returns the team records for all teams in the organization or workspace accessible to the authenticated user.
get users/[string user_gid]/teams
function get users/[string user_gid]/teams(string organization, boolean? opt_pretty, int? 'limit, string? offset, ("description"|"edit_team_name_or_description_access_level"|"edit_team_visibility_or_trash_team_access_level"|"guest_invite_management_access_level"|"html_description"|"join_request_management_access_level"|"member_invite_management_access_level"|"name"|"offset"|"organization"|"organization.name"|"path"|"permalink_url"|"team_member_removal_access_level"|"uri"|"visibility")[]? opt_fields) returns Inline_response_200_43|error
Get teams for a user
Parameters
- organization string - The workspace or organization to filter teams on.
- opt_pretty boolean? (default ()) - 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.
- 'limit int? (default ()) - Results per page. The number of objects to return per page. The value must be between 1 and 100.
- offset string? (default ()) - Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.'
- opt_fields ("description"|"edit_team_name_or_description_access_level"|"edit_team_visibility_or_trash_team_access_level"|"guest_invite_management_access_level"|"html_description"|"join_request_management_access_level"|"member_invite_management_access_level"|"name"|"offset"|"organization"|"organization.name"|"path"|"permalink_url"|"team_member_removal_access_level"|"uri"|"visibility")[]? (default ()) - This endpoint returns a compact 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.
Return Type
- Inline_response_200_43|error - Returns the team records for all teams in the organization or workspace to which the given user is assigned.
post teams/[string team_gid]/addUser
function post teams/[string team_gid]/addUser(Team_gid_addUser_body payload, boolean? opt_pretty, ("is_admin"|"is_guest"|"is_limited_access"|"team"|"team.name"|"user"|"user.name")[]? opt_fields) returns Inline_response_200_41|error
Add a user to a team
Parameters
- payload Team_gid_addUser_body - The user to add to the team.
- opt_pretty boolean? (default ()) - 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 ("is_admin"|"is_guest"|"is_limited_access"|"team"|"team.name"|"user"|"user.name")[]? (default ()) - This endpoint returns a compact 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.
Return Type
- Inline_response_200_41|error - Successfully added user to the team.
post teams/[string team_gid]/removeUser
function post teams/[string team_gid]/removeUser(Team_gid_removeUser_body payload, boolean? opt_pretty) returns Inline_response_200_1|error
Remove a user from a team
Parameters
- payload Team_gid_removeUser_body - The user to remove from the team.
- opt_pretty boolean? (default ()) - 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.
Return Type
- Inline_response_200_1|error - Returns an empty data record
get time_periods/[string time_period_gid]
function get time_periods/[string time_period_gid](boolean? opt_pretty, ("display_name"|"end_on"|"parent"|"parent.display_name"|"parent.end_on"|"parent.period"|"parent.start_on"|"period"|"start_on")[]? opt_fields) returns Inline_response_200_44|error
Get a time period
Parameters
- opt_pretty boolean? (default ()) - 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 ("display_name"|"end_on"|"parent"|"parent.display_name"|"parent.end_on"|"parent.period"|"parent.start_on"|"period"|"start_on")[]? (default ()) - This endpoint returns a compact 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.
Return Type
- Inline_response_200_44|error - Successfully retrieved the record for a single time period.
get time_periods
function get time_periods(string workspace, boolean? opt_pretty, int? 'limit, string? offset, string? start_on, string? end_on, ("display_name"|"end_on"|"offset"|"parent"|"parent.display_name"|"parent.end_on"|"parent.period"|"parent.start_on"|"path"|"period"|"start_on"|"uri")[]? opt_fields) returns Inline_response_200_45|error
Get time periods
Parameters
- workspace string - Globally unique identifier for the workspace.
- opt_pretty boolean? (default ()) - 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.
- 'limit int? (default ()) - Results per page. The number of objects to return per page. The value must be between 1 and 100.
- offset string? (default ()) - Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.'
- start_on string? (default ()) - ISO 8601 date string
- end_on string? (default ()) - ISO 8601 date string
- opt_fields ("display_name"|"end_on"|"offset"|"parent"|"parent.display_name"|"parent.end_on"|"parent.period"|"parent.start_on"|"path"|"period"|"start_on"|"uri")[]? (default ()) - This endpoint returns a compact 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.
Return Type
- Inline_response_200_45|error - Successfully retrieved the requested time periods.
get tasks/[string task_gid]/time_tracking_entries
function get tasks/[string task_gid]/time_tracking_entries(boolean? opt_pretty, int? 'limit, string? offset, ("created_by"|"created_by.name"|"duration_minutes"|"entered_on"|"offset"|"path"|"uri")[]? opt_fields) returns Inline_response_200_46|error
Get time tracking entries for a task
Parameters
- opt_pretty boolean? (default ()) - 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.
- 'limit int? (default ()) - Results per page. The number of objects to return per page. The value must be between 1 and 100.
- offset string? (default ()) - Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.'
- opt_fields ("created_by"|"created_by.name"|"duration_minutes"|"entered_on"|"offset"|"path"|"uri")[]? (default ()) - This endpoint returns a compact 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.
Return Type
- Inline_response_200_46|error - Successfully retrieved the requested time tracking entries.
post tasks/[string task_gid]/time_tracking_entries
function post tasks/[string task_gid]/time_tracking_entries(Task_gid_time_tracking_entries_body payload, boolean? opt_pretty, ("created_at"|"created_by"|"created_by.name"|"duration_minutes"|"entered_on"|"task"|"task.created_by"|"task.name"|"task.resource_subtype")[]? opt_fields) returns Inline_response_201_9|error
Create a time tracking entry
Parameters
- payload Task_gid_time_tracking_entries_body - Information about the time tracking entry.
- opt_pretty boolean? (default ()) - 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 ("created_at"|"created_by"|"created_by.name"|"duration_minutes"|"entered_on"|"task"|"task.created_by"|"task.name"|"task.resource_subtype")[]? (default ()) - This endpoint returns a compact 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.
Return Type
- Inline_response_201_9|error - Successfully created a time tracking entry for the task.
get time_tracking_entries/[string time_tracking_entry_gid]
function get time_tracking_entries/[string time_tracking_entry_gid](boolean? opt_pretty, ("created_at"|"created_by"|"created_by.name"|"duration_minutes"|"entered_on"|"task"|"task.created_by"|"task.name"|"task.resource_subtype")[]? opt_fields) returns Inline_response_201_9|error
Get a time tracking entry
Parameters
- opt_pretty boolean? (default ()) - 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 ("created_at"|"created_by"|"created_by.name"|"duration_minutes"|"entered_on"|"task"|"task.created_by"|"task.name"|"task.resource_subtype")[]? (default ()) - This endpoint returns a compact 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.
Return Type
- Inline_response_201_9|error - Successfully retrieved the requested time tracking entry.
put time_tracking_entries/[string time_tracking_entry_gid]
function put time_tracking_entries/[string time_tracking_entry_gid](Time_tracking_entries_time_tracking_entry_gid_body payload, boolean? opt_pretty, ("created_at"|"created_by"|"created_by.name"|"duration_minutes"|"entered_on"|"task"|"task.created_by"|"task.name"|"task.resource_subtype")[]? opt_fields) returns Inline_response_201_9|error
Update a time tracking entry
Parameters
- payload Time_tracking_entries_time_tracking_entry_gid_body - The updated fields for the time tracking entry.
- opt_pretty boolean? (default ()) - 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 ("created_at"|"created_by"|"created_by.name"|"duration_minutes"|"entered_on"|"task"|"task.created_by"|"task.name"|"task.resource_subtype")[]? (default ()) - This endpoint returns a compact 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.
Return Type
- Inline_response_201_9|error - Successfully updated the time tracking entry.
delete time_tracking_entries/[string time_tracking_entry_gid]
function delete time_tracking_entries/[string time_tracking_entry_gid](boolean? opt_pretty) returns Inline_response_200_1|error
Delete a time tracking entry
Parameters
- opt_pretty boolean? (default ()) - 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.
Return Type
- Inline_response_200_1|error - Successfully deleted the specified time tracking entry.
get workspaces/[string workspace_gid]/typeahead
function get workspaces/[string workspace_gid]/typeahead("custom_field"|"goal"|"project"|"project_template"|"portfolio"|"tag"|"task"|"team"|"user" resource_type, "custom_field"|"portfolio"|"project"|"tag"|"task"|"user" 'type, string? query, int? count, boolean? opt_pretty, ("name")[]? opt_fields) returns Inline_response_200_47|error
Get objects via typeahead
Parameters
- resource_type "custom_field"|"goal"|"project"|"project_template"|"portfolio"|"tag"|"task"|"team"|"user" - The type of values the typeahead should return. You can choose from one of the following:
custom_field
,goal
,project
,project_template
,portfolio
,tag
,task
,team
, anduser
. Note that unlike in the names of endpoints, the types listed here are in singular form (e.g.task
). Using multiple types is not yet supported.
- 'type "custom_field"|"portfolio"|"project"|"tag"|"task"|"user" (default "user") - Deprecated: new integrations should prefer the resource_type field.
- query string? (default ()) - The string that will be used to search for relevant objects. If an empty string is passed in, the API will return results.
- count int? (default ()) - The number of results to return. The default is 20 if this parameter is omitted, with a minimum of 1 and a maximum of 100. If there are fewer results found than requested, all will be returned.
- opt_pretty boolean? (default ()) - 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 ("name")[]? (default ()) - This endpoint returns a compact 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.
Return Type
- Inline_response_200_47|error - Successfully retrieved objects via a typeahead search algorithm.
get user_task_lists/[string user_task_list_gid]
function get user_task_lists/[string user_task_list_gid](boolean? opt_pretty, ("name"|"owner"|"workspace")[]? opt_fields) returns Inline_response_200_48|error
Get a user task list
Parameters
- opt_pretty boolean? (default ()) - 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 ("name"|"owner"|"workspace")[]? (default ()) - This endpoint returns a compact 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.
Return Type
- Inline_response_200_48|error - Successfully retrieved the user task list.
get users/[string user_gid]/user_task_list
function get users/[string user_gid]/user_task_list(string workspace, boolean? opt_pretty, ("name"|"owner"|"workspace")[]? opt_fields) returns Inline_response_200_48|error
Get a user's task list
Parameters
- workspace string - The workspace in which to get the user task list.
- opt_pretty boolean? (default ()) - 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 ("name"|"owner"|"workspace")[]? (default ()) - This endpoint returns a compact 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.
Return Type
- Inline_response_200_48|error - Successfully retrieved the user's task list.
get users
function get users(string? workspace, string? team, boolean? opt_pretty, int? 'limit, string? offset, ("email"|"name"|"offset"|"path"|"photo"|"photo.image_1024x1024"|"photo.image_128x128"|"photo.image_21x21"|"photo.image_27x27"|"photo.image_36x36"|"photo.image_60x60"|"uri"|"workspaces"|"workspaces.name")[]? opt_fields) returns Inline_response_200_49|error
Get multiple users
Parameters
- workspace string? (default ()) - The workspace or organization ID to filter users on.
- team string? (default ()) - The team ID to filter users on.
- opt_pretty boolean? (default ()) - 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.
- 'limit int? (default ()) - Results per page. The number of objects to return per page. The value must be between 1 and 100.
- offset string? (default ()) - Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.'
- opt_fields ("email"|"name"|"offset"|"path"|"photo"|"photo.image_1024x1024"|"photo.image_128x128"|"photo.image_21x21"|"photo.image_27x27"|"photo.image_36x36"|"photo.image_60x60"|"uri"|"workspaces"|"workspaces.name")[]? (default ()) - This endpoint returns a compact 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.
Return Type
- Inline_response_200_49|error - Successfully retrieved the requested user records.
get users/[string user_gid]
function get users/[string user_gid](boolean? opt_pretty, ("email"|"name"|"photo"|"photo.image_1024x1024"|"photo.image_128x128"|"photo.image_21x21"|"photo.image_27x27"|"photo.image_36x36"|"photo.image_60x60"|"workspaces"|"workspaces.name")[]? opt_fields) returns Inline_response_200_50|error
Get a user
Parameters
- opt_pretty boolean? (default ()) - 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 ("email"|"name"|"photo"|"photo.image_1024x1024"|"photo.image_128x128"|"photo.image_21x21"|"photo.image_27x27"|"photo.image_36x36"|"photo.image_60x60"|"workspaces"|"workspaces.name")[]? (default ()) - This endpoint returns a compact 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.
Return Type
- Inline_response_200_50|error - Returns the user specified.
get users/[string user_gid]/favorites
function get users/[string user_gid]/favorites("portfolio"|"project"|"tag"|"task"|"user"|"project_template" resource_type, string workspace, boolean? opt_pretty, int? 'limit, string? offset, ("name"|"offset"|"path"|"uri")[]? opt_fields) returns Inline_response_200_51|error
Get a user's favorites
Parameters
- resource_type "portfolio"|"project"|"tag"|"task"|"user"|"project_template" - The resource type of favorites to be returned.
- workspace string - The workspace in which to get favorites.
- opt_pretty boolean? (default ()) - 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.
- 'limit int? (default ()) - Results per page. The number of objects to return per page. The value must be between 1 and 100.
- offset string? (default ()) - Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.'
- opt_fields ("name"|"offset"|"path"|"uri")[]? (default ()) - This endpoint returns a compact 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.
Return Type
- Inline_response_200_51|error - Returns the specified user's favorites.
get teams/[string team_gid]/users
function get teams/[string team_gid]/users(boolean? opt_pretty, string? offset, ("email"|"name"|"photo"|"photo.image_1024x1024"|"photo.image_128x128"|"photo.image_21x21"|"photo.image_27x27"|"photo.image_36x36"|"photo.image_60x60"|"workspaces"|"workspaces.name")[]? opt_fields) returns Inline_response_200_52|error
Get users in a team
Parameters
- opt_pretty boolean? (default ()) - 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.
- offset string? (default ()) - Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.'
- opt_fields ("email"|"name"|"photo"|"photo.image_1024x1024"|"photo.image_128x128"|"photo.image_21x21"|"photo.image_27x27"|"photo.image_36x36"|"photo.image_60x60"|"workspaces"|"workspaces.name")[]? (default ()) - This endpoint returns a compact 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.
Return Type
- Inline_response_200_52|error - Returns the user records for all the members of the team, including guests and limited access users
get workspaces/[string workspace_gid]/users
function get workspaces/[string workspace_gid]/users(boolean? opt_pretty, string? offset, ("email"|"name"|"photo"|"photo.image_1024x1024"|"photo.image_128x128"|"photo.image_21x21"|"photo.image_27x27"|"photo.image_36x36"|"photo.image_60x60"|"workspaces"|"workspaces.name")[]? opt_fields) returns Inline_response_200_52|error
Get users in a workspace or organization
Parameters
- opt_pretty boolean? (default ()) - 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.
- offset string? (default ()) - Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.'
- opt_fields ("email"|"name"|"photo"|"photo.image_1024x1024"|"photo.image_128x128"|"photo.image_21x21"|"photo.image_27x27"|"photo.image_36x36"|"photo.image_60x60"|"workspaces"|"workspaces.name")[]? (default ()) - This endpoint returns a compact 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.
Return Type
- Inline_response_200_52|error - Return the users in the specified workspace or org.
get webhooks
function get webhooks(string workspace, boolean? opt_pretty, int? 'limit, string? offset, string? 'resource, ("active"|"created_at"|"filters"|"filters.action"|"filters.fields"|"filters.resource_subtype"|"last_failure_at"|"last_failure_content"|"last_success_at"|"offset"|"path"|"resource"|"resource.name"|"target"|"uri")[]? opt_fields) returns Inline_response_200_53|error
Get multiple webhooks
Parameters
- workspace string - The workspace to query for webhooks in.
- opt_pretty boolean? (default ()) - 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.
- 'limit int? (default ()) - Results per page. The number of objects to return per page. The value must be between 1 and 100.
- offset string? (default ()) - Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.'
- 'resource string? (default ()) - Only return webhooks for the given resource.
- opt_fields ("active"|"created_at"|"filters"|"filters.action"|"filters.fields"|"filters.resource_subtype"|"last_failure_at"|"last_failure_content"|"last_success_at"|"offset"|"path"|"resource"|"resource.name"|"target"|"uri")[]? (default ()) - This endpoint returns a compact 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.
Return Type
- Inline_response_200_53|error - Successfully retrieved the requested webhooks.
post webhooks
function post webhooks(Webhooks_body payload, boolean? opt_pretty, ("active"|"created_at"|"filters"|"filters.action"|"filters.fields"|"filters.resource_subtype"|"last_failure_at"|"last_failure_content"|"last_success_at"|"resource"|"resource.name"|"target")[]? opt_fields) returns Inline_response_201_10|error
Establish a webhook
Parameters
- payload Webhooks_body - The webhook workspace and target.
- opt_pretty boolean? (default ()) - 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 ("active"|"created_at"|"filters"|"filters.action"|"filters.fields"|"filters.resource_subtype"|"last_failure_at"|"last_failure_content"|"last_success_at"|"resource"|"resource.name"|"target")[]? (default ()) - This endpoint returns a compact 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.
Return Type
- Inline_response_201_10|error - Successfully created the requested webhook.
get webhooks/[string webhook_gid]
function get webhooks/[string webhook_gid](boolean? opt_pretty, ("active"|"created_at"|"filters"|"filters.action"|"filters.fields"|"filters.resource_subtype"|"last_failure_at"|"last_failure_content"|"last_success_at"|"resource"|"resource.name"|"target")[]? opt_fields) returns Inline_response_201_10|error
Get a webhook
Parameters
- opt_pretty boolean? (default ()) - 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 ("active"|"created_at"|"filters"|"filters.action"|"filters.fields"|"filters.resource_subtype"|"last_failure_at"|"last_failure_content"|"last_success_at"|"resource"|"resource.name"|"target")[]? (default ()) - This endpoint returns a compact 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.
Return Type
- Inline_response_201_10|error - Successfully retrieved the requested webhook.
put webhooks/[string webhook_gid]
function put webhooks/[string webhook_gid](Webhooks_webhook_gid_body payload, boolean? opt_pretty, ("active"|"created_at"|"filters"|"filters.action"|"filters.fields"|"filters.resource_subtype"|"last_failure_at"|"last_failure_content"|"last_success_at"|"resource"|"resource.name"|"target")[]? opt_fields) returns Inline_response_201_10|error
Update a webhook
Parameters
- payload Webhooks_webhook_gid_body - The updated filters for the webhook.
- opt_pretty boolean? (default ()) - 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 ("active"|"created_at"|"filters"|"filters.action"|"filters.fields"|"filters.resource_subtype"|"last_failure_at"|"last_failure_content"|"last_success_at"|"resource"|"resource.name"|"target")[]? (default ()) - This endpoint returns a compact 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.
Return Type
- Inline_response_201_10|error - Successfully updated the webhook.
delete webhooks/[string webhook_gid]
function delete webhooks/[string webhook_gid](boolean? opt_pretty) returns Inline_response_200_1|error
Delete a webhook
Parameters
- opt_pretty boolean? (default ()) - 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.
Return Type
- Inline_response_200_1|error - Successfully retrieved the requested webhook.
get workspace_memberships/[string workspace_membership_gid]
function get workspace_memberships/[string workspace_membership_gid](boolean? opt_pretty, ("created_at"|"is_active"|"is_admin"|"is_guest"|"user"|"user.name"|"user_task_list"|"user_task_list.name"|"user_task_list.owner"|"user_task_list.workspace"|"vacation_dates"|"vacation_dates.end_on"|"vacation_dates.start_on"|"workspace"|"workspace.name")[]? opt_fields) returns Inline_response_200_54|error
Get a workspace membership
Parameters
- opt_pretty boolean? (default ()) - 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 ("created_at"|"is_active"|"is_admin"|"is_guest"|"user"|"user.name"|"user_task_list"|"user_task_list.name"|"user_task_list.owner"|"user_task_list.workspace"|"vacation_dates"|"vacation_dates.end_on"|"vacation_dates.start_on"|"workspace"|"workspace.name")[]? (default ()) - This endpoint returns a compact 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.
Return Type
- Inline_response_200_54|error - Successfully retrieved the requested workspace membership.
get users/[string user_gid]/workspace_memberships
function get users/[string user_gid]/workspace_memberships(boolean? opt_pretty, int? 'limit, string? offset, ("created_at"|"is_active"|"is_admin"|"is_guest"|"offset"|"path"|"uri"|"user"|"user.name"|"user_task_list"|"user_task_list.name"|"user_task_list.owner"|"user_task_list.workspace"|"vacation_dates"|"vacation_dates.end_on"|"vacation_dates.start_on"|"workspace"|"workspace.name")[]? opt_fields) returns Inline_response_200_55|error
Get workspace memberships for a user
Parameters
- opt_pretty boolean? (default ()) - 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.
- 'limit int? (default ()) - Results per page. The number of objects to return per page. The value must be between 1 and 100.
- offset string? (default ()) - Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.'
- opt_fields ("created_at"|"is_active"|"is_admin"|"is_guest"|"offset"|"path"|"uri"|"user"|"user.name"|"user_task_list"|"user_task_list.name"|"user_task_list.owner"|"user_task_list.workspace"|"vacation_dates"|"vacation_dates.end_on"|"vacation_dates.start_on"|"workspace"|"workspace.name")[]? (default ()) - This endpoint returns a compact 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.
Return Type
- Inline_response_200_55|error - Successfully retrieved the requested user's workspace memberships.
get workspaces/[string workspace_gid]/workspace_memberships
function get workspaces/[string workspace_gid]/workspace_memberships(string? user, boolean? opt_pretty, int? 'limit, string? offset, ("created_at"|"is_active"|"is_admin"|"is_guest"|"offset"|"path"|"uri"|"user"|"user.name"|"user_task_list"|"user_task_list.name"|"user_task_list.owner"|"user_task_list.workspace"|"vacation_dates"|"vacation_dates.end_on"|"vacation_dates.start_on"|"workspace"|"workspace.name")[]? opt_fields) returns Inline_response_200_55|error
Get the workspace memberships for a workspace
Parameters
- user string? (default ()) - A string identifying a user. This can either be the string "me", an email, or the gid of a user.
- opt_pretty boolean? (default ()) - 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.
- 'limit int? (default ()) - Results per page. The number of objects to return per page. The value must be between 1 and 100.
- offset string? (default ()) - Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.'
- opt_fields ("created_at"|"is_active"|"is_admin"|"is_guest"|"offset"|"path"|"uri"|"user"|"user.name"|"user_task_list"|"user_task_list.name"|"user_task_list.owner"|"user_task_list.workspace"|"vacation_dates"|"vacation_dates.end_on"|"vacation_dates.start_on"|"workspace"|"workspace.name")[]? (default ()) - This endpoint returns a compact 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.
Return Type
- Inline_response_200_55|error - Successfully retrieved the requested workspace's memberships.
get workspaces
function get workspaces(boolean? opt_pretty, int? 'limit, string? offset, ("email_domains"|"is_organization"|"name"|"offset"|"path"|"uri")[]? opt_fields) returns Inline_response_200_56|error
Get multiple workspaces
Parameters
- opt_pretty boolean? (default ()) - 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.
- 'limit int? (default ()) - Results per page. The number of objects to return per page. The value must be between 1 and 100.
- offset string? (default ()) - Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.'
- opt_fields ("email_domains"|"is_organization"|"name"|"offset"|"path"|"uri")[]? (default ()) - This endpoint returns a compact 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.
Return Type
- Inline_response_200_56|error - Return all workspaces visible to the authorized user.
get workspaces/[string workspace_gid]
function get workspaces/[string workspace_gid](boolean? opt_pretty, ("email_domains"|"is_organization"|"name")[]? opt_fields) returns Inline_response_200_57|error
Get a workspace
Parameters
- opt_pretty boolean? (default ()) - 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 ("email_domains"|"is_organization"|"name")[]? (default ()) - This endpoint returns a compact 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.
Return Type
- Inline_response_200_57|error - Return the full workspace record.
put workspaces/[string workspace_gid]
function put workspaces/[string workspace_gid](Workspaces_workspace_gid_body payload, boolean? opt_pretty, ("email_domains"|"is_organization"|"name")[]? opt_fields) returns Inline_response_200_57|error
Update a workspace
Parameters
- payload Workspaces_workspace_gid_body - The workspace object with all updated properties.
- opt_pretty boolean? (default ()) - 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 ("email_domains"|"is_organization"|"name")[]? (default ()) - This endpoint returns a compact 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.
Return Type
- Inline_response_200_57|error - Update for the workspace was successful.
post workspaces/[string workspace_gid]/addUser
function post workspaces/[string workspace_gid]/addUser(Workspace_gid_addUser_body payload, boolean? opt_pretty, ("email"|"name"|"photo"|"photo.image_1024x1024"|"photo.image_128x128"|"photo.image_21x21"|"photo.image_27x27"|"photo.image_36x36"|"photo.image_60x60")[]? opt_fields) returns Inline_response_200_58|error
Add a user to a workspace or organization
Parameters
- payload Workspace_gid_addUser_body - The user to add to the workspace.
- opt_pretty boolean? (default ()) - 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 ("email"|"name"|"photo"|"photo.image_1024x1024"|"photo.image_128x128"|"photo.image_21x21"|"photo.image_27x27"|"photo.image_36x36"|"photo.image_60x60")[]? (default ()) - This endpoint returns a compact 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.
Return Type
- Inline_response_200_58|error - The user was added successfully to the workspace or organization.
post workspaces/[string workspace_gid]/removeUser
function post workspaces/[string workspace_gid]/removeUser(Workspace_gid_removeUser_body payload, boolean? opt_pretty) returns Inline_response_200_1|error
Remove a user from a workspace or organization
Parameters
- payload Workspace_gid_removeUser_body - The user to remove from the workspace.
- opt_pretty boolean? (default ()) - 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.
Return Type
- Inline_response_200_1|error - The user was removed successfully to the workspace or organization.
Records
asana: AddCustomFieldSettingRequest
Fields
- custom_field string - The custom field to associate with this container.
- is_important boolean? - Whether this field should be considered important to this container (for instance, to display in the list view of items in the container).
- insert_before string? - A gid of a Custom Field Setting on this container, before which the new Custom Field Setting will be added.
insert_before
andinsert_after
parameters cannot both be specified.
- insert_after string? - A gid of a Custom Field Setting on this container, after which the new Custom Field Setting will be added.
insert_before
andinsert_after
parameters cannot both be specified.
asana: AddFollowersRequest
Fields
- followers string - An array of strings identifying users. These can either be the string "me", an email, or the gid of a user.
asana: AddMembersRequest
Fields
- members string - An array of strings identifying users. These can either be the string "me", an email, or the gid of a user.
asana: AllocationBase
Fields
- Fields Included from *AsanaResource
- start_date string? - The localized day on which the allocation starts.
- end_date string? - The localized day on which the allocation ends.
asana: AllocationCompact
Fields
- Fields Included from *AllocationBase
- assignee UserCompact? -
- parent ProjectCompact? -
- effort EffortCompact? -
asana: AllocationRequest
Fields
- Fields Included from *AllocationBase
- assignee string? - Globally unique identifier for the user who is assigned to the allocation.
- parent string? - Globally unique identifier for the project the allocation is on.
- effort EffortCompact? -
asana: AllocationResponse
Fields
- Fields Included from *AllocationCompact
- assignee UserCompact
- parent ProjectCompact
- effort EffortCompact
- start_date string
- end_date string
- gid string
- resource_type string
- anydata...
- created_by UserCompact? -
- resource_subtype string? - The subtype of the allocation.
asana: AsanaNamedResource
Fields
- Fields Included from *AsanaResource
- name string? - The name of the object.
asana: AsanaResource
A generic Asana Resource, containing a globally unique identifier.
Fields
- gid string? - Globally unique identifier of the resource, as a string.
- resource_type string? - The base type of this resource.
asana: AttachmentCompact
Fields
- Fields Included from *AsanaResource
- name string? - The name of the file.
- resource_subtype string? - The service hosting the attachment. Valid values are
asana
,dropbox
,gdrive
,onedrive
,box
,vimeo
, andexternal
.
asana: AttachmentRequest
Fields
- resource_subtype "asana"|"dropbox"|"gdrive"|"onedrive"|"box"|"vimeo"|"external" ? - The type of the attachment. Must be one of the given values. If not specified, a file attachment of type
asana
will be assumed. Note that if the value ofresource_subtype
isexternal
, aparent
,name
, andurl
must also be provided.
- file record { fileContent byte[], fileName string }? - Required for
asana
attachments.
- parent string - Required identifier of the parent task, project, or project_brief, as a string.
- url string? - The URL of the external resource being attached. Required for attachments of type
external
.
- name string? - The name of the external resource being attached. Required for attachments of type
external
.
- connect_to_app boolean? - Optional. Only relevant for external attachments with a parent task. A boolean indicating whether the current app should be connected with the attachment for the purposes of showing an app components widget. Requires the app to have been added to a project the parent task is in.
asana: AttachmentResponse
Fields
- created_at string? - The time at which this resource was created.
- download_url string? - The URL containing the content of the attachment. Note: May be null if the attachment is hosted by Box and will be null if the attachment is a Video Message hosted by Vimeo. If present, this URL may only be valid for two minutes from the time of retrieval. You should avoid persisting this URL somewhere and just refresh it on demand to ensure you do not keep stale URLs.
- permanent_url string? -
- host string? - The service hosting the attachment. Valid values are
asana
,dropbox
,gdrive
,box
, andvimeo
.
- parent record { resource_subtype "default_task"|"milestone"|"section"|"approval" }? -
- size int? - The size of the attachment in bytes. Only present when the
resource_subtype
isasana
.
- view_url string? - The URL where the attachment can be viewed, which may be friendlier to users in a browser than just directing them to a raw file. May be null if no view URL exists for the service.
- connected_to_app boolean? - Whether the attachment is connected to the app making the request for the purposes of showing an app components widget. Only present when the
resource_subtype
isexternal
orgdrive
.
asana: AuditLogEvent
An object representing a single event within an Asana domain.
Every audit log event is comprised of an event_type
, actor
, resource
, and context
. Some events will include additional metadata about the event under details
. See our currently supported list of events for more details.
Fields
- gid string? - Globally unique identifier of the
AuditLogEvent
, as a string.
- created_at string? - The time the event was created.
- event_type string? - The type of the event.
- event_category string? - The category that this
event_type
belongs to.
- actor AuditLogEventActor? - The entity that triggered the event. Will typically be a user.
- 'resource AuditLogEventResource? - The primary object that was affected by this event.
- details AuditLogEventDetails? - Event specific details. The schema will vary depending on the
event_type
.
- context AuditLogEventContext? - The context from which this event originated.
asana: AuditLogEventActor
The entity that triggered the event. Will typically be a user.
Fields
- actor_type "user"|"asana"|"asana_support"|"anonymous"|"external_administrator" ? - The type of actor.
Can be one of
user
,asana
,asana_support
,anonymous
, orexternal_administrator
.
- gid string? - Globally unique identifier of the actor, if it is a user.
- name string? - The name of the actor, if it is a user.
- email string? - The email of the actor, if it is a user.
asana: AuditLogEventContext
The context from which this event originated.
Fields
- context_type "web"|"desktop"|"mobile"|"asana_support"|"asana"|"email"|"api" ? - The type of context.
Can be one of
web
,desktop
,mobile
,asana_support
,asana
,email
, orapi
.
- api_authentication_method "cookie"|"oauth"|"personal_access_token"|"service_account" ? - The authentication method used in the context of an API request.
Only present if the
context_type
isapi
. Can be one ofcookie
,oauth
,personal_access_token
, orservice_account
.
- client_ip_address string? - The IP address of the client that initiated the event, if applicable.
- user_agent string? - The user agent of the client that initiated the event, if applicable.
- oauth_app_name string? - The name of the OAuth App that initiated the event.
Only present if the
api_authentication_method
isoauth
.
asana: AuditLogEventDetails
Event specific details. The schema will vary depending on the event_type
.
asana: AuditLogEventResource
The primary object that was affected by this event.
Fields
- resource_type string? - The type of resource.
- resource_subtype string? - The subtype of resource. Most resources will not have a subtype.
- gid string? - Globally unique identifier of the resource.
- name string? - The name of the resource.
- email string? - The email of the resource, if applicable.
asana: Batch_body
Fields
- data BatchRequest? - A request object for use in a batch request.
asana: BatchRequest
A request object for use in a batch request.
Fields
- actions BatchRequestAction[]? -
asana: BatchRequestAction
An action object for use in a batch request.
Fields
- relative_path string - The path of the desired endpoint relative to the API’s base URL. Query parameters are not accepted here; put them in
data
instead.
- method "get"|"post"|"put"|"delete"|"patch"|"head" - The HTTP method you wish to emulate for the action.
- data record {}? - For
GET
requests, this should be a map of query parameters you would have normally passed in the URL. Options and pagination are not accepted here; put them inoptions
instead. ForPOST
,PATCH
, andPUT
methods, this should be the content you would have normally put in the data field of the body.
- options BatchRequestAction_options? - Pagination (
limit
andoffset
) and output options (fields
orexpand
) for the action. “Pretty” JSON output is not an available option on individual actions; if you want pretty output, specify that option on the parent request.
asana: BatchRequestAction_options
Pagination (limit
and offset
) and output options (fields
or expand
) for the action. “Pretty” JSON output is not an available option on individual actions; if you want pretty output, specify that option on the parent request.
Fields
- 'limit int? - Pagination limit for the request.
- offset int? - Pagination offset for the request.
- fields string[]? - The fields to retrieve in the request.
asana: BatchResponse
A response object returned from a batch request.
Fields
- status_code int? - The HTTP status code that the invoked endpoint returned.
- headers record {}? - A map of HTTP headers specific to this result. This is primarily used for returning a
Location
header to accompany a201 Created
result. The parent HTTP response will contain all common headers.
- body record {}? - The JSON body that the invoked endpoint returned.
asana: ClientHttp1Settings
Provides settings related to HTTP/1.x protocol.
Fields
- keepAlive KeepAlive(default http:KEEPALIVE_AUTO) - Specifies whether to reuse a connection for multiple requests
- chunking Chunking(default http:CHUNKING_AUTO) - The chunking behaviour of the request
- proxy ProxyConfig? - Proxy server related options
asana: ConnectionConfig
Provides a set of configurations for controlling the behaviours when communicating with a remote HTTP endpoint.
Fields
- auth BearerTokenConfig|OAuth2RefreshTokenGrantConfig - Configurations related to client authentication
- httpVersion HttpVersion(default http:HTTP_2_0) - The HTTP version understood by the client
- http1Settings ClientHttp1Settings? - Configurations related to HTTP/1.x protocol
- http2Settings ClientHttp2Settings? - Configurations related to HTTP/2 protocol
- timeout decimal(default 60) - The maximum time to wait (in seconds) for a response before closing the connection
- forwarded string(default "disable") - The choice of setting
forwarded
/x-forwarded
header
- poolConfig PoolConfiguration? - Configurations associated with request pooling
- cache CacheConfig? - HTTP caching related configurations
- compression Compression(default http:COMPRESSION_AUTO) - Specifies the way of handling compression (
accept-encoding
) header
- circuitBreaker CircuitBreakerConfig? - Configurations associated with the behaviour of the Circuit Breaker
- retryConfig RetryConfig? - Configurations associated with retrying
- responseLimits ResponseLimitConfigs? - Configurations associated with inbound response size limits
- secureSocket ClientSecureSocket? - SSL/TLS-related options
- proxy ProxyConfig? - Proxy server related options
- validation boolean(default true) - Enables the inbound payload validation functionality which provided by the constraint package. Enabled by default
asana: CreateMembershipRequest
Fields
- Fields Included from *MembershipRequest
- is_active boolean
- anydata...
- member string? - The gid of the user or team.
- parent string? - The gid of the
goal
orproject
to add the member to.
- role string? - The role given to the member. Optional argument, will default to
commenter
for goals and the default project role for projects. Can beeditor
orcommenter
for goals. Can beadmin
,editor
orcommenter
for projects.
asana: CreateTimeTrackingEntryRequest
Fields
- duration_minutes int? - Time in minutes tracked by the entry. Must be greater than 0
- entered_on string? - Optional. The day that this entry is logged on. Defaults to today if not specified
asana: Custom_field_gid_enum_options_body
Fields
- data EnumOptionRequest? -
asana: Custom_fields_body
Fields
- data CustomFieldRequest? -
asana: Custom_fields_custom_field_gid_body
Fields
- data CustomFieldRequest? -
asana: CustomFieldBase
Fields
- Fields Included from *CustomFieldCompact
- name string
- resource_subtype "text"|"enum"|"multi_enum"|"number"|"date"|"people"
- type "text"|"enum"|"multi_enum"|"number"|"date"|"people"
- enum_options EnumOption[]
- enabled boolean
- representation_type "text"|"enum"|"multi_enum"|"number"|"date"|"people"|"formula"|"custom_id"
- id_prefix string|()
- is_formula_field boolean
- date_value CustomFieldCompact_date_value|()
- enum_value record { name string, enabled boolean, color string, gid string, resource_type string, anydata... }
- multi_enum_values EnumOption[]
- number_value decimal|()
- text_value string|()
- display_value string|()
- gid string
- resource_type string
- anydata...
- enum_options EnumOption[]? - Conditional. Only relevant for custom fields of type
enum
. This array specifies the possible values which anenum
custom field can adopt. To modify the enum options, refer to working with enum options.
- precision int? - Only relevant for custom fields of type ‘Number’. This field dictates the number of places after the decimal to round to, i.e. 0 is integer values, 1 rounds to the nearest tenth, and so on. Must be between 0 and 6, inclusive. For percentage format, this may be unintuitive, as a value of 0.25 has a precision of 0, while a value of 0.251 has a precision of 1. This is due to 0.25 being displayed as 25%. The identifier format will always have a precision of 0.
- format "currency"|"identifier"|"percentage"|"custom"|"duration"|"none" ? - The format of this custom field.
- currency_code string? - ISO 4217 currency code to format this custom field. This will be null if the
format
is notcurrency
.
- custom_label string? - This is the string that appears next to the custom field value. This will be null if the
format
is notcustom
.
- custom_label_position "prefix"|"suffix"?? - Only relevant for custom fields with
custom
format. This depicts where to place the custom label. This will be null if theformat
is notcustom
.
- is_global_to_workspace boolean? - This flag describes whether this custom field is available to every container in the workspace. Before project-specific custom fields, this field was always true.
- has_notifications_enabled boolean? - Conditional. This flag describes whether a follower of a task with this field should receive inbox notifications from changes to this field.
- asana_created_field "a_v_requirements"|"account_name"|"actionable"|"align_shipping_link"|"align_status"|"allotted_time"|"appointment"|"approval_stage"|"approved"|"article_series"|"board_committee"|"browser"|"campaign_audience"|"campaign_project_status"|"campaign_regions"|"channel_primary"|"client_topic_type"|"complete_by"|"contact"|"contact_email_address"|"content_channels"|"content_channels_needed"|"content_stage"|"content_type"|"contract"|"contract_status"|"cost"|"creation_stage"|"creative_channel"|"creative_needed"|"creative_needs"|"data_sensitivity"|"deal_size"|"delivery_appt"|"delivery_appt_date"|"department"|"department_responsible"|"design_request_needed"|"design_request_type"|"discussion_category"|"do_this_task"|"editorial_content_status"|"editorial_content_tag"|"editorial_content_type"|"effort"|"effort_level"|"est_completion_date"|"estimated_time"|"estimated_value"|"expected_cost"|"external_steps_needed"|"favorite_idea"|"feedback_type"|"financial"|"funding_amount"|"grant_application_process"|"hiring_candidate_status"|"idea_status"|"ids_link"|"ids_patient_link"|"implementation_stage"|"insurance"|"interview_area"|"interview_question_score"|"itero_scan_link"|"job_s_applied_to"|"lab"|"launch_status"|"lead_status"|"localization_language"|"localization_market_team"|"localization_status"|"meeting_minutes"|"meeting_needed"|"minutes"|"mrr"|"must_localize"|"name_of_foundation"|"need_to_follow_up"|"next_appointment"|"next_steps_sales"|"num_people"|"number_of_user_reports"|"office_location"|"onboarding_activity"|"owner"|"participants_needed"|"patient_date_of_birth"|"patient_email"|"patient_phone"|"patient_status"|"phone_number"|"planning_category"|"point_of_contact"|"position"|"post_format"|"prescription"|"priority"|"priority_level"|"product"|"product_stage"|"progress"|"project_size"|"project_status"|"proposed_budget"|"publish_status"|"reason_for_scan"|"referral"|"request_type"|"research_status"|"responsible_department"|"responsible_team"|"risk_assessment_status"|"room_name"|"sales_counterpart"|"sentiment"|"shipping_link"|"social_channels"|"stage"|"status"|"status_design"|"status_of_initiative"|"system_setup"|"task_progress"|"team"|"team_marketing"|"team_responsible"|"time_it_takes_to_complete_tasks"|"timeframe"|"treatment_type"|"type_work_requests_it"|"use_agency"|"user_name"|"vendor_category"|"vendor_type"|"word_count"?? - Conditional. A unique identifier to associate this field with the template source of truth.
asana: CustomFieldCompact
Fields
- Fields Included from *AsanaResource
- name string? - The name of the custom field.
- resource_subtype "text"|"enum"|"multi_enum"|"number"|"date"|"people" ? - The type of the custom field. Must be one of the given values.
- 'type "text"|"enum"|"multi_enum"|"number"|"date"|"people" ? - Deprecated: new integrations should prefer the resource_subtype field. The type of the custom field. Must be one of the given values.
- enum_options EnumOption[]? - Conditional. Only relevant for custom fields of type
enum
. This array specifies the possible values which anenum
custom field can adopt. To modify the enum options, refer to working with enum options.
- enabled boolean? - Conditional. Determines if the custom field is enabled or not.
- representation_type "text"|"enum"|"multi_enum"|"number"|"date"|"people"|"formula"|"custom_id" ? - This field tells the type of the custom field.
- id_prefix string? - This field is the unique custom ID string for the custom field.
- is_formula_field boolean? - Conditional. This flag describes whether a custom field is a formula custom field.
- date_value CustomFieldCompact_date_value? - Conditional. Only relevant for custom fields of type
date
. This object reflects the chosen date (and optionally, time) value of adate
custom field. If no date is selected, the value ofdate_value
will benull
.
- enum_value record {}? -
- multi_enum_values EnumOption[]? - Conditional. Only relevant for custom fields of type
multi_enum
. This object is the chosen values of amulti_enum
custom field.
- number_value decimal? - Conditional. This number is the value of a
number
custom field.
- text_value string? - Conditional. This string is the value of a
text
custom field.
- display_value string? - A string representation for the value of the custom field. Integrations that don't require the underlying type should use this field to read values. Using this field will future-proof an app against new custom field types.
asana: CustomFieldCompact_date_value
Conditional. Only relevant for custom fields of type date
. This object reflects the chosen date (and optionally, time) value of a date
custom field. If no date is selected, the value of date_value
will be null
.
Fields
- date string? - A string representing the date in YYYY-MM-DD format.
- date_time string? - A string representing the date in ISO 8601 format. If no time value is selected, the value of
date-time
will benull
.
asana: CustomFieldRequest
Fields
- Fields Included from *CustomFieldBase
- description string
- enum_options EnumOption[]
- precision int
- format "currency"|"identifier"|"percentage"|"custom"|"duration"|"none"
- currency_code string|()
- custom_label string|()
- custom_label_position "suffix"|()|"prefix"
- is_global_to_workspace boolean
- has_notifications_enabled boolean
- asana_created_field "word_count"|()|"a_v_requirements"|"account_name"|"actionable"|"align_shipping_link"|"align_status"|"allotted_time"|"appointment"|"approval_stage"|"approved"|"article_series"|"board_committee"|"browser"|"campaign_audience"|"campaign_project_status"|"campaign_regions"|"channel_primary"|"client_topic_type"|"complete_by"|"contact"|"contact_email_address"|"content_channels"|"content_channels_needed"|"content_stage"|"content_type"|"contract"|"contract_status"|"cost"|"creation_stage"|"creative_channel"|"creative_needed"|"creative_needs"|"data_sensitivity"|"deal_size"|"delivery_appt"|"delivery_appt_date"|"department"|"department_responsible"|"design_request_needed"|"design_request_type"|"discussion_category"|"do_this_task"|"editorial_content_status"|"editorial_content_tag"|"editorial_content_type"|"effort"|"effort_level"|"est_completion_date"|"estimated_time"|"estimated_value"|"expected_cost"|"external_steps_needed"|"favorite_idea"|"feedback_type"|"financial"|"funding_amount"|"grant_application_process"|"hiring_candidate_status"|"idea_status"|"ids_link"|"ids_patient_link"|"implementation_stage"|"insurance"|"interview_area"|"interview_question_score"|"itero_scan_link"|"job_s_applied_to"|"lab"|"launch_status"|"lead_status"|"localization_language"|"localization_market_team"|"localization_status"|"meeting_minutes"|"meeting_needed"|"minutes"|"mrr"|"must_localize"|"name_of_foundation"|"need_to_follow_up"|"next_appointment"|"next_steps_sales"|"num_people"|"number_of_user_reports"|"office_location"|"onboarding_activity"|"owner"|"participants_needed"|"patient_date_of_birth"|"patient_email"|"patient_phone"|"patient_status"|"phone_number"|"planning_category"|"point_of_contact"|"position"|"post_format"|"prescription"|"priority"|"priority_level"|"product"|"product_stage"|"progress"|"project_size"|"project_status"|"proposed_budget"|"publish_status"|"reason_for_scan"|"referral"|"request_type"|"research_status"|"responsible_department"|"responsible_team"|"risk_assessment_status"|"room_name"|"sales_counterpart"|"sentiment"|"shipping_link"|"social_channels"|"stage"|"status"|"status_design"|"status_of_initiative"|"system_setup"|"task_progress"|"team"|"team_marketing"|"team_responsible"|"time_it_takes_to_complete_tasks"|"timeframe"|"treatment_type"|"type_work_requests_it"|"use_agency"|"user_name"|"vendor_category"|"vendor_type"
- name string
- resource_subtype "text"|"enum"|"multi_enum"|"number"|"date"|"people"
- type "text"|"enum"|"multi_enum"|"number"|"date"|"people"
- enabled boolean
- representation_type "text"|"enum"|"multi_enum"|"number"|"date"|"people"|"formula"|"custom_id"
- id_prefix string|()
- is_formula_field boolean
- date_value CustomFieldCompact_date_value|()
- enum_value record { name string, enabled boolean, color string, gid string, resource_type string, anydata... }
- multi_enum_values EnumOption[]
- number_value decimal|()
- text_value string|()
- display_value string|()
- gid string
- resource_type string
- anydata...
- workspace string - Create-Only The workspace to create a custom field in.
- owned_by_app boolean? - Allow-listed. Instructs the API that this Custom Field is app-owned. This parameter is allow-listed to specific apps at this point in time. For apps that are not allow-listed, providing this parameter will result in a
403 Forbidden
.
- people_value string[]? - Conditional. Only relevant for custom fields of type
people
. This array of user GIDs reflects the users to be written to apeople
custom field. Note that write operations will replace existing users (if any) in the custom field with the users specified in this array.
asana: CustomFieldResponse
Fields
- Fields Included from *CustomFieldBase
- description string
- enum_options EnumOption[]
- precision int
- format "currency"|"identifier"|"percentage"|"custom"|"duration"|"none"
- currency_code string|()
- custom_label string|()
- custom_label_position "suffix"|()|"prefix"
- is_global_to_workspace boolean
- has_notifications_enabled boolean
- asana_created_field "word_count"|()|"a_v_requirements"|"account_name"|"actionable"|"align_shipping_link"|"align_status"|"allotted_time"|"appointment"|"approval_stage"|"approved"|"article_series"|"board_committee"|"browser"|"campaign_audience"|"campaign_project_status"|"campaign_regions"|"channel_primary"|"client_topic_type"|"complete_by"|"contact"|"contact_email_address"|"content_channels"|"content_channels_needed"|"content_stage"|"content_type"|"contract"|"contract_status"|"cost"|"creation_stage"|"creative_channel"|"creative_needed"|"creative_needs"|"data_sensitivity"|"deal_size"|"delivery_appt"|"delivery_appt_date"|"department"|"department_responsible"|"design_request_needed"|"design_request_type"|"discussion_category"|"do_this_task"|"editorial_content_status"|"editorial_content_tag"|"editorial_content_type"|"effort"|"effort_level"|"est_completion_date"|"estimated_time"|"estimated_value"|"expected_cost"|"external_steps_needed"|"favorite_idea"|"feedback_type"|"financial"|"funding_amount"|"grant_application_process"|"hiring_candidate_status"|"idea_status"|"ids_link"|"ids_patient_link"|"implementation_stage"|"insurance"|"interview_area"|"interview_question_score"|"itero_scan_link"|"job_s_applied_to"|"lab"|"launch_status"|"lead_status"|"localization_language"|"localization_market_team"|"localization_status"|"meeting_minutes"|"meeting_needed"|"minutes"|"mrr"|"must_localize"|"name_of_foundation"|"need_to_follow_up"|"next_appointment"|"next_steps_sales"|"num_people"|"number_of_user_reports"|"office_location"|"onboarding_activity"|"owner"|"participants_needed"|"patient_date_of_birth"|"patient_email"|"patient_phone"|"patient_status"|"phone_number"|"planning_category"|"point_of_contact"|"position"|"post_format"|"prescription"|"priority"|"priority_level"|"product"|"product_stage"|"progress"|"project_size"|"project_status"|"proposed_budget"|"publish_status"|"reason_for_scan"|"referral"|"request_type"|"research_status"|"responsible_department"|"responsible_team"|"risk_assessment_status"|"room_name"|"sales_counterpart"|"sentiment"|"shipping_link"|"social_channels"|"stage"|"status"|"status_design"|"status_of_initiative"|"system_setup"|"task_progress"|"team"|"team_marketing"|"team_responsible"|"time_it_takes_to_complete_tasks"|"timeframe"|"treatment_type"|"type_work_requests_it"|"use_agency"|"user_name"|"vendor_category"|"vendor_type"
- name string
- resource_subtype "text"|"enum"|"multi_enum"|"number"|"date"|"people"
- type "text"|"enum"|"multi_enum"|"number"|"date"|"people"
- enabled boolean
- representation_type "text"|"enum"|"multi_enum"|"number"|"date"|"people"|"formula"|"custom_id"
- id_prefix string|()
- is_formula_field boolean
- date_value CustomFieldCompact_date_value|()
- enum_value record { name string, enabled boolean, color string, gid string, resource_type string, anydata... }
- multi_enum_values EnumOption[]
- number_value decimal|()
- text_value string|()
- display_value string|()
- gid string
- resource_type string
- anydata...
- representation_type "text"|"enum"|"multi_enum"|"number"|"date"|"people"|"formula"|"custom_id" ? - This field tells the type of the custom field.
- id_prefix string? - This field is the unique custom ID string for the custom field.
- is_formula_field boolean? - Conditional. This flag describes whether a custom field is a formula custom field.
- is_value_read_only boolean? - Conditional. This flag describes whether a custom field is read only.
- created_by UserCompact? -
- people_value UserCompact[]? - Conditional. Only relevant for custom fields of type
people
. This array of compact user objects reflects the values of apeople
custom field.
asana: CustomFieldSettingCompact
Fields
- Fields Included from *AsanaResource
asana: CustomFieldSettingResponse
Fields
- project record {}? -
- is_important boolean? -
is_important
is used in the Asana web application to determine if this custom field is displayed in the list/grid view of a project or portfolio.
- parent record {}? -
- custom_field record {}? -
asana: DateVariableCompact
Fields
- gid string? - Globally unique identifier of the date field in the project template. A value of
1
refers to the project start date, while2
refers to the project due date.
- name string? - The name of the date variable.
- description string? - The description of what the date variable is used for when instantiating a project.
asana: DateVariableRequest
Fields
- gid string? - Globally unique identifier of the date field in the project template. A value of
1
refers to the project start date, while2
refers to the project due date.
- value string? - The date with which the date variable should be replaced when instantiating a project. This takes a date with
YYYY-MM-DD
format.
asana: EffortCompact
Fields
- Fields Included from *AsanaResource
- 'type "hours"|"percent" ? - The units used for tracking effort on an allocation, either "hours" or "percent".
- value decimal? - The numeric effort value on the allocation.
asana: EmptyResponse
An 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.
asana: Enum_options_enum_option_gid_body
Fields
- data EnumOptionBase? -
asana: Enum_options_insert_body
Fields
- data EnumOptionInsertRequest? -
asana: EnumOption
Fields
- Fields Included from *AsanaResource
- name string? - The name of the enum option.
- enabled boolean? - Whether or not the enum option is a selectable value for the custom field.
- color string? - The color of the enum option. Defaults to ‘none’.
asana: EnumOptionInsertRequest
Fields
- enum_option string - The gid of the enum option to relocate.
- before_enum_option string? - An existing enum option within this custom field before which the new enum option should be inserted. Cannot be provided together with after_enum_option.
- after_enum_option string? - An existing enum option within this custom field after which the new enum option should be inserted. Cannot be provided together with before_enum_option.
asana: EnumOptionRequest
Fields
- insert_before string? - An existing enum option within this custom field before which the new enum option should be inserted. Cannot be provided together with after_enum_option.
- insert_after string? - An existing enum option within this custom field after which the new enum option should be inserted. Cannot be provided together with before_enum_option.
asana: Error
Fields
- message string? - Message providing more detail about the error that occurred, if available.
- help string? - Additional information directing developers to resources on how to address and fix the problem, if available.
- phrase string? - 500 errors only. A unique error phrase which can be used when contacting developer support to help identify the exact occurrence of the problem in Asana’s logs.
asana: ErrorResponse
Sadly, sometimes requests to the API are not successful. Failures can occur for a wide range of reasons. In all cases, the API should return an HTTP Status Code that indicates the nature of the failure, with a response body in JSON format containing additional information.
In the event of a server error the response body will contain an error phrase. These phrases are automatically generated using the node-asana-phrase library and can be used by Asana support to quickly look up the incident that caused the server error.
Fields
- errors Error[]? -
asana: EventResponse
An event is an object representing a change to a resource that was observed by an event subscription or delivered asynchronously to the target location of an active webhook.
The event may be triggered by a different user
than the
subscriber. For example, if user A subscribes to a task and user B
modified it, the event’s user will be user B. Note: Some events
are generated by the system, and will have null
as the user. API
consumers should make sure to handle this case.
The resource
that triggered the event may be different from the one
that the events were requested for or the webhook is subscribed to. For
example, a subscription to a project will contain events for tasks
contained within the project.
Note: pay close attention to the relationship between the fields
Event.action
and Event.change.action
.
Event.action
represents the action taken on the resource
itself, and Event.change.action
represents how the information
within the resource's fields have been modified.
For instance, consider these scenarios:
-
When at task is added to a project,
Event.action
will beadded
,Event.parent
will be an object with theid
andtype
of the project, and there will be nochange
field. -
When an assignee is set on the task,
Event.parent
will benull
,Event.action
will bechanged
,Event.change.action
will bechanged
, andnew_value
will be an object with the user'sid
andtype
. -
When a collaborator is added to the task,
Event.parent
will benull
,Event.action
will bechanged
,Event.change.action
will beadded
, andadded_value
will be an object with the user'sid
andtype
.
Fields
- user UserCompact? -
- 'resource AsanaNamedResource? -
- 'type string? - Deprecated: Refer to the resource_type of the resource. The type of the resource that generated the event.
- action string? - The type of action taken on the resource that triggered the event. This can be one of
changed
,added
,removed
,deleted
, orundeleted
depending on the nature of the event.
- parent AsanaNamedResource? -
- created_at string? - The timestamp when the event occurred.
- change EventResponse_change? - Information about the type of change that has occurred. This field is only present when the value of the property
action
, describing the action taken on the resource, ischanged
.
asana: EventResponse_change
Information about the type of change that has occurred. This field is only present when the value of the property action
, describing the action taken on the resource, is changed
.
Fields
- 'field string? - The name of the field that has changed in the resource.
- action string? - The type of action taken on the field which has been changed. This can be one of
changed
,added
, orremoved
depending on the nature of the change.
- new_value anydata? - Conditional. This property is only present when the value of the event's
change.action
ischanged
and thenew_value
is an Asana resource. This will be only thegid
andresource_type
of the resource when the events come from webhooks; this will be the compact representation (and can have fields expanded with opt_fields) when using the get events endpoint.
- added_value anydata? - Conditional. This property is only present when the value of the event's
change.action
isadded
and theadded_value
is an Asana resource. This will be only thegid
andresource_type
of the resource when the events come from webhooks; this will be the compact representation (and can have fields expanded with opt_fields) when using the get events endpoint.
- removed_value anydata? - Conditional. This property is only present when the value of the event's
change.action
isremoved
and theremoved_value
is an Asana resource. This will be only thegid
andresource_type
of the resource when the events come from webhooks; this will be the compact representation (and can have fields expanded with opt_fields) when using the get events endpoint.
asana: Goal_gid_addFollowers_body
Fields
- data TaskAddFollowersRequest? -
asana: Goal_gid_addSupportingRelationship_body
Fields
asana: Goal_gid_removeFollowers_body
Fields
- data TaskAddFollowersRequest? -
asana: Goal_gid_removeSupportingRelationship_body
Fields
asana: Goal_gid_setMetric_body
Fields
- data GoalMetricRequest? -
asana: Goal_gid_setMetricCurrentValue_body
Fields
- data GoalMetricCurrentValueRequest? -
asana: Goal_relationships_goal_relationship_gid_body
Fields
- data GoalRelationshipRequest? -
asana: GoalAddSubgoalRequest
Fields
- subgoal string - The goal gid to add as subgoal to a parent goal
- insert_before string? - An id of a subgoal of this parent goal. The new subgoal will be added before the one specified here.
insert_before
andinsert_after
parameters cannot both be specified.
- insert_after string? - An id of a subgoal of this parent goal. The new subgoal will be added after the one specified here.
insert_before
andinsert_after
parameters cannot both be specified.
asana: GoalAddSupportingRelationshipRequest
Fields
- supporting_resource string - The gid of the supporting resource to add to the parent goal. Must be the gid of a goal, project, task, or portfolio.
- insert_before string? - An id of a subgoal of this parent goal. The new subgoal will be added before the one specified here.
insert_before
andinsert_after
parameters cannot both be specified. Currently only supported when adding a subgoal.
- insert_after string? - An id of a subgoal of this parent goal. The new subgoal will be added after the one specified here.
insert_before
andinsert_after
parameters cannot both be specified. Currently only supported when adding a subgoal.
- contribution_weight decimal? - The weight that the supporting resource's progress will contribute to the supported goal's progress. This can only be 0 or 1.
asana: GoalAddSupportingWorkRequest
Fields
- supporting_work string - The project/task/portfolio gid to add as supporting work for a goal
asana: GoalBase
Fields
- Fields Included from *AsanaResource
- name string? - The name of the goal.
- html_notes string? - The notes of the goal with formatting as HTML.
- notes string? - Free-form textual information associated with the goal (i.e. its description).
- due_on string? - The localized day on which this goal is due. This takes a date with format
YYYY-MM-DD
.
- start_on string? - The day on which work for this goal begins, or null if the goal has no start date. This takes a date with
YYYY-MM-DD
format, and cannot be set unless there is an accompanying due date.
- is_workspace_level boolean? - Conditional. This property is only present when the
workspace
provided is an organization. Whether the goal belongs to theworkspace
(and is listed as part of the workspace’s goals) or not. If it isn’t a workspace-level goal, it is a team-level goal, and is associated with the goal’s team.
- liked boolean? - True if the goal is liked by the authorized user, false if not.
asana: GoalCompact
Fields
- Fields Included from *AsanaResource
- name string? - The name of the goal.
- owner record {}? -
asana: GoalMembershipBase
Fields
- Fields Included from *AsanaResource
- resource_type string? - The base type of this resource.
- resource_subtype string? - The type of membership.
- member MemberCompact? -
- parent record {}? -
- role "commenter"|"editor" ? - Deprecated: Describes if the member is a commenter or editor in goal.
- access_level "commenter"|"editor" ? - Describes if member is commenter or editor in goal. This is preferred over role
- goal record {}? -
asana: GoalMembershipCompact
Fields
- Fields Included from *GoalMembershipBase
- resource_type string
- resource_subtype string
- member MemberCompact
- parent record { name string, owner record { name string, gid string, resource_type string, anydata... }, gid string, resource_type string, anydata... }
- role "commenter"|"editor"
- access_level "commenter"|"editor"
- goal record { name string, owner record { name string, gid string, resource_type string, anydata... }, gid string, resource_type string, anydata... }
- gid string
- anydata...
- is_commenter boolean? - Deprecated: new integrations should prefer the
role
field. Describes if the member is comment only in goal.
- is_editor boolean? - Deprecated: new integrations should prefer the
role
field. Describes if the member is editor in goal.
asana: GoalMembershipResponse
Fields
- Fields Included from *GoalMembershipBase
- resource_type string
- resource_subtype string
- member MemberCompact
- parent record { name string, owner record { name string, gid string, resource_type string, anydata... }, gid string, resource_type string, anydata... }
- role "commenter"|"editor"
- access_level "commenter"|"editor"
- goal record { name string, owner record { name string, gid string, resource_type string, anydata... }, gid string, resource_type string, anydata... }
- gid string
- anydata...
- user record {}? -
- workspace record {}? -
asana: GoalMetricBase
Fields
- Fields Included from *AsanaResource
- resource_subtype "number" ? - The 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.
- precision int? - Conditional. Only relevant for goal metrics of type ‘Number’. This field dictates the number of places after the decimal to round to, i.e. 0 is integer values, 1 rounds to the nearest tenth, and so on. Must be between 0 and 6, inclusive. For percentage format, this may be unintuitive, as a value of 0.25 has a precision of 0, while a value of 0.251 has a precision of 1. This is due to 0.25 being displayed as 25%.
- unit "none"|"currency"|"percentage" ? - A supported unit of measure for the goal metric, or none.
- currency_code string? - ISO 4217 currency code to format this custom field. This will be null if the
unit
is notcurrency
.
- initial_number_value decimal? - This number is the start value of a goal metric of type number.
- target_number_value decimal? - This number is the end value of a goal metric of type number. This number cannot equal
initial_number_value
.
- current_number_value decimal? - This number is the current value of a goal metric of type number.
- current_display_value string? - This string is the current value of a goal metric of type string.
- progress_source "manual"|"subgoal_progress"|"project_task_completion"|"project_milestone_completion"|"task_completion"|"external" ? - This field defines how the progress value of a goal metric is being calculated. A goal's progress can be provided manually by the user, calculated automatically from contributing subgoals, projects, or tasks, or managed by an integration with an external data source, such as Salesforce.
asana: GoalMetricCurrentValueRequest
Fields
- Fields Included from *AsanaResource
- current_number_value decimal? - Conditional. This number is the current value of a goal metric of type number.
asana: GoalRelationshipBase
Fields
- Fields Included from *GoalRelationshipCompact
- supported_goal record {}? -
asana: GoalRelationshipCompact
Fields
- Fields Included from *AsanaResource
- resource_subtype "subgoal"|"supporting_work" ? - The 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.
- supporting_resource record {}? -
- contribution_weight decimal? - The weight that the supporting resource's progress contributes to the supported goal's progress. This can only be 0 or 1.
asana: GoalRelationshipRequest
Fields
- Fields Included from *GoalRelationshipBase
- supported_goal record { name string, owner record { name string, gid string, resource_type string, anydata... }, gid string, resource_type string, anydata... }
- resource_subtype "subgoal"|"supporting_work"
- supporting_resource record { name string, gid string, resource_type string, anydata... }
- contribution_weight decimal
- gid string
- resource_type string
- anydata...
asana: GoalRelationshipResponse
Fields
- Fields Included from *GoalRelationshipBase
- supported_goal record { name string, owner record { name string, gid string, resource_type string, anydata... }, gid string, resource_type string, anydata... }
- resource_subtype "subgoal"|"supporting_work"
- supporting_resource record { name string, gid string, resource_type string, anydata... }
- contribution_weight decimal
- gid string
- resource_type string
- anydata...
asana: GoalRemoveSubgoalRequest
Fields
- subgoal string - The goal gid to remove as subgoal from the parent goal
asana: GoalRemoveSupportingRelationshipRequest
Fields
- supporting_resource string - The gid of the supporting resource to remove from the parent goal. Must be the gid of a goal, project, task, or portfolio.
asana: GoalRequest
Fields
- Fields Included from *GoalRequestBase
- followers string[]? -
asana: GoalRequestBase
Fields
- Fields Included from *GoalBase
- team string? - Conditional. This property is only present when the
workspace
provided is an organization.
- workspace string? - The
gid
of a workspace.
- time_period string? - The
gid
of a time period.
- owner string? - The
gid
of a user.
asana: GoalResponse
Fields
- Fields Included from *GoalBase
- likes Like[]? - Array of likes for users who have liked this goal.
- num_likes int? - The number of users who have liked this goal.
- team record {}? -
- workspace record {}? -
- followers UserCompact[]? - Array of users who are members of this goal.
- time_period record {}? -
- metric record { can_manage boolean }? -
- owner record {}? -
- current_status_update StatusUpdateCompact? -
- status string? - The current status of this goal. When the goal is open, its status can be
green
,yellow
, andred
to reflect "On Track", "At Risk", and "Off Track", respectively. When the goal is closed, the value can bemissed
,achieved
,partial
, ordropped
. Note you can only write to this property ifmetric
is set.
asana: Goals_body
Fields
- data GoalRequest? -
asana: Goals_goal_gid_body
Fields
- data GoalUpdateRequest? -
asana: GoalUpdateRequest
Fields
- Fields Included from *GoalRequestBase
- status string? - The current status of this goal. When the goal is open, its status can be
green
,yellow
, andred
to reflect "On Track", "At Risk", and "Off Track", respectively. When the goal is closed, the value can bemissed
,achieved
,partial
, ordropped
. Note you can only write to this property ifmetric
is set.
asana: Inline_response_200
Fields
- data AttachmentResponse? -
asana: Inline_response_200_1
Fields
- data EmptyResponse? - An 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.
asana: Inline_response_200_10
Fields
- data GoalResponse? -
asana: Inline_response_200_11
Fields
- data GoalCompact[]? -
- next_page NextPage? - Conditional. This property is only present when a limit query parameter is provided in the request. When making a paginated request, the API will return a number of results as specified by the limit parameter. If more results exist, then the response will contain a next_page attribute, which will include an offset, a relative path attribute, and a full uri attribute. If there are no more pages available, next_page will be null and no offset will be provided. Note that an offset token will expire after some time, as data may have changed.
asana: Inline_response_200_12
Fields
- data GoalCompact[]? -
asana: Inline_response_200_13
Fields
- data JobResponse? -
asana: Inline_response_200_14
Fields
- data MembershipCompact[]? -
- next_page NextPage? - Conditional. This property is only present when a limit query parameter is provided in the request. When making a paginated request, the API will return a number of results as specified by the limit parameter. If more results exist, then the response will contain a next_page attribute, which will include an offset, a relative path attribute, and a full uri attribute. If there are no more pages available, next_page will be null and no offset will be provided. Note that an offset token will expire after some time, as data may have changed.
asana: Inline_response_200_15
Fields
- data ProjectMembershipCompactResponse? -
asana: Inline_response_200_16
Fields
- data PortfolioMembershipCompact[]? -
- next_page NextPage? - Conditional. This property is only present when a limit query parameter is provided in the request. When making a paginated request, the API will return a number of results as specified by the limit parameter. If more results exist, then the response will contain a next_page attribute, which will include an offset, a relative path attribute, and a full uri attribute. If there are no more pages available, next_page will be null and no offset will be provided. Note that an offset token will expire after some time, as data may have changed.
asana: Inline_response_200_17
Fields
- data PortfolioMembershipResponse? -
asana: Inline_response_200_18
Fields
- data PortfolioCompact[]? -
- next_page NextPage? - Conditional. This property is only present when a limit query parameter is provided in the request. When making a paginated request, the API will return a number of results as specified by the limit parameter. If more results exist, then the response will contain a next_page attribute, which will include an offset, a relative path attribute, and a full uri attribute. If there are no more pages available, next_page will be null and no offset will be provided. Note that an offset token will expire after some time, as data may have changed.
asana: Inline_response_200_19
Fields
- data ProjectCompact[]? -
- next_page NextPage? - Conditional. This property is only present when a limit query parameter is provided in the request. When making a paginated request, the API will return a number of results as specified by the limit parameter. If more results exist, then the response will contain a next_page attribute, which will include an offset, a relative path attribute, and a full uri attribute. If there are no more pages available, next_page will be null and no offset will be provided. Note that an offset token will expire after some time, as data may have changed.
asana: Inline_response_200_2
Fields
- data AttachmentCompact[]? -
- next_page NextPage? - Conditional. This property is only present when a limit query parameter is provided in the request. When making a paginated request, the API will return a number of results as specified by the limit parameter. If more results exist, then the response will contain a next_page attribute, which will include an offset, a relative path attribute, and a full uri attribute. If there are no more pages available, next_page will be null and no offset will be provided. Note that an offset token will expire after some time, as data may have changed.
asana: Inline_response_200_20
Fields
- data CustomFieldSettingResponse? -
asana: Inline_response_200_21
Fields
- data ProjectBriefResponse? -
asana: Inline_response_200_22
Fields
- data ProjectMembershipNormalResponse? -
asana: Inline_response_200_23
Fields
- data ProjectMembershipCompact[]? -
- next_page NextPage? - Conditional. This property is only present when a limit query parameter is provided in the request. When making a paginated request, the API will return a number of results as specified by the limit parameter. If more results exist, then the response will contain a next_page attribute, which will include an offset, a relative path attribute, and a full uri attribute. If there are no more pages available, next_page will be null and no offset will be provided. Note that an offset token will expire after some time, as data may have changed.
asana: Inline_response_200_24
Fields
- data ProjectStatusResponse? -
asana: Inline_response_200_25
Fields
- data ProjectStatusCompact[]? -
- next_page NextPage? - Conditional. This property is only present when a limit query parameter is provided in the request. When making a paginated request, the API will return a number of results as specified by the limit parameter. If more results exist, then the response will contain a next_page attribute, which will include an offset, a relative path attribute, and a full uri attribute. If there are no more pages available, next_page will be null and no offset will be provided. Note that an offset token will expire after some time, as data may have changed.
asana: Inline_response_200_26
Fields
- data ProjectTemplateResponse? -
asana: Inline_response_200_27
Fields
- data ProjectTemplateCompact[]? -
- next_page NextPage? - Conditional. This property is only present when a limit query parameter is provided in the request. When making a paginated request, the API will return a number of results as specified by the limit parameter. If more results exist, then the response will contain a next_page attribute, which will include an offset, a relative path attribute, and a full uri attribute. If there are no more pages available, next_page will be null and no offset will be provided. Note that an offset token will expire after some time, as data may have changed.
asana: Inline_response_200_28
Fields
- data TaskCountResponse? - A response object returned from the task count endpoint.
asana: Inline_response_200_29
Fields
- data RuleTriggerResponse? -
asana: Inline_response_200_3
Fields
- data AuditLogEvent[]? -
- next_page NextPage? - Conditional. This property is only present when a limit query parameter is provided in the request. When making a paginated request, the API will return a number of results as specified by the limit parameter. If more results exist, then the response will contain a next_page attribute, which will include an offset, a relative path attribute, and a full uri attribute. If there are no more pages available, next_page will be null and no offset will be provided. Note that an offset token will expire after some time, as data may have changed.
asana: Inline_response_200_30
Fields
- data SectionResponse? -
asana: Inline_response_200_31
Fields
- data SectionCompact[]? -
- next_page NextPage? - Conditional. This property is only present when a limit query parameter is provided in the request. When making a paginated request, the API will return a number of results as specified by the limit parameter. If more results exist, then the response will contain a next_page attribute, which will include an offset, a relative path attribute, and a full uri attribute. If there are no more pages available, next_page will be null and no offset will be provided. Note that an offset token will expire after some time, as data may have changed.
asana: Inline_response_200_32
Fields
- data StatusUpdateResponse? -
asana: Inline_response_200_33
Fields
- data StatusUpdateCompact[]? -
- next_page NextPage? - Conditional. This property is only present when a limit query parameter is provided in the request. When making a paginated request, the API will return a number of results as specified by the limit parameter. If more results exist, then the response will contain a next_page attribute, which will include an offset, a relative path attribute, and a full uri attribute. If there are no more pages available, next_page will be null and no offset will be provided. Note that an offset token will expire after some time, as data may have changed.
asana: Inline_response_200_34
Fields
- data StoryResponse? -
asana: Inline_response_200_35
Fields
- data StoryCompact[]? -
- next_page NextPage? - Conditional. This property is only present when a limit query parameter is provided in the request. When making a paginated request, the API will return a number of results as specified by the limit parameter. If more results exist, then the response will contain a next_page attribute, which will include an offset, a relative path attribute, and a full uri attribute. If there are no more pages available, next_page will be null and no offset will be provided. Note that an offset token will expire after some time, as data may have changed.
asana: Inline_response_200_36
Fields
- data TagCompact[]? -
- next_page NextPage? - Conditional. This property is only present when a limit query parameter is provided in the request. When making a paginated request, the API will return a number of results as specified by the limit parameter. If more results exist, then the response will contain a next_page attribute, which will include an offset, a relative path attribute, and a full uri attribute. If there are no more pages available, next_page will be null and no offset will be provided. Note that an offset token will expire after some time, as data may have changed.
asana: Inline_response_200_37
Fields
- data TaskTemplateCompact[]? -
asana: Inline_response_200_38
Fields
- data TaskTemplateResponse? -
asana: Inline_response_200_39
Fields
- data TaskCompact[]? -
- next_page NextPage? - Conditional. This property is only present when a limit query parameter is provided in the request. When making a paginated request, the API will return a number of results as specified by the limit parameter. If more results exist, then the response will contain a next_page attribute, which will include an offset, a relative path attribute, and a full uri attribute. If there are no more pages available, next_page will be null and no offset will be provided. Note that an offset token will expire after some time, as data may have changed.
asana: Inline_response_200_4
Fields
- data BatchResponse[]? -
asana: Inline_response_200_40
Fields
- data TaskCompact[]? -
asana: Inline_response_200_41
Fields
- data TeamMembershipResponse? -
asana: Inline_response_200_42
Fields
- data TeamMembershipCompact[]? -
- next_page NextPage? - Conditional. This property is only present when a limit query parameter is provided in the request. When making a paginated request, the API will return a number of results as specified by the limit parameter. If more results exist, then the response will contain a next_page attribute, which will include an offset, a relative path attribute, and a full uri attribute. If there are no more pages available, next_page will be null and no offset will be provided. Note that an offset token will expire after some time, as data may have changed.
asana: Inline_response_200_43
Fields
- data TeamCompact[]? -
- next_page NextPage? - Conditional. This property is only present when a limit query parameter is provided in the request. When making a paginated request, the API will return a number of results as specified by the limit parameter. If more results exist, then the response will contain a next_page attribute, which will include an offset, a relative path attribute, and a full uri attribute. If there are no more pages available, next_page will be null and no offset will be provided. Note that an offset token will expire after some time, as data may have changed.
asana: Inline_response_200_44
Fields
- data TimePeriodResponse? -
asana: Inline_response_200_45
Fields
- data TimePeriodCompact[]? -
- next_page NextPage? - Conditional. This property is only present when a limit query parameter is provided in the request. When making a paginated request, the API will return a number of results as specified by the limit parameter. If more results exist, then the response will contain a next_page attribute, which will include an offset, a relative path attribute, and a full uri attribute. If there are no more pages available, next_page will be null and no offset will be provided. Note that an offset token will expire after some time, as data may have changed.
asana: Inline_response_200_46
Fields
- data TimeTrackingEntryCompact[]? -
- next_page NextPage? - Conditional. This property is only present when a limit query parameter is provided in the request. When making a paginated request, the API will return a number of results as specified by the limit parameter. If more results exist, then the response will contain a next_page attribute, which will include an offset, a relative path attribute, and a full uri attribute. If there are no more pages available, next_page will be null and no offset will be provided. Note that an offset token will expire after some time, as data may have changed.
asana: Inline_response_200_47
A generic list of objects, such as those returned by the typeahead search endpoint.
Fields
- data AsanaNamedResource[]? -
asana: Inline_response_200_48
Fields
- data UserTaskListResponse? -
asana: Inline_response_200_49
Fields
- data UserCompact[]? -
- next_page NextPage? - Conditional. This property is only present when a limit query parameter is provided in the request. When making a paginated request, the API will return a number of results as specified by the limit parameter. If more results exist, then the response will contain a next_page attribute, which will include an offset, a relative path attribute, and a full uri attribute. If there are no more pages available, next_page will be null and no offset will be provided. Note that an offset token will expire after some time, as data may have changed.
asana: Inline_response_200_5
Fields
- data CustomFieldSettingResponse[]? -
- next_page NextPage? - Conditional. This property is only present when a limit query parameter is provided in the request. When making a paginated request, the API will return a number of results as specified by the limit parameter. If more results exist, then the response will contain a next_page attribute, which will include an offset, a relative path attribute, and a full uri attribute. If there are no more pages available, next_page will be null and no offset will be provided. Note that an offset token will expire after some time, as data may have changed.
asana: Inline_response_200_50
Fields
- data UserResponse? -
asana: Inline_response_200_51
Fields
- data AsanaNamedResource[]? -
- next_page NextPage? - Conditional. This property is only present when a limit query parameter is provided in the request. When making a paginated request, the API will return a number of results as specified by the limit parameter. If more results exist, then the response will contain a next_page attribute, which will include an offset, a relative path attribute, and a full uri attribute. If there are no more pages available, next_page will be null and no offset will be provided. Note that an offset token will expire after some time, as data may have changed.
asana: Inline_response_200_52
Fields
- data UserCompact[]? -
asana: Inline_response_200_53
Fields
- data WebhookResponse[]? -
- next_page NextPage? - Conditional. This property is only present when a limit query parameter is provided in the request. When making a paginated request, the API will return a number of results as specified by the limit parameter. If more results exist, then the response will contain a next_page attribute, which will include an offset, a relative path attribute, and a full uri attribute. If there are no more pages available, next_page will be null and no offset will be provided. Note that an offset token will expire after some time, as data may have changed.
asana: Inline_response_200_54
Fields
- data WorkspaceMembershipResponse? -
asana: Inline_response_200_55
Fields
- data WorkspaceMembershipCompact[]? -
- next_page NextPage? - Conditional. This property is only present when a limit query parameter is provided in the request. When making a paginated request, the API will return a number of results as specified by the limit parameter. If more results exist, then the response will contain a next_page attribute, which will include an offset, a relative path attribute, and a full uri attribute. If there are no more pages available, next_page will be null and no offset will be provided. Note that an offset token will expire after some time, as data may have changed.
asana: Inline_response_200_56
Fields
- data WorkspaceCompact[]? -
- next_page NextPage? - Conditional. This property is only present when a limit query parameter is provided in the request. When making a paginated request, the API will return a number of results as specified by the limit parameter. If more results exist, then the response will contain a next_page attribute, which will include an offset, a relative path attribute, and a full uri attribute. If there are no more pages available, next_page will be null and no offset will be provided. Note that an offset token will expire after some time, as data may have changed.
asana: Inline_response_200_57
Fields
- data WorkspaceResponse? -
asana: Inline_response_200_58
Fields
- data UserBaseResponse? -
asana: Inline_response_200_6
Fields
- data CustomFieldResponse[]? -
- next_page NextPage? - Conditional. This property is only present when a limit query parameter is provided in the request. When making a paginated request, the API will return a number of results as specified by the limit parameter. If more results exist, then the response will contain a next_page attribute, which will include an offset, a relative path attribute, and a full uri attribute. If there are no more pages available, next_page will be null and no offset will be provided. Note that an offset token will expire after some time, as data may have changed.
asana: Inline_response_200_7
The full record for all events that have occurred since the sync token was created.
Fields
- data EventResponse[]? -
- sync string? - A sync token to be used with the next call to the /events endpoint.
- has_more boolean? - Indicates whether there are more events to pull.
asana: Inline_response_200_8
Fields
- data GoalRelationshipResponse? -
asana: Inline_response_200_9
Fields
- data GoalRelationshipCompact[]? -
- next_page NextPage? - Conditional. This property is only present when a limit query parameter is provided in the request. When making a paginated request, the API will return a number of results as specified by the limit parameter. If more results exist, then the response will contain a next_page attribute, which will include an offset, a relative path attribute, and a full uri attribute. If there are no more pages available, next_page will be null and no offset will be provided. Note that an offset token will expire after some time, as data may have changed.
asana: Inline_response_201
Fields
- data CustomFieldResponse? -
asana: Inline_response_201_1
Fields
- data EnumOption? -
asana: Inline_response_201_10
Fields
- data WebhookResponse? -
asana: Inline_response_201_2
Fields
- data MembershipResponse? -
asana: Inline_response_201_3
Fields
- data OrganizationExportResponse? -
asana: Inline_response_201_4
Fields
- data PortfolioResponse? -
asana: Inline_response_201_5
Fields
- data ProjectResponse? -
asana: Inline_response_201_6
Fields
- data TagResponse? -
asana: Inline_response_201_7
Fields
- data TaskResponse? -
asana: Inline_response_201_8
Fields
- data TeamResponse? -
asana: Inline_response_201_9
Fields
- data TimeTrackingEntryBase? -
asana: Inline_response_412
Fields
- errors Inline_response_412_errors[]? -
- sync string? - A sync token to be used with the next call to the /events endpoint.
asana: Inline_response_412_errors
Fields
- message string? - Message providing more detail about the error that occurred, if available.
asana: JobCompact
Fields
- Fields Included from *AsanaResource
- resource_subtype string? - The 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.
- status "not_started"|"in_progress"|"succeeded"|"failed" ? - The current status of this job. The value is one of:
not_started
,in_progress
,succeeded
, orfailed
.
- new_project ProjectCompact? -
- new_task record {}? -
- new_project_template ProjectTemplateCompact? -
asana: Like
An object to represent a user's like.
Fields
- gid string? - Globally unique identifier of the object, as a string.
- user UserCompact? -
asana: MemberCompact
Fields
- Fields Included from *AsanaResource
- name string? - The name of the member
- resource_type string? - The type of the member (team or user)
asana: MembershipRequest
Fields
- is_active boolean? - Optional. Denotes if a member is active. Applies to all memberships
asana: Memberships_body
Fields
- data CreateMembershipRequest? -
asana: Memberships_membership_gid_body
Fields
- data MembershipRequest? -
asana: MembershipUpdateRequest
Fields
- access_level string? - The role given to the member. Can be
editor
orcommenter
.
asana: ModifyDependenciesRequest
Fields
- dependencies string[]? - An array of task gids that a task depends on.
asana: ModifyDependentsRequest
A set of dependent tasks.
Fields
- dependents string[]? - An array of task gids that are dependents of the given task.
asana: NextPage
Conditional. This property is only present when a limit query parameter is provided in the request. When making a paginated request, the API will return a number of results as specified by the limit parameter. If more results exist, then the response will contain a next_page attribute, which will include an offset, a relative path attribute, and a full uri attribute. If there are no more pages available, next_page will be null and no offset will be provided. Note that an offset token will expire after some time, as data may have changed.
Fields
- offset string? - Pagination offset for the request.
- path string? - A relative path containing the query parameters to fetch for next_page
- uri string? - A full uri containing the query parameters to fetch for next_page
asana: OAuth2RefreshTokenGrantConfig
OAuth2 Refresh Token Grant Configs
Fields
- Fields Included from *OAuth2RefreshTokenGrantConfig
- refreshUrl string(default "https://app.asana.com/-/oauth_token") - Refresh URL
asana: Organization_exports_body
Fields
- data OrganizationExportRequest? - An organization_export request starts a job to export the complete data of the given Organization.
asana: OrganizationExportCompact
Fields
- Fields Included from *AsanaResource
- created_at string? - The time at which this resource was created.
- download_url string? - Download this URL to retreive the full export of the organization in JSON format. It will be compressed in a gzip (.gz) container. Note: May be null if the export is still in progress or failed. If present, this URL may only be valid for 1 hour from the time of retrieval. You should avoid persisting this URL somewhere and rather refresh on demand to ensure you do not keep stale URLs.
- state "pending"|"started"|"finished"|"error" ? - The current state of the export.
- organization WorkspaceCompact? -
asana: OrganizationExportRequest
An organization_export request starts a job to export the complete data of the given Organization.
Fields
- organization string? - Globally unique identifier for the workspace or organization.
asana: Portfolio_gid_addCustomFieldSetting_body
Fields
- data AddCustomFieldSettingRequest? -
asana: Portfolio_gid_addItem_body
Fields
- data PortfolioAddItemRequest? -
asana: Portfolio_gid_addMembers_body
Fields
- data AddMembersRequest? -
asana: Portfolio_gid_removeCustomFieldSetting_body
Fields
- data RemoveCustomFieldSettingRequest? -
asana: Portfolio_gid_removeItem_body
Fields
- data PortfolioRemoveItemRequest? -
asana: Portfolio_gid_removeMembers_body
Fields
- data RemoveMembersRequest? -
asana: PortfolioAddItemRequest
Fields
- item string - The item to add to the portfolio.
- insert_before string? - An id of an item in this portfolio. The new item will be added before the one specified here.
insert_before
andinsert_after
parameters cannot both be specified.
- insert_after string? - An id of an item in this portfolio. The new item will be added after the one specified here.
insert_before
andinsert_after
parameters cannot both be specified.
asana: PortfolioBase
Fields
- Fields Included from *PortfolioCompact
- color "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 of the portfolio.
asana: PortfolioCompact
Fields
- Fields Included from *AsanaResource
- name string? - The name of the portfolio.
asana: PortfolioMembershipCompact
Fields
- Fields Included from *AsanaResource
- portfolio PortfolioCompact? -
- user UserCompact? -
asana: PortfolioRemoveItemRequest
Fields
- item string - The item to remove from the portfolio.
asana: PortfolioRequest
Fields
- Fields Included from *PortfolioBase
- color "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"
- name string
- gid string
- resource_type string
- anydata...
- members string[]? - An array of strings identifying users. These can either be the string "me", an email, or the gid of a user.
- workspace string? - Gid of an object.
- 'public boolean? - True if the portfolio is public to its workspace members.
asana: PortfolioResponse
Fields
- Fields Included from *PortfolioBase
- color "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"
- name string
- gid string
- resource_type string
- anydata...
- created_at string? - The time at which this resource was created.
- created_by UserCompact? -
- custom_field_settings CustomFieldSettingResponse[]? - Array of custom field settings applied to the portfolio.
- current_status_update StatusUpdateCompact? -
- due_on string? - The localized day on which this portfolio is due. This takes a date with format YYYY-MM-DD.
- custom_fields CustomFieldCompact[]? - Array of Custom Fields.
- members UserCompact[]? -
- owner UserCompact? -
- start_on string? - The day on which work for this portfolio begins, or null if the portfolio has no start date. This takes a date with
YYYY-MM-DD
format. Note:due_on
must be present in the request when setting or unsetting thestart_on
parameter. Additionally,start_on
anddue_on
cannot be the same date.
- workspace record {}? -
- permalink_url string? - A url that points directly to the object within Asana.
- 'public boolean? - True if the portfolio is public to its workspace members.
- project_templates ProjectTemplateCompact[]? - Array of project templates that are in the portfolio
asana: Portfolios_body
Fields
- data PortfolioRequest? -
asana: Portfolios_portfolio_gid_body
Fields
- data PortfolioRequest? -
asana: Preview
A collection of rich text that will be displayed as a preview to another app.
This is read-only except for a small group of whitelisted apps.
Fields
- fallback string? - Some fallback text to display if unable to display the full preview.
- footer string? - Text to display in the footer.
- header string? - Text to display in the header.
- header_link string? - Where the header will link to.
- html_text string? - HTML formatted text for the body of the preview.
- text string? - Text for the body of the preview.
- title string? - Text to display as the title.
- title_link string? - Where to title will link to.
asana: Project_briefs_project_brief_gid_body
Fields
- data ProjectBriefRequest? -
asana: Project_gid_addCustomFieldSetting_body
Fields
- data AddCustomFieldSettingRequest? -
asana: Project_gid_addFollowers_body
Fields
- data AddFollowersRequest? -
asana: Project_gid_addMembers_body
Fields
- data AddMembersRequest? -
asana: Project_gid_duplicate_body
Fields
- data ProjectDuplicateRequest? -
asana: Project_gid_project_briefs_body
Fields
- data ProjectBriefRequest? -
asana: Project_gid_project_statuses_body
Fields
- data ProjectStatusRequest? -
asana: Project_gid_removeCustomFieldSetting_body
Fields
- data RemoveCustomFieldSettingRequest? -
asana: Project_gid_removeFollowers_body
Fields
- data RemoveFollowersRequest? -
asana: Project_gid_removeMembers_body
Fields
- data RemoveMembersRequest? -
asana: Project_gid_saveAsTemplate_body
Fields
- data ProjectSaveAsTemplateRequest? -
asana: Project_gid_sections_body
Fields
- data SectionRequest? -
asana: Project_template_gid_instantiateProject_body
Fields
asana: ProjectBase
Fields
- Fields Included from *ProjectCompact
- archived boolean? - True if the project is archived, false if not. Archived projects do not show in the UI by default and may be treated differently for queries.
- color "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"|"none"?? - Color of the project.
- created_at string? - The time at which this resource was created.
- current_status record {}? -
- current_status_update record {}? -
- custom_field_settings CustomFieldSettingResponse[]? - Array of Custom Field Settings (in compact form).
- default_view "list"|"board"|"calendar"|"timeline" ? - The default view (list, board, calendar, or timeline) of a project.
- due_date string? - Deprecated: new integrations should prefer the
due_on
field.
- due_on string? - The day on which this project is due. This takes a date with format YYYY-MM-DD.
- members UserCompact[]? - Array of users who are members of this project.
- modified_at string? - The time at which this project was last modified. Note: This does not currently reflect any changes in associations such as tasks or comments that may have been added or removed from the project.
- notes string? - Free-form textual information associated with the project (ie., its description).
- 'public boolean? - Deprecated: new integrations use
privacy_setting
instead.
- privacy_setting "public_to_workspace"|"private_to_team"|"private" ? - The privacy setting of the project. Note: Administrators in your organization may restrict the values of
privacy_setting
.
- start_on string? - The day on which work for this project begins, or null if the project has no start date. This takes a date with
YYYY-MM-DD
format. Note:due_on
ordue_at
must be present in the request when setting or unsetting thestart_on
parameter. Additionally,start_on
anddue_on
cannot be the same date.
- default_access_level "admin"|"editor"|"commenter"|"viewer" ? - The default access for users or teams who join or are added as members to the project.
- minimum_access_level_for_customization "admin"|"editor" ? - The minimum access level needed for project members to modify this project's workflow and appearance.
- minimum_access_level_for_sharing "admin"|"editor" ? - The minimum access level needed for project members to share the project and manage project memberships.
asana: ProjectBriefBase
Fields
- Fields Included from *ProjectBriefCompact
- title string? - The title of the project brief.
- html_text string? - HTML formatted text for the project brief.
asana: ProjectBriefCompact
Fields
- Fields Included from *AsanaResource
asana: ProjectBriefRequest
Fields
- Fields Included from *ProjectBriefBase
- text string? - The plain text of the project brief. When writing to a project brief, you can specify either
html_text
(preferred) ortext
, but not both.
asana: ProjectBriefResponse
Fields
- Fields Included from *ProjectBriefBase
- permalink_url string? - A url that points directly to the object within Asana.
- project record {}? -
asana: ProjectCompact
Fields
- Fields Included from *AsanaResource
- name string? - Name 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.
asana: ProjectDuplicateRequest
Fields
- name string - The name of the new project.
- team string? - Sets the team of the new project. If team is not defined, the new project will be in the same team as the the original project.
- include string? - A comma-separated list of elements that will be duplicated to the new project. Tasks are always included.
Fields
- allocations
- forms
- members
- notes
- task_assignee
- task_attachments
- task_dates
- task_dependencies
- task_followers
- task_notes
- task_projects
- task_subtasks
- task_tags
- schedule_dates ProjectDuplicateRequest_schedule_dates? - A dictionary of options to auto-shift dates.
task_dates
must be included to use this option. Requires eitherstart_on
ordue_on
, but not both.
asana: ProjectDuplicateRequest_schedule_dates
A dictionary of options to auto-shift dates. task_dates
must be included to use this option. Requires either start_on
or due_on
, but not both.
Fields
- should_skip_weekends boolean - Determines if the auto-shifted dates should skip weekends.
- due_on string? - Sets the last due date in the duplicated project to the given date. The rest of the due dates will be offset by the same amount as the due dates in the original project.
- start_on string? - Sets the first start date in the duplicated project to the given date. The rest of the start dates will be offset by the same amount as the start dates in the original project.
asana: ProjectMembershipCompact
Fields
- Fields Included from *AsanaResource
- parent ProjectCompact? -
- member MemberCompact? -
- access_level "admin"|"editor"|"commenter"|"viewer" ? - Whether the member has admin, editor, commenter, or viewer access to the project.
asana: ProjectMembershipCompactResponse
Fields
- Fields Included from *ProjectMembershipCompact
- parent ProjectCompact
- member MemberCompact
- access_level "admin"|"editor"|"commenter"|"viewer"
- gid string
- resource_type string
- anydata...
- resource_type string? - The base type of this resource.
- resource_subtype string? - Type of the membership.
asana: ProjectMembershipNormalResponse
Fields
- user UserCompact? -
- project ProjectCompact? -
- resource_type string? - The base type of this resource.
- write_access "full_write"|"comment_only" ? - Whether the member has full access or comment-only access to the project.
asana: ProjectRequest
Fields
- Fields Included from *ProjectBase
- archived boolean
- color "none"|()|"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"
- created_at string
- current_status record { author UserCompact, created_at string, created_by UserCompact, modified_at string, text string, html_text string, color "green"|"yellow"|"red"|"blue"|"complete", title string, gid string, resource_type string, anydata... }
- current_status_update record { title string, resource_subtype "project_status_update"|"portfolio_status_update"|"goal_status_update", gid string, resource_type string, anydata... }
- custom_field_settings CustomFieldSettingResponse[]
- default_view "list"|"board"|"calendar"|"timeline"
- due_date string|()
- due_on string|()
- html_notes string
- members UserCompact[]
- modified_at string
- notes string
- public boolean
- privacy_setting "public_to_workspace"|"private_to_team"|"private"
- start_on string|()
- default_access_level "admin"|"editor"|"commenter"|"viewer"
- minimum_access_level_for_customization "admin"|"editor"
- minimum_access_level_for_sharing "admin"|"editor"
- name string
- gid string
- resource_type string
- anydata...
- custom_fields record { string... }? - An object where each key is the GID of a custom field and its corresponding value is either an enum GID, string, number, or object (depending on the custom field type). See the custom fields guide for details on creating and updating custom field values.
- followers string? - Create-only. Comma separated string of users. Followers are a subset of members who have opted in to receive "tasks added" notifications for a project.
- owner string? - The current owner of the project, may be null.
- team string? - The team that this project is shared with.
- workspace string? - The
gid
of a workspace.
asana: ProjectResponse
Fields
- Fields Included from *ProjectBase
- archived boolean
- color "none"|()|"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"
- created_at string
- current_status record { author UserCompact, created_at string, created_by UserCompact, modified_at string, text string, html_text string, color "green"|"yellow"|"red"|"blue"|"complete", title string, gid string, resource_type string, anydata... }
- current_status_update record { title string, resource_subtype "project_status_update"|"portfolio_status_update"|"goal_status_update", gid string, resource_type string, anydata... }
- custom_field_settings CustomFieldSettingResponse[]
- default_view "list"|"board"|"calendar"|"timeline"
- due_date string|()
- due_on string|()
- html_notes string
- members UserCompact[]
- modified_at string
- notes string
- public boolean
- privacy_setting "public_to_workspace"|"private_to_team"|"private"
- start_on string|()
- default_access_level "admin"|"editor"|"commenter"|"viewer"
- minimum_access_level_for_customization "admin"|"editor"
- minimum_access_level_for_sharing "admin"|"editor"
- name string
- gid string
- resource_type string
- anydata...
- custom_fields CustomFieldCompact[]? - Array of Custom Fields.
- completed boolean? - True if the project is currently marked complete, false if not.
- completed_at string? - The time at which this project was completed, or null if the project is not completed.
- completed_by UserCompact? -
- followers UserCompact[]? - Array of users following this project. Followers are a subset of members who have opted in to receive "tasks added" notifications for a project.
- owner record {}? - The current owner of the project, may be null.
- team record {}? -
- icon "list"|"board"|"timeline"|"calendar"|"rocket"|"people"|"graph"|"star"|"bug"|"light_bulb"|"globe"|"gear"|"notebook"|"computer"|"check"|"target"|"html"|"megaphone"|"chat_bubbles"|"briefcase"|"page_layout"|"mountain_flag"|"puzzle"|"presentation"|"line_and_symbols"|"speed_dial"|"ribbon"|"shoe"|"shopping_basket"|"map"|"ticket"|"coins" ? - The icon for a project.
- permalink_url string? - A url that points directly to the object within Asana.
- project_brief record {}? -
- created_from_template record {}? -
- workspace record {}? -
asana: Projects_body
Fields
- data ProjectRequest? -
asana: Projects_project_gid_body
Fields
- data ProjectUpdateRequest? -
asana: ProjectSaveAsTemplateRequest
Fields
- name string - The name of the new project template.
- team string? - Sets the team of the new project template. If the project exists in an organization, specify team and not workspace.
- workspace string? - Sets the workspace of the new project template. Only specify workspace if the project exists in a workspace.
- 'public boolean - Sets the project template to public to its team.
asana: ProjectSectionInsertRequest
Fields
- section string - The section to reorder.
- before_section string? - Insert the given section immediately before the section specified by this parameter.
- after_section string? - Insert the given section immediately after the section specified by this parameter.
asana: ProjectStatusBase
Fields
- Fields Included from *ProjectStatusCompact
- text string? - The text content of the status update.
- color "green"|"yellow"|"red"|"blue"|"complete" ? - The color associated with the status update.
asana: ProjectStatusCompact
Fields
- Fields Included from *AsanaResource
- title string? - The title of the project status update.
asana: ProjectStatusResponse
Fields
- Fields Included from *ProjectStatusBase
- author UserCompact? -
- created_at string? - The time at which this resource was created.
- created_by UserCompact? -
- modified_at string? - The time at which this project status was last modified. Note: This does not currently reflect any changes in associations such as comments that may have been added or removed from the project status.
asana: ProjectTemplateBase
Fields
- Fields Included from *ProjectTemplateCompact
- description string? - Free-form textual information associated with the project template
- html_description string? - The description of the project template with formatting as HTML.
- 'public boolean? - True if the project template is public to its team.
- owner record {}? - The current owner of the project template, may be null.
- team TeamCompact? -
- requested_dates DateVariableCompact[]? - Array of date variables in this project template. Calendar dates must be provided for these variables when instantiating a project.
- color "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 of the project template.
- requested_roles TemplateRole[]? - 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.
asana: ProjectTemplateCompact
Fields
- Fields Included from *AsanaResource
- name string? - Name of the project template.
asana: ProjectTemplateInstantiateProjectRequest
Fields
- name string - The name of the new project.
- team string? - Optional. Sets the team of the new project. If the project template exists in an organization, you may specify a value for
team
. If no value is provided then it defaults to the same team as the project template.
- 'public boolean? - Sets the project to public to its team.
- is_strict boolean? - Optional. If set to
true
, the endpoint returns an "Unprocessable Entity" error if you fail to provide a calendar date value for any date variable. If set tofalse
, a default date is used for each unfulfilled date variable (e.g., the current date is used as the Start Date of a project).
- requested_dates DateVariableRequest[]? - Array of mappings of date variables to calendar dates.
- requested_roles RequestedRoleRequest[]? - Array of mappings of template roles to user ids
asana: ProjectUpdateRequest
Fields
- Fields Included from *ProjectBase
- archived boolean
- color "none"|()|"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"
- created_at string
- current_status record { author UserCompact, created_at string, created_by UserCompact, modified_at string, text string, html_text string, color "green"|"yellow"|"red"|"blue"|"complete", title string, gid string, resource_type string, anydata... }
- current_status_update record { title string, resource_subtype "project_status_update"|"portfolio_status_update"|"goal_status_update", gid string, resource_type string, anydata... }
- custom_field_settings CustomFieldSettingResponse[]
- default_view "list"|"board"|"calendar"|"timeline"
- due_date string|()
- due_on string|()
- html_notes string
- members UserCompact[]
- modified_at string
- notes string
- public boolean
- privacy_setting "public_to_workspace"|"private_to_team"|"private"
- start_on string|()
- default_access_level "admin"|"editor"|"commenter"|"viewer"
- minimum_access_level_for_customization "admin"|"editor"
- minimum_access_level_for_sharing "admin"|"editor"
- name string
- gid string
- resource_type string
- anydata...
- custom_fields record { string... }? - An object where each key is the GID of a custom field and its corresponding value is either an enum GID, string, number, or object (depending on the custom field type). See the custom fields guide for details on creating and updating custom field values.
- followers string? - Create-only. Comma separated string of users. Followers are a subset of members who have opted in to receive "tasks added" notifications for a project.
- owner string? - The current owner of the project, may be null.
- team string? - The team that this project is shared with.
asana: ProxyConfig
Proxy server configurations to be used with the HTTP client endpoint.
Fields
- host string(default "") - Host name of the proxy server
- port int(default 0) - Proxy server port
- userName string(default "") - Proxy server username
- password string(default "") - Proxy server password
asana: RemoveCustomFieldSettingRequest
Fields
- custom_field string - The custom field to remove from this portfolio.
asana: RemoveFollowersRequest
Fields
- followers string - An array of strings identifying users. These can either be the string "me", an email, or the gid of a user.
asana: RemoveMembersRequest
Fields
- members string - An array of strings identifying users. These can either be the string "me", an email, or the gid of a user.
asana: RequestedRoleRequest
Fields
- gid string? - Globally unique identifier of the template role in the project template.
- value string? - The user id that should be assigned to the template role.
asana: Rule_trigger_gid_run_body
Fields
- data RuleTriggerRequest? -
asana: RuleTriggerRequest
Fields
- 'resource string - The ID of the resource. For the duration of the beta, this resource is always a task, and this task must exist in the project in which the rule is created.
- action_data record {} - The dynamic keys and values of the request. These fields are intended to be used in the action for the rule associated with this trigger.
asana: RuleTriggerResponse
Fields
- message string? - Message providing more detail about the result
asana: Section_gid_addTask_body
Fields
- data SectionTaskInsertRequest? -
asana: SectionCompact
Fields
- Fields Included from *AsanaResource
- name string? - The name of the section (i.e. the text displayed as the section header).
asana: SectionRequest
Fields
- name string - The text to be displayed as the section name. This cannot be an empty string.
- insert_before string? - An existing section within this project before which the added section should be inserted. Cannot be provided together with insert_after.
- insert_after string? - An existing section within this project after which the added section should be inserted. Cannot be provided together with insert_before.
asana: SectionResponse
Fields
- created_at string? - The time at which this resource was created.
- project ProjectCompact? -
- projects ProjectCompact[]? - Deprecated - please use project instead
asana: Sections_insert_body
Fields
- data ProjectSectionInsertRequest? -
asana: Sections_section_gid_body
Fields
- data SectionRequest? -
asana: SectionTaskInsertRequest
Fields
- task string - The task to add to this section.
- insert_before string? - An existing task within this section before which the added task should be inserted. Cannot be provided together with insert_after.
- insert_after string? - An existing task within this section after which the added task should be inserted. Cannot be provided together with insert_before.
asana: Status_updates_body
Fields
- data StatusUpdateRequest? -
asana: StatusUpdateBase
Fields
- Fields Included from *StatusUpdateCompact
- text string - The text content of the status update.
- status_type "on_track"|"at_risk"|"off_track"|"on_hold"|"complete"|"achieved"|"partial"|"missed"|"dropped" - The type associated with the status update. This represents the current state of the object this object is on.
asana: StatusUpdateCompact
Fields
- Fields Included from *AsanaResource
- title string? - The title of the status update.
- resource_subtype "project_status_update"|"portfolio_status_update"|"goal_status_update" ? - The 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.
The
resource_subtype
s forstatus
objects represent the type of their parent.
asana: StatusUpdateRequest
Fields
- Fields Included from *StatusUpdateBase
- parent string -
asana: StatusUpdateResponse
Fields
- Fields Included from *StatusUpdateBase
- author UserCompact? -
- created_at string? - The time at which this resource was created.
- created_by UserCompact? -
- hearted boolean? - Deprecated - please use liked instead True if the status is hearted by the authorized user, false if not.
- hearts Like[]? - Deprecated - please use likes instead Array of likes for users who have hearted this status.
- liked boolean? - True if the status is liked by the authorized user, false if not.
- likes Like[]? - Array of likes for users who have liked this status.
- modified_at string? - The time at which this project status was last modified. Note: This does not currently reflect any changes in associations such as comments that may have been added or removed from the status.
- num_hearts int? - Deprecated - please use likes instead The number of users who have hearted this status.
- num_likes int? - The number of users who have liked this status.
- parent record {}? -
asana: Stories_story_gid_body
Fields
- data StoryRequest? -
asana: StoryBase
Fields
- Fields Included from *AsanaResource
- created_at string? - The time at which this resource was created.
- resource_subtype string? - The 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.
- text string? - The plain text of the comment to add. Cannot be used with html_text.
- is_pinned boolean? - Conditional. Whether the story should be pinned on the resource.
- sticker_name "green_checkmark"|"people_dancing"|"dancing_unicorn"|"heart"|"party_popper"|"people_waving_flags"|"splashing_narwhal"|"trophy"|"yeti_riding_unicorn"|"celebrating_people"|"determined_climbers"|"phoenix_spreading_love" ? - The name of the sticker in this story.
null
if there is no sticker.
asana: StoryCompact
Fields
- Fields Included from *AsanaResource
- created_at string? - The time at which this resource was created.
- created_by UserCompact? -
- resource_subtype string? - The 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.
- text string? - Create-only. Human-readable text for the story or comment.
This will not include the name of the creator.
Note: This is not guaranteed to be stable for a given type of story. For example, text for a reassignment may not always say “assigned to …” as the text for a story can both be edited and change based on the language settings of the user making the request.
Use the
resource_subtype
property to discover the action that created the story.
asana: StoryResponse
Fields
- Fields Included from *StoryBase
- created_at string
- resource_subtype string
- text string
- html_text string
- is_pinned boolean
- sticker_name "green_checkmark"|"people_dancing"|"dancing_unicorn"|"heart"|"party_popper"|"people_waving_flags"|"splashing_narwhal"|"trophy"|"yeti_riding_unicorn"|"celebrating_people"|"determined_climbers"|"phoenix_spreading_love"
- gid string
- resource_type string
- anydata...
- created_by UserCompact? -
- 'type "comment"|"system" ? -
- is_editable boolean? - Conditional. Whether the text of the story can be edited after creation.
- is_edited boolean? - Conditional. Whether the text of the story has been edited after creation.
- hearted boolean? - Deprecated - please use likes instead Conditional. True if the story is hearted by the authorized user, false if not.
- hearts Like[]? - Deprecated - please use likes instead Conditional. Array of likes for users who have hearted this story.
- num_hearts int? - Deprecated - please use likes instead Conditional. The number of users who have hearted this story.
- liked boolean? - Conditional. True if the story is liked by the authorized user, false if not.
- likes Like[]? - Conditional. Array of likes for users who have liked this story.
- num_likes int? - Conditional. The number of users who have liked this story.
- previews Preview[]? - Conditional. A collection of previews to be displayed in the story. Note: This property only exists for comment stories.
- old_name string? - Conditional'
- new_name string? - Conditional
- old_dates StoryResponseDates? - Conditional
- new_dates StoryResponseDates? - Conditional
- old_resource_subtype string? - Conditional
- new_resource_subtype string? - Conditional
- story StoryCompact? -
- assignee UserCompact? -
- follower UserCompact? -
- old_section SectionCompact? -
- new_section SectionCompact? -
- task TaskCompact? -
- project ProjectCompact? -
- tag TagCompact? -
- custom_field CustomFieldCompact? -
- old_text_value string? - Conditional
- new_text_value string? - Conditional
- old_number_value int? - Conditional
- new_number_value int? - Conditional
- old_enum_value EnumOption? -
- new_enum_value EnumOption? -
- old_date_value StoryResponseDates? -
- new_date_value StoryResponseDates? -
- old_people_value UserCompact[]? - Conditional. The old value of a people custom field story.
- new_people_value UserCompact[]? - Conditional. The new value of a people custom field story.
- old_multi_enum_values EnumOption[]? - Conditional. The old value of a multi-enum custom field story.
- new_multi_enum_values EnumOption[]? - Conditional. The new value of a multi-enum custom field story.
- new_approval_status string? - Conditional. The new value of approval status.
- old_approval_status string? - Conditional. The old value of approval status.
- duplicate_of TaskCompact? -
- duplicated_from TaskCompact? -
- dependency TaskCompact? -
- 'source "web"|"email"|"mobile"|"api"|"unknown" ? - The component of the Asana product the user used to trigger the story.
- target record {}? -
asana: StoryResponseDates
Conditional
Fields
- start_on string? - The day on which work for this goal begins, or null if the goal has no start date. This takes a date with
YYYY-MM-DD
format, and cannot be set unless there is an accompanying due date.
- due_at string? - The UTC date and time on which this task is due, or null if the task has no due time. This takes an ISO 8601 date string in UTC and should not be used together with
due_on
.
- due_on string? - The localized day on which this goal is due. This takes a date with format
YYYY-MM-DD
.
asana: TagBase
Fields
- Fields Included from *TagCompact
- color "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 of the tag.
- notes string? - Free-form textual information associated with the tag (i.e. its description).
asana: TagCompact
Fields
- Fields Included from *AsanaResource
- name string? - Name 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.
asana: TagCreateTagForWorkspaceRequest
Fields
- Fields Included from *TagBase
- color "light-warm-gray"|()|"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"
- notes string
- name string
- gid string
- resource_type string
- anydata...
- followers string[]? - An array of strings identifying users. These can either be the string "me", an email, or the gid of a user.
asana: TagRequest
Fields
- Fields Included from *TagBase
- color "light-warm-gray"|()|"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"
- notes string
- name string
- gid string
- resource_type string
- anydata...
- followers string[]? - An array of strings identifying users. These can either be the string "me", an email, or the gid of a user.
- workspace string? - Gid of an object.
asana: TagResponse
Fields
- Fields Included from *TagBase
- color "light-warm-gray"|()|"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"
- notes string
- name string
- gid string
- resource_type string
- anydata...
- created_at string? - The time at which this resource was created.
- followers UserCompact[]? - Array of users following this tag.
- workspace WorkspaceCompact? -
- permalink_url string? - A url that points directly to the object within Asana.
asana: Tags_body
Fields
- data TagRequest? -
asana: Task_gid_addDependencies_body
Fields
- data ModifyDependenciesRequest? -
asana: Task_gid_addDependents_body
Fields
- data ModifyDependentsRequest? - A set of dependent tasks.
asana: Task_gid_addFollowers_body
Fields
- data TaskAddFollowersRequest? -
asana: Task_gid_addProject_body
Fields
- data TaskAddProjectRequest? -
asana: Task_gid_addTag_body
Fields
- data TaskAddTagRequest? -
asana: Task_gid_duplicate_body
Fields
- data TaskDuplicateRequest? -
asana: Task_gid_removeDependencies_body
Fields
- data ModifyDependenciesRequest? -
asana: Task_gid_removeDependents_body
Fields
- data ModifyDependentsRequest? - A set of dependent tasks.
asana: Task_gid_removeFollowers_body
Fields
- data TaskRemoveFollowersRequest? -
asana: Task_gid_removeProject_body
Fields
- data TaskRemoveProjectRequest? -
asana: Task_gid_removeTag_body
Fields
- data TaskRemoveTagRequest? -
asana: Task_gid_setParent_body
Fields
- data TaskSetParentRequest? -
asana: Task_gid_stories_body
Fields
- data StoryRequest? -
asana: Task_gid_subtasks_body
Fields
- data TaskRequest? -
asana: Task_gid_time_tracking_entries_body
Fields
- data CreateTimeTrackingEntryRequest? -
asana: Task_template_gid_instantiateTask_body
Fields
asana: TaskAddFollowersRequest
Fields
- followers string[] - An array of strings identifying users. These can either be the string "me", an email, or the gid of a user.
asana: TaskAddProjectRequest
Fields
- project string - The project to add the task to.
- insert_after string? - A task in the project to insert the task after, or
null
to insert at the beginning of the list.
- insert_before string? - A task in the project to insert the task before, or
null
to insert at the end of the list.
- section string? - A section in the project to insert the task into. The task will be inserted at the bottom of the section.
asana: TaskAddTagRequest
Fields
- tag string - The tag's gid to add to the task.
asana: TaskBase
Fields
- Fields Included from *TaskCompact
- name string
- resource_subtype "default_task"|"milestone"|"section"|"approval"
- created_by TaskCompact_created_by
- gid string
- resource_type string
- anydata...
- approval_status "pending"|"approved"|"rejected"|"changes_requested" ? - Conditional Reflects the approval status of this task. This field is kept in sync with
completed
, meaningpending
translates to false whileapproved
,rejected
, andchanges_requested
translate to true. If you set completed to true, this field will be set toapproved
.
- assignee_status "today"|"upcoming"|"later"|"new"|"inbox" ? - Deprecated Scheduling status of this task for the user it is assigned to. This field can only be set if the assignee is non-null. Setting this field to "inbox" or "upcoming" inserts it at the top of the section, while the other options will insert at the bottom.
- completed boolean? - True if the task is currently marked complete, false if not.
- completed_at string? - The time at which this task was completed, or null if the task is incomplete.
- completed_by UserCompact? -
- created_at string? - The time at which this resource was created.
- dependencies AsanaResource[]? - Opt In. Array of resources referencing tasks that this task depends on. The objects contain only the gid of the dependency.
- dependents AsanaResource[]? - Opt In. Array of resources referencing tasks that depend on this task. The objects contain only the ID of the dependent.
- due_at string? - The UTC date and time on which this task is due, or null if the task has no due time. This takes an ISO 8601 date string in UTC and should not be used together with
due_on
.
- due_on string? - The localized date on which this task is due, or null if the task has no due date. This takes a date with
YYYY-MM-DD
format and should not be used together withdue_at
.
- 'external TaskBase_external? - OAuth Required. Conditional. This field is returned only if external values are set or included by using [Opt In] (/docs/inputoutput-options).
The external field allows you to store app-specific metadata on tasks, including a gid that can be used to retrieve tasks and a data blob that can store app-specific character strings. Note that you will need to authenticate with Oauth to access or modify this data. Once an external gid is set, you can use the notation
external:custom_gid
to reference your object anywhere in the API where you may use the original object gid. See the page on Custom External Data for more details.
- hearted boolean? - Deprecated - please use liked instead True if the task is hearted by the authorized user, false if not.
- hearts Like[]? - Deprecated - please use likes instead Array of likes for users who have hearted this task.
- is_rendered_as_separator boolean? - Opt In. In some contexts tasks can be rendered as a visual separator; for instance, subtasks can appear similar to sections without being true
section
objects. If atask
object is rendered this way in any context it will have the propertyis_rendered_as_separator
set totrue
.
- liked boolean? - True if the task is liked by the authorized user, false if not.
- likes Like[]? - Array of likes for users who have liked this task.
- memberships TaskBase_memberships[]? - Create-only. Array of projects this task is associated with and the section it is in. At task creation time, this array can be used to add the task to specific sections. After task creation, these associations can be modified using the
addProject
andremoveProject
endpoints. Note that over time, more types of memberships may be added to this property.
- modified_at string? - The time at which this task was last modified.
The following conditions will change
modified_at
:- story is created on a task
- story is trashed on a task
- attachment is trashed on a task
- task is assigned or unassigned
- custom field value is changed
- the task itself is trashed
- Or if any of the following fields are updated:
- completed
- name
- due_date
- description
- attachments
- items
- schedule_status
modified_at
:- moving to a new container (project, portfolio, etc)
- comments being added to the task (but the stories they generate
will affect
modified_at
)
- name string? - Name of the task. This is generally a short sentence fragment that fits on a line in the UI for maximum readability. However, it can be longer.
- notes string? - Free-form textual information associated with the task (i.e. its description).
- num_hearts int? - Deprecated - please use likes instead The number of users who have hearted this task.
- num_likes int? - The number of users who have liked this task.
- start_at string? - Date and time on which work begins for the task, or null if the task has no start time. This takes an ISO 8601 date string in UTC and should not be used together with
start_on
. Note:due_at
must be present in the request when setting or unsetting thestart_at
parameter.
- start_on string? - The day on which work begins for the task , or null if the task has no start date. This takes a date with
YYYY-MM-DD
format and should not be used together withstart_at
. Note:due_on
ordue_at
must be present in the request when setting or unsetting thestart_on
parameter.
- actual_time_minutes decimal? - This value represents the sum of all the Time Tracking entries in the Actual Time field on a given Task. It is represented as a nullable long value.
asana: TaskBase_external
OAuth Required. Conditional. This field is returned only if external values are set or included by using [Opt In] (/docs/inputoutput-options).
The external field allows you to store app-specific metadata on tasks, including a gid that can be used to retrieve tasks and a data blob that can store app-specific character strings. Note that you will need to authenticate with Oauth to access or modify this data. Once an external gid is set, you can use the notation external:custom_gid
to reference your object anywhere in the API where you may use the original object gid. See the page on Custom External Data for more details.
Fields
- gid string? -
- data string? -
asana: TaskBase_memberships
Fields
- project ProjectCompact? -
- section SectionCompact? -
asana: TaskCompact
Fields
- Fields Included from *AsanaResource
- name string? - The name of the task.
- resource_subtype "default_task"|"milestone"|"section"|"approval" ? - The 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.
The resource_subtype
milestone
represent a single moment in time. This means tasks with this subtype cannot have a start_date.
- created_by TaskCompact_created_by? - Opt In. A user object represents an account in Asana that can be given access to various workspaces, projects, and tasks.
asana: TaskCompact_created_by
Opt In. A user object represents an account in Asana that can be given access to various workspaces, projects, and tasks.
Fields
- gid string? - Globally unique identifier of the resource.
- resource_type string? - The type of resource.
asana: TaskCountResponse
A response object returned from the task count endpoint.
Fields
- num_tasks int? - The number of tasks in a project.
- num_incomplete_tasks int? - The number of incomplete tasks in a project.
- num_completed_tasks int? - The number of completed tasks in a project.
- num_milestones int? - The number of milestones in a project.
- num_incomplete_milestones int? - The number of incomplete milestones in a project.
- num_completed_milestones int? - The number of completed milestones in a project.
asana: TaskDuplicateRequest
Fields
- name string? - The name of the new task.
- include string? - A comma-separated list of fields that will be duplicated to the new task.
Fields
- assignee
- attachments
- dates
- dependencies
- followers
- notes
- parent
- projects
- subtasks
- tags
asana: TaskRemoveFollowersRequest
Fields
- followers string[] - An array of strings identifying users. These can either be the string "me", an email, or the gid of a user.
asana: TaskRemoveProjectRequest
Fields
- project string - The project to remove the task from.
asana: TaskRemoveTagRequest
Fields
- tag string - The tag's gid to remove from the task.
asana: TaskRequest
Fields
- Fields Included from *TaskBase
- approval_status "pending"|"approved"|"rejected"|"changes_requested"
- assignee_status "today"|"upcoming"|"later"|"new"|"inbox"
- completed boolean
- completed_at string|()
- completed_by UserCompact
- created_at string
- dependencies AsanaResource[]
- dependents AsanaResource[]
- due_at string|()
- due_on string|()
- external TaskBase_external
- html_notes string
- hearted boolean
- hearts Like[]
- is_rendered_as_separator boolean
- liked boolean
- likes Like[]
- memberships TaskBase_memberships[]
- modified_at string
- name string
- notes string
- num_hearts int
- num_likes int
- num_subtasks int
- start_at string|()
- start_on string|()
- actual_time_minutes decimal|()
- resource_subtype "default_task"|"milestone"|"section"|"approval"
- created_by TaskCompact_created_by
- gid string
- resource_type string
- anydata...
- assignee string? - Gid of a user.
- assignee_section string? - The assignee section is a subdivision of a project that groups tasks together in the assignee's "My Tasks" list. It can either be a header above a list of tasks in a list view or a column in a board view of "My Tasks."
The
assignee_section
property will be returned in the response only if the request was sent by the user who is the assignee of the task. Note that you can only write toassignee_section
with the gid of an existing section visible in the user's "My Tasks" list.
- custom_fields record { string... }? - An object where each key is the GID of a custom field and its corresponding value is either an enum GID, string, number, object, or array (depending on the custom field type). See the custom fields guide for details on creating and updating custom field values.
- followers string[]? - Create-Only An array of strings identifying users. These can either be the string "me", an email, or the gid of a user. In order to change followers on an existing task use
addFollowers
andremoveFollowers
.
- parent string? - Gid of a task.
- projects string[]? - Create-Only Array of project gids. In order to change projects on an existing task use
addProject
andremoveProject
.
- tags string[]? - Create-Only Array of tag gids. In order to change tags on an existing task use
addTag
andremoveTag
.
- workspace string? - Gid of a workspace.
asana: TaskResponse
Fields
- Fields Included from *TaskBase
- approval_status "pending"|"approved"|"rejected"|"changes_requested"
- assignee_status "today"|"upcoming"|"later"|"new"|"inbox"
- completed boolean
- completed_at string|()
- completed_by UserCompact
- created_at string
- dependencies AsanaResource[]
- dependents AsanaResource[]
- due_at string|()
- due_on string|()
- external TaskBase_external
- html_notes string
- hearted boolean
- hearts Like[]
- is_rendered_as_separator boolean
- liked boolean
- likes Like[]
- memberships TaskBase_memberships[]
- modified_at string
- name string
- notes string
- num_hearts int
- num_likes int
- num_subtasks int
- start_at string|()
- start_on string|()
- actual_time_minutes decimal|()
- resource_subtype "default_task"|"milestone"|"section"|"approval"
- created_by TaskCompact_created_by
- gid string
- resource_type string
- anydata...
- assignee UserCompact? -
- assignee_section record {}? -
- custom_fields CustomFieldResponse[]? - Array of custom field values applied to the task. These represent the custom field values recorded on this project for a particular custom field. For example, these custom field values will contain an
enum_value
property for custom fields of typeenum
, atext_value
property for custom fields of typetext
, and so on. Please note that thegid
returned on each custom field value is identical to thegid
of the custom field, which allows referencing the custom field metadata through the/custom_fields/custom_field-gid
endpoint.
- followers UserCompact[]? - Array of users following this task.
- parent record {}? -
- projects ProjectCompact[]? - Create-only. Array of projects this task is associated with. At task creation time, this array can be used to add the task to many projects at once. After task creation, these associations can be modified using the addProject and removeProject endpoints.
- tags TagCompact[]? - Array of tags associated with this task. In order to change tags on an existing task use
addTag
andremoveTag
.
- workspace record {}? -
- permalink_url string? - A url that points directly to the object within Asana.
asana: Tasks_body
Fields
- data TaskRequest? -
asana: Tasks_task_gid_body
Fields
- data TaskRequest? -
asana: TaskSetParentRequest
Fields
- parent string - The new parent of the task, or
null
for no parent.
- insert_after string? - A subtask of the parent to insert the task after, or
null
to insert at the beginning of the list.
- insert_before string? - A subtask of the parent to insert the task before, or
null
to insert at the end of the list.
asana: TaskTemplateCompact
Fields
- Fields Included from *AsanaResource
- name string? - Name of the task template.
asana: TaskTemplateInstantiateTaskRequest
Fields
- name string? - The name of the new task. If not provided, the name of the task template will be used.
asana: TaskTemplateRecipe
Fields
- Fields Included from *TaskTemplateRecipeCompact
- name string
- task_resource_subtype "default_task"|"milestone_task"|"approval_task"
- anydata...
- description string? - Description of the task that will be created from this template.
- html_description string? - HTML description of the task that will be created from this template.
- memberships ProjectCompact[]? - Array of projects that the task created from this template will be added to
- relative_start_on int? - The number of days after the task has been instantiated on which that the task will start
- relative_due_on int? - The number of days after the task has been instantiated on which that the task will be due
- due_time string? - The time of day that the task will be due
- dependencies TaskTemplateRecipeCompact[]? - Array of task templates that the task created from this template will depend on
- dependents TaskTemplateRecipeCompact[]? - Array of task templates that will depend on the task created from this template
- followers UserCompact[]? - Array of users that will be added as followers to the task created from this template
- attachments AttachmentCompact[]? - Array of attachments that will be added to the task created from this template
- subtasks TaskTemplateRecipeCompact[]? - Array of subtasks that will be added to the task created from this template
- custom_fields CustomFieldCompact[]? - Array of custom fields that will be added to the task created from this template
asana: TaskTemplateRecipeCompact
Fields
- name string? - Name of the task that will be created from this template.
- task_resource_subtype "default_task"|"milestone_task"|"approval_task" ? - The subtype of the task that will be created from this template.
asana: TaskTemplateResponse
Fields
- name string? - Name of the task template.
- project ProjectCompact? - The project that this task template belongs to.
- template TaskTemplateRecipe? - The configuration for the task that will be created from this template.
- created_by UserCompact? - The user who created this task template.
- created_at string? - The time at which this task template was created.
asana: Team_gid_addUser_body
Fields
- data TeamAddUserRequest? - A user identification object for specification with the addUser/removeUser endpoints.
asana: Team_gid_projects_body
Fields
- data ProjectRequest? -
asana: Team_gid_removeUser_body
Fields
- data TeamRemoveUserRequest? - A user identification object for specification with the addUser/removeUser endpoints.
asana: TeamAddUserRequest
A user identification object for specification with the addUser/removeUser endpoints.
Fields
- user string? - A string identifying a user. This can either be the string "me", an email, or the gid of a user.
asana: TeamCompact
Fields
- Fields Included from *AsanaResource
- name string? - The name of the team.
asana: TeamMembershipCompact
Fields
- Fields Included from *AsanaResource
- user UserCompact? -
- team TeamCompact? -
- is_guest boolean? - Describes if the user is a guest in the team.
- is_limited_access boolean? - Describes if the user has limited access to the team.
- is_admin boolean? - Describes if the user is a team admin.
asana: TeamRemoveUserRequest
A user identification object for specification with the addUser/removeUser endpoints.
Fields
- user string? - A string identifying a user. This can either be the string "me", an email, or the gid of a user.
asana: TeamRequest
Fields
- description string? - The description of the team.
- html_description string? - The description of the team with formatting as HTML.
- organization string? - The organization/workspace the team belongs to. This must be the same organization you are in and cannot be changed once set.
- visibility "secret"|"request_to_join"|"public" ? - The visibility of the team to users in the same organization
- edit_team_name_or_description_access_level "all_team_members"|"only_team_admins" ? - Controls who can edit team name and description
- edit_team_visibility_or_trash_team_access_level "all_team_members"|"only_team_admins" ? - Controls who can edit team visibility and trash teams
- member_invite_management_access_level "all_team_members"|"only_team_admins" ? - Controls who can accept or deny member invites for a given team
- guest_invite_management_access_level "all_team_members"|"only_team_admins" ? - Controls who can accept or deny guest invites for a given team
- join_request_management_access_level "all_team_members"|"only_team_admins" ? - Controls who can accept or deny join team requests for a Membership by Request team
- team_member_removal_access_level "all_team_members"|"only_team_admins" ? - Controls who can remove team members
asana: TeamResponse
Fields
- organization record {}? -
- permalink_url string? - A url that points directly to the object within Asana.
- visibility "secret"|"request_to_join"|"public" ? - The visibility of the team to users in the same organization
- edit_team_name_or_description_access_level "all_team_members"|"only_team_admins" ? - Controls who can edit team name and description
- edit_team_visibility_or_trash_team_access_level "all_team_members"|"only_team_admins" ? - Controls who can edit team visibility and trash teams
- member_invite_management_access_level "all_team_members"|"only_team_admins" ? - Controls who can accept or deny member invites for a given team
- guest_invite_management_access_level "all_team_members"|"only_team_admins" ? - Controls who can accept or deny guest invites for a given team
- join_request_management_access_level "all_team_members"|"only_team_admins" ? - Controls who can accept or deny join team requests for a Membership by Request team
- team_member_removal_access_level "all_team_members"|"only_team_admins" ? - Controls who can remove team members
asana: Teams_body
Fields
- data TeamRequest? -
asana: Teams_team_gid_body
Fields
- data TeamRequest? -
asana: TemplateRole
Fields
- Fields Included from *AsanaResource
- name string? - Name of the template role.
asana: Time_tracking_entries_time_tracking_entry_gid_body
Fields
- data UpdateTimeTrackingEntryRequest? -
asana: TimePeriodBase
Fields
- Fields Included from *TimePeriodCompact
- parent TimePeriodCompact? -
asana: TimePeriodCompact
Fields
- Fields Included from *AsanaResource
- end_on string? - The localized end date of the time period in
YYYY-MM-DD
format.
- start_on string? - The localized start date of the time period in
YYYY-MM-DD
format.
- period "FY"|"H1"|"H2"|"Q1"|"Q2"|"Q3"|"Q4" ? - The cadence and index of the time period. The value is one of:
FY
,H1
,H2
,Q1
,Q2
,Q3
, orQ4
.
- display_name string? - A string representing the cadence code and the fiscal year.
asana: TimeTrackingEntryBase
Fields
- Fields Included from *TimeTrackingEntryCompact
- duration_minutes int
- entered_on string
- created_by UserCompact
- gid string
- resource_type string
- anydata...
- task TaskCompact? -
- created_at string? - The time at which this resource was created.
asana: TimeTrackingEntryCompact
Fields
- Fields Included from *AsanaResource
- duration_minutes int? - Time in minutes tracked by the entry.
- entered_on string? - The day that this entry is logged on.
- created_by UserCompact? -
asana: UpdateTimeTrackingEntryRequest
Fields
- duration_minutes int? - Optional. Time in minutes tracked by the entry
- entered_on string? - Optional. The day that this entry is logged on. Defaults to today if no day specified
asana: UserBaseResponse
Fields
- email string? - The user's email address.
- photo UserBaseResponse_photo? - A map of the user’s profile photo in various sizes, or null if no photo is set. Sizes provided are 21, 27, 36, 60, 128, and 1024. All images are in PNG format, except for 1024 (which is in JPEG format).
asana: UserBaseResponse_photo
A map of the user’s profile photo in various sizes, or null if no photo is set. Sizes provided are 21, 27, 36, 60, 128, and 1024. All images are in PNG format, except for 1024 (which is in JPEG format).
Fields
- image_21x21 string? -
- image_27x27 string? -
- image_36x36 string? -
- image_60x60 string? -
- image_128x128 string? -
- image_1024x1024 string? -
asana: UserCompact
Fields
- Fields Included from *AsanaResource
- name string? - Read-only except when same user as requester. The user’s name.
asana: UserResponse
Fields
- Fields Included from *UserBaseResponse
- email string
- photo UserBaseResponse_photo|()
- name string
- gid string
- resource_type string
- anydata...
- workspaces WorkspaceCompact[]? - Workspaces and organizations this user may access. Note: The API will only return workspaces and organizations that also contain the authenticated user.
asana: UserTaskListCompact
Fields
- Fields Included from *AsanaResource
- name string? - The name of the user task list.
- owner UserCompact? - The owner of the user task list, i.e. the person whose My Tasks is represented by this resource.
- workspace WorkspaceCompact? - The workspace in which the user task list is located.
asana: WebhookCompact
Fields
- Fields Included from *AsanaResource
- active boolean? - If true, the webhook will send events - if false it is considered inactive and will not generate events.
- 'resource AsanaNamedResource? -
- target string? - The URL to receive the HTTP POST.
asana: WebhookFilter
A WebhookFilter can be passed on creation of a webhook in order to filter the types of actions that trigger delivery of an event
Fields
- resource_type string? - The type of the resource which created the event when modified; for example, to filter to changes on regular tasks this field should be set to
task
.
- resource_subtype string? - The resource subtype of the resource that the filter applies to. This should be set to the same value as is returned on the
resource_subtype
field on the resources themselves.
- fields string[]? - Conditional. A whitelist of fields for events which will pass the filter when the resource is changed. These can be any combination of the fields on the resources themselves. This field is only valid for
action
of typechanged
asana: WebhookRequest
Fields
- 'resource string - A resource ID to subscribe to. Many Asana resources are valid to create webhooks on, but higher-level resources require filters.
- target string - The URL to receive the HTTP POST. The full URL will be used to deliver events from this webhook (including parameters) which allows encoding of application-specific state when the webhook is created.
- filters record {}[]? - An array of WebhookFilter objects to specify a whitelist of filters to apply to events from this webhook. If a webhook event passes any of the filters the event will be delivered; otherwise no event will be sent to the receiving server.
asana: WebhookResponse
Fields
- Fields Included from *WebhookCompact
- active boolean
- resource AsanaNamedResource
- target string
- gid string
- resource_type string
- anydata...
- created_at string? - The time at which this resource was created.
- last_failure_at string? - The timestamp when the webhook last received an error when sending an event to the target.
- last_failure_content string? - The contents of the last error response sent to the webhook when attempting to deliver events to the target.
- last_success_at string? - The timestamp when the webhook last successfully sent an event to the target.
- filters record {}[]? - Whitelist of filters to apply to events from this webhook. If a webhook event passes any of the filters the event will be delivered; otherwise no event will be sent to the receiving server.
asana: Webhooks_body
Fields
- data WebhookRequest? -
asana: Webhooks_webhook_gid_body
Fields
- data WebhookUpdateRequest? -
asana: WebhookUpdateRequest
Fields
- filters record {}[]? - An array of WebhookFilter objects to specify a whitelist of filters to apply to events from this webhook. If a webhook event passes any of the filters the event will be delivered; otherwise no event will be sent to the receiving server.
asana: Workspace_gid_addUser_body
Fields
- data WorkspaceAddUserRequest? - A user identification object for specification with the addUser/removeUser endpoints.
asana: Workspace_gid_projects_body
Fields
- data ProjectRequest? -
asana: Workspace_gid_removeUser_body
Fields
- data WorkspaceRemoveUserRequest? - A user identification object for specification with the addUser/removeUser endpoints.
asana: Workspace_gid_tags_body
Fields
- data TagCreateTagForWorkspaceRequest? -
asana: WorkspaceAddUserRequest
A user identification object for specification with the addUser/removeUser endpoints.
Fields
- user string? - A string identifying a user. This can either be the string "me", an email, or the gid of a user.
asana: WorkspaceCompact
Fields
- Fields Included from *AsanaResource
- name string? - The name of the workspace.
asana: WorkspaceMembershipCompact
Fields
- Fields Included from *AsanaResource
- user UserCompact? -
- workspace WorkspaceCompact? -
asana: WorkspaceMembershipResponse
Fields
- user_task_list UserTaskListResponse? -
- is_active boolean? - Reflects if this user still a member of the workspace.
- is_admin boolean? - Reflects if this user is an admin of the workspace.
- is_guest boolean? - Reflects if this user is a guest of the workspace.
- vacation_dates WorkspaceMembershipResponse_vacation_dates? - Contains keys
start_on
andend_on
for the vacation dates for the user in this workspace. Ifstart_on
is null, the entirevacation_dates
object will be null. Ifend_on
is before today, the entirevacation_dates
object will be null.
- created_at string? - The time at which this resource was created.
asana: WorkspaceMembershipResponse_vacation_dates
Contains keys start_on
and end_on
for the vacation dates for the user in this workspace. If start_on
is null, the entire vacation_dates
object will be null. If end_on
is before today, the entire vacation_dates
object will be null.
Fields
- start_on string? - The day on which the user's vacation in this workspace starts. This is a date with
YYYY-MM-DD
format.
- end_on string? - The day on which the user's vacation in this workspace ends, or null if there is no end date. This is a date with
YYYY-MM-DD
format.
asana: WorkspaceRemoveUserRequest
A user identification object for specification with the addUser/removeUser endpoints.
Fields
- user string? - A string identifying a user. This can either be the string "me", an email, or the gid of a user.
asana: WorkspaceResponse
Fields
- email_domains string[]? - The email domains that are associated with this workspace.
- is_organization boolean? - Whether the workspace is an organization.
asana: Workspaces_workspace_gid_body
Fields
- data WorkspaceRequest? -
Union types
asana: MembershipResponse
MembershipResponse
asana: MembershipCompact
MembershipCompact
Simple name reference types
asana: PortfolioMembershipResponse
PortfolioMembershipResponse
asana: ProjectStatusRequest
ProjectStatusRequest
asana: ProjectMembershipBase
ProjectMembershipBase
asana: CustomFieldSettingBase
CustomFieldSettingBase
asana: TaskTemplateBase
TaskTemplateBase
asana: TeamMembershipBase
TeamMembershipBase
asana: ProjectTemplateResponse
ProjectTemplateResponse
asana: UserTaskListRequest
UserTaskListRequest
asana: OrganizationExportBase
OrganizationExportBase
asana: SectionBase
SectionBase
asana: UserRequest
UserRequest
asana: TeamBase
TeamBase
asana: UserBase
UserBase
asana: OrganizationExportResponse
OrganizationExportResponse
asana: WorkspaceBase
WorkspaceBase
asana: UserTaskListBase
UserTaskListBase
asana: GoalMetricRequest
GoalMetricRequest
asana: TimePeriodResponse
TimePeriodResponse
asana: AttachmentBase
AttachmentBase
asana: JobResponse
JobResponse
asana: JobBase
JobBase
asana: StoryRequest
StoryRequest
asana: WorkspaceMembershipRequest
WorkspaceMembershipRequest
asana: WorkspaceRequest
WorkspaceRequest
asana: EnumOptionBase
EnumOptionBase
asana: UserTaskListResponse
UserTaskListResponse
asana: TeamMembershipResponse
TeamMembershipResponse
asana: WorkspaceMembershipBase
WorkspaceMembershipBase
asana: PortfolioMembershipBase
PortfolioMembershipBase
Import
import ballerinax/asana;
Metadata
Released date: 6 months ago
Version: 2.0.0
License: Apache-2.0
Compatibility
Platform: any
Ballerina version: 2201.8.6
GraalVM compatible: Yes
Pull count
Total: 51
Current verison: 0
Weekly downloads
Keywords
Asana
Productivity/Project Management
Cost/Freemium
Task Management
Contributors