{ "opencollection": "1.0.0", "info": { "name": "Asana", "version": "1.0" }, "request": { "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "items": [ { "info": { "name": "Allocations", "type": "folder" }, "items": [ { "info": { "name": "Asana Get an allocation", "type": "http" }, "http": { "method": "GET", "url": "https://app.asana.com/api/1.0/allocations/:allocation_gid", "params": [ { "name": "allocation_gid", "value": "77688", "type": "path", "description": "Globally unique identifier for the allocation." }, { "name": "opt_pretty", "value": "true", "type": "query", "description": "Provides “pretty” output.\nProvides 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." }, { "name": "opt_fields", "value": "assignee,assignee.name,created_by,created_by.name,effort,effort.type,effort.value,end_date,parent,parent.name,resource_subtype,start_date", "type": "query", "description": "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." } ] }, "docs": "Returns the complete allocation record for a single allocation." }, { "info": { "name": "Asana Update an allocation", "type": "http" }, "http": { "method": "PUT", "url": "https://app.asana.com/api/1.0/allocations/:allocation_gid", "params": [ { "name": "allocation_gid", "value": "77688", "type": "path", "description": "Globally unique identifier for the allocation." }, { "name": "opt_pretty", "value": "true", "type": "query", "description": "Provides “pretty” output.\nProvides 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." }, { "name": "opt_fields", "value": "assignee,assignee.name,created_by,created_by.name,effort,effort.type,effort.value,end_date,parent,parent.name,resource_subtype,start_date", "type": "query", "description": "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." } ], "body": { "type": "json", "data": "{}" } }, "docs": "An existing allocation can be updated by making a PUT request on the URL for\nthat allocation. Only the fields provided in the `data` block will be updated;\nany unspecified fields will remain unchanged.\n\nReturns the complete updated allocation record." }, { "info": { "name": "Asana Delete an allocation", "type": "http" }, "http": { "method": "DELETE", "url": "https://app.asana.com/api/1.0/allocations/:allocation_gid", "params": [ { "name": "allocation_gid", "value": "77688", "type": "path", "description": "Globally unique identifier for the allocation." }, { "name": "opt_pretty", "value": "true", "type": "query", "description": "Provides “pretty” output.\nProvides 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." } ] }, "docs": "A specific, existing allocation can be deleted by making a DELETE request on the URL for that allocation.\n\nReturns an empty data record." }, { "info": { "name": "Asana Get multiple allocations", "type": "http" }, "http": { "method": "GET", "url": "https://app.asana.com/api/1.0/allocations", "params": [ { "name": "opt_pretty", "value": "true", "type": "query", "description": "Provides “pretty” output.\nProvides 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." }, { "name": "parent", "value": "77688", "type": "query", "description": "Globally unique identifier for the project to filter allocations by." }, { "name": "assignee", "value": "12345", "type": "query", "description": "Globally unique identifier for the user the allocation is assigned to." }, { "name": "workspace", "value": "98765", "type": "query", "description": "Globally unique identifier for the workspace." }, { "name": "limit", "value": "50", "type": "query", "description": "Results per page.\nThe number of objects to return per page. The value must be between 1 and 100." }, { "name": "offset", "value": "eyJ0eXAiOJiKV1iQLCJhbGciOiJIUzI1NiJ9", "type": "query", "description": "Offset token.\nAn 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.\n*Note: You can only pass in an offset that was returned to you via a previously paginated request.*" }, { "name": "opt_fields", "value": "assignee,assignee.name,created_by,created_by.name,effort,effort.type,effort.value,end_date,offset,parent,parent.name,path,resource_subtype,start_date,uri", "type": "query", "description": "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." } ] }, "docs": "Returns a list of allocations filtered to a specific project or user." }, { "info": { "name": "Asana Create an allocation", "type": "http" }, "http": { "method": "POST", "url": "https://app.asana.com/api/1.0/allocations", "params": [ { "name": "opt_pretty", "value": "true", "type": "query", "description": "Provides “pretty” output.\nProvides 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." }, { "name": "opt_fields", "value": "assignee,assignee.name,created_by,created_by.name,effort,effort.type,effort.value,end_date,parent,parent.name,resource_subtype,start_date", "type": "query", "description": "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." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new allocation.\n\nReturns the full record of the newly created allocation." } ] }, { "info": { "name": "Attachments", "type": "folder" }, "items": [ { "info": { "name": "Asana Get an attachment", "type": "http" }, "http": { "method": "GET", "url": "https://app.asana.com/api/1.0/attachments/:attachment_gid", "params": [ { "name": "attachment_gid", "value": "12345", "type": "path", "description": "Globally unique identifier for the attachment." }, { "name": "opt_pretty", "value": "true", "type": "query", "description": "Provides “pretty” output.\nProvides 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." }, { "name": "opt_fields", "value": "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", "type": "query", "description": "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." } ] }, "docs": "Get the full record for a single attachment." }, { "info": { "name": "Asana Delete an attachment", "type": "http" }, "http": { "method": "DELETE", "url": "https://app.asana.com/api/1.0/attachments/:attachment_gid", "params": [ { "name": "attachment_gid", "value": "12345", "type": "path", "description": "Globally unique identifier for the attachment." }, { "name": "opt_pretty", "value": "true", "type": "query", "description": "Provides “pretty” output.\nProvides 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." } ] }, "docs": "Deletes a specific, existing attachment.\n\nReturns an empty data record." }, { "info": { "name": "Asana Get attachments from an object", "type": "http" }, "http": { "method": "GET", "url": "https://app.asana.com/api/1.0/attachments", "params": [ { "name": "opt_pretty", "value": "true", "type": "query", "description": "Provides “pretty” output.\nProvides 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." }, { "name": "limit", "value": "50", "type": "query", "description": "Results per page.\nThe number of objects to return per page. The value must be between 1 and 100." }, { "name": "offset", "value": "eyJ0eXAiOJiKV1iQLCJhbGciOiJIUzI1NiJ9", "type": "query", "description": "Offset token.\nAn 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.\n*Note: You can only pass in an offset that was returned to you via a previously paginated request.*" }, { "name": "parent", "value": "159874", "type": "query", "description": "Globally unique identifier for object to fetch statuses from. Must be a GID for a `project`, `project_brief`, or `task`." }, { "name": "opt_fields", "value": "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", "type": "query", "description": "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." } ] }, "docs": "Returns the compact records for all attachments on the object.\n\nThere are three possible `parent` values for this request: `project`, `project_brief`, and `task`. For a project, an attachment refers to a file uploaded to the \"Key resources\" section in the project Overview. For a project brief, an attachment refers to inline files in the project brief itself. For a task, an attachment refers to a file directly associated to that task.\n\nNote that within the Asana app, inline images in the task des" }, { "info": { "name": "Asana Upload an attachment", "type": "http" }, "http": { "method": "POST", "url": "https://app.asana.com/api/1.0/attachments", "params": [ { "name": "opt_pretty", "value": "true", "type": "query", "description": "Provides “pretty” output.\nProvides 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." }, { "name": "opt_fields", "value": "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", "type": "query", "description": "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." } ], "body": { "type": "multipart-form", "data": [] }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://app.asana.com/-/oauth_authorize", "accessTokenUrl": "https://app.asana.com/-/oauth_token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Upload an attachment.\n\nThis method uploads an attachment on an object and returns the compact\nrecord for the created attachment object. This is possible by either:\n\n- Providing the URL of the external resource being attached, or\n- Downloading the file content first and then uploading it as any other attachment. Note that it is not possible to attach\nfiles from third party services such as Dropbox, Box, Vimeo & Google Drive via the API\n\nThe 100MB size limit on attachments in Asana is enforced on " } ] }, { "info": { "name": "Audit Log API", "type": "folder" }, "items": [ { "info": { "name": "Asana Get audit log events", "type": "http" }, "http": { "method": "GET", "url": "https://app.asana.com/api/1.0/workspaces/:workspace_gid/audit_log_events", "params": [ { "name": "workspace_gid", "value": "12345", "type": "path", "description": "Globally unique identifier for the workspace or organization." }, { "name": "start_at", "value": "", "type": "query", "description": "Filter to events created after this time (inclusive)." }, { "name": "end_at", "value": "", "type": "query", "description": "Filter to events created before this time (exclusive)." }, { "name": "event_type", "value": "", "type": "query", "description": "Filter to events of this type.\nRefer to the [supported audit log events](/docs/audit-log-events#supported-audit-log-events) for a full list of values." }, { "name": "actor_type", "value": "", "type": "query", "description": "Filter to events with an actor of this type.\nThis only needs to be included if querying for actor types without an ID. If `actor_gid` is included, this should be excluded." }, { "name": "actor_gid", "value": "", "type": "query", "description": "Filter to events triggered by the actor with this ID." }, { "name": "resource_gid", "value": "", "type": "query", "description": "Filter to events with this resource ID." }, { "name": "limit", "value": "50", "type": "query", "description": "Results per page.\nThe number of objects to return per page. The value must be between 1 and 100." }, { "name": "offset", "value": "eyJ0eXAiOJiKV1iQLCJhbGciOiJIUzI1NiJ9", "type": "query", "description": "Offset token.\nAn 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.\n*Note: You can only pass in an offset that was returned to you via a previously paginated request.*" } ] }, "docs": "Retrieve the audit log events that have been captured in your domain.\n\nThis endpoint will return a list of [AuditLogEvent](/reference/audit-log-api) objects, sorted by creation time in ascending order. Note that the Audit Log API captures events from October 8th, 2021 and later. Queries for events before this date will not return results.\n\nThere are a number of query parameters (below) that can be used to filter the set of [AuditLogEvent](/reference/audit-log-api) objects that are returned in th" } ] }, { "info": { "name": "Batch API", "type": "folder" }, "items": [ { "info": { "name": "Asana Submit parallel requests", "type": "http" }, "http": { "method": "POST", "url": "https://app.asana.com/api/1.0/batch", "params": [ { "name": "opt_pretty", "value": "true", "type": "query", "description": "Provides “pretty” output.\nProvides 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." }, { "name": "opt_fields", "value": "body,headers,status_code", "type": "query", "description": "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." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Make multiple requests in parallel to Asana's API." } ] }, { "info": { "name": "Custom Field Settings", "type": "folder" }, "items": [ { "info": { "name": "Asana Get a project's custom fields", "type": "http" }, "http": { "method": "GET", "url": "https://app.asana.com/api/1.0/projects/:project_gid/custom_field_settings", "params": [ { "name": "project_gid", "value": "1331", "type": "path", "description": "Globally unique identifier for the project." }, { "name": "opt_pretty", "value": "true", "type": "query", "description": "Provides “pretty” output.\nProvides 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." }, { "name": "limit", "value": "50", "type": "query", "description": "Results per page.\nThe number of objects to return per page. The value must be between 1 and 100." }, { "name": "offset", "value": "eyJ0eXAiOJiKV1iQLCJhbGciOiJIUzI1NiJ9", "type": "query", "description": "Offset token.\nAn 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.\n*Note: You can only pass in an offset that was returned to you via a previously paginated request.*" }, { "name": "opt_fields", "value": "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", "type": "query", "description": "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." } ] }, "docs": "Returns a list of all of the custom fields settings on a project, in compact form. Note that, as in all queries to collections which return compact representation, `opt_fields` can be used to include more data than is returned in the compact representation. See the [documentation for input/output options](https://developers.asana.com/docs/inputoutput-options) for more information." }, { "info": { "name": "Asana Get a portfolio's custom fields", "type": "http" }, "http": { "method": "GET", "url": "https://app.asana.com/api/1.0/portfolios/:portfolio_gid/custom_field_settings", "params": [ { "name": "portfolio_gid", "value": "12345", "type": "path", "description": "Globally unique identifier for the portfolio." }, { "name": "opt_pretty", "value": "true", "type": "query", "description": "Provides “pretty” output.\nProvides 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." }, { "name": "limit", "value": "50", "type": "query", "description": "Results per page.\nThe number of objects to return per page. The value must be between 1 and 100." }, { "name": "offset", "value": "eyJ0eXAiOJiKV1iQLCJhbGciOiJIUzI1NiJ9", "type": "query", "description": "Offset token.\nAn 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.\n*Note: You can only pass in an offset that was returned to you via a previously paginated request.*" }, { "name": "opt_fields", "value": "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", "type": "query", "description": "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." } ] }, "docs": "Returns a list of all of the custom fields settings on a portfolio, in compact form." } ] }, { "info": { "name": "Custom Fields", "type": "folder" }, "items": [ { "info": { "name": "Asana Create a custom field", "type": "http" }, "http": { "method": "POST", "url": "https://app.asana.com/api/1.0/custom_fields", "params": [ { "name": "opt_pretty", "value": "true", "type": "query", "description": "Provides “pretty” output.\nProvides 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." }, { "name": "opt_fields", "value": "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", "type": "query", "description": "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." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new custom field in a workspace. Every custom field is required\nto be created in a specific workspace, and this workspace cannot be\nchanged once set.\n\nA custom field’s name must be unique within a workspace and not conflict\nwith names of existing task properties such as `Due Date` or `Assignee`.\nA custom field’s type must be one of `text`, `enum`, `multi_enum`, `number`,\n`date`, or `people`.\n\nReturns the full record of the newly created custom field." }, { "info": { "name": "Asana Get a custom field", "type": "http" }, "http": { "method": "GET", "url": "https://app.asana.com/api/1.0/custom_fields/:custom_field_gid", "params": [ { "name": "custom_field_gid", "value": "12345", "type": "path", "description": "Globally unique identifier for the custom field." }, { "name": "opt_pretty", "value": "true", "type": "query", "description": "Provides “pretty” output.\nProvides 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." }, { "name": "opt_fields", "value": "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", "type": "query", "description": "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." } ] }, "docs": "Get the complete definition of a custom field’s metadata.\n\nSince custom fields can be defined for one of a number of types, and\nthese types have different data and behaviors, there are fields that are\nrelevant to a particular type. For instance, as noted above, enum_options\nis only relevant for the enum type and defines the set of choices that\nthe enum could represent. The examples below show some of these\ntype-specific custom field definitions." }, { "info": { "name": "Asana Update a custom field", "type": "http" }, "http": { "method": "PUT", "url": "https://app.asana.com/api/1.0/custom_fields/:custom_field_gid", "params": [ { "name": "custom_field_gid", "value": "12345", "type": "path", "description": "Globally unique identifier for the custom field." }, { "name": "opt_pretty", "value": "true", "type": "query", "description": "Provides “pretty” output.\nProvides 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." }, { "name": "opt_fields", "value": "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", "type": "query", "description": "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." } ], "body": { "type": "json", "data": "{}" } }, "docs": "A specific, existing custom field can be updated by making a PUT request on the URL for that custom field. Only the fields provided in the `data` block will be updated; any unspecified fields will remain unchanged\nWhen using this method, it is best to specify only those fields you wish to change, or else you may overwrite changes made by another user since you last retrieved the custom field.\nA custom field’s `type` cannot be updated.\nAn enum custom field’s `enum_options` cannot be updated with " }, { "info": { "name": "Asana Delete a custom field", "type": "http" }, "http": { "method": "DELETE", "url": "https://app.asana.com/api/1.0/custom_fields/:custom_field_gid", "params": [ { "name": "custom_field_gid", "value": "12345", "type": "path", "description": "Globally unique identifier for the custom field." }, { "name": "opt_pretty", "value": "true", "type": "query", "description": "Provides “pretty” output.\nProvides 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." } ] }, "docs": "A specific, existing custom field can be deleted by making a DELETE request on the URL for that custom field.\nLocked custom fields can only be deleted by the user who locked the field.\nReturns an empty data record." }, { "info": { "name": "Asana Get a workspace's custom fields", "type": "http" }, "http": { "method": "GET", "url": "https://app.asana.com/api/1.0/workspaces/:workspace_gid/custom_fields", "params": [ { "name": "workspace_gid", "value": "12345", "type": "path", "description": "Globally unique identifier for the workspace or organization." }, { "name": "opt_pretty", "value": "true", "type": "query", "description": "Provides “pretty” output.\nProvides 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." }, { "name": "limit", "value": "50", "type": "query", "description": "Results per page.\nThe number of objects to return per page. The value must be between 1 and 100." }, { "name": "offset", "value": "eyJ0eXAiOJiKV1iQLCJhbGciOiJIUzI1NiJ9", "type": "query", "description": "Offset token.\nAn 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.\n*Note: You can only pass in an offset that was returned to you via a previously paginated request.*" }, { "name": "opt_fields", "value": "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", "type": "query", "description": "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." } ] }, "docs": "Returns a list of the compact representation of all of the custom fields in a workspace." }, { "info": { "name": "Asana Create an enum option", "type": "http" }, "http": { "method": "POST", "url": "https://app.asana.com/api/1.0/custom_fields/:custom_field_gid/enum_options", "params": [ { "name": "custom_field_gid", "value": "12345", "type": "path", "description": "Globally unique identifier for the custom field." }, { "name": "opt_pretty", "value": "true", "type": "query", "description": "Provides “pretty” output.\nProvides 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." }, { "name": "opt_fields", "value": "color,enabled,name", "type": "query", "description": "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." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates an enum option and adds it to this custom field’s list of enum options. A custom field can have at most 500 enum options (including disabled options). By default new enum options are inserted at the end of a custom field’s list.\nLocked custom fields can only have enum options added by the user who locked the field.\nReturns the full record of the newly created enum option." }, { "info": { "name": "Asana Reorder a custom field's enum", "type": "http" }, "http": { "method": "POST", "url": "https://app.asana.com/api/1.0/custom_fields/:custom_field_gid/enum_options/insert", "params": [ { "name": "custom_field_gid", "value": "12345", "type": "path", "description": "Globally unique identifier for the custom field." }, { "name": "opt_pretty", "value": "true", "type": "query", "description": "Provides “pretty” output.\nProvides 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." }, { "name": "opt_fields", "value": "color,enabled,name", "type": "query", "description": "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." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves a particular enum option to be either before or after another specified enum option in the custom field.\nLocked custom fields can only be reordered by the user who locked the field." }, { "info": { "name": "Asana Update an enum option", "type": "http" }, "http": { "method": "PUT", "url": "https://app.asana.com/api/1.0/enum_options/:enum_option_gid", "params": [ { "name": "enum_option_gid", "value": "124578", "type": "path", "description": "Globally unique identifier for the enum option." }, { "name": "opt_pretty", "value": "true", "type": "query", "description": "Provides “pretty” output.\nProvides 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." }, { "name": "opt_fields", "value": "color,enabled,name", "type": "query", "description": "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." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates an existing enum option. Enum custom fields require at least one enabled enum option.\nLocked custom fields can only be updated by the user who locked the field.\nReturns the full record of the updated enum option." } ] }, { "info": { "name": "Events", "type": "folder" }, "items": [ { "info": { "name": "Asana Get events on a resource", "type": "http" }, "http": { "method": "GET", "url": "https://app.asana.com/api/1.0/events", "params": [ { "name": "resource", "value": "12345", "type": "query", "description": "A resource ID to subscribe to. The resource can be a task, project, or goal." }, { "name": "sync", "value": "de4774f6915eae04714ca93bb2f5ee81", "type": "query", "description": "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.\n*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.*" }, { "name": "opt_pretty", "value": "true", "type": "query", "description": "Provides “pretty” output.\nProvides 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." }, { "name": "opt_fields", "value": "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", "type": "query", "description": "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." } ] }, "docs": "Returns the full record for all events that have occurred since the sync\ntoken was created.\n\nA `GET` request to the endpoint `/[path_to_resource]/events` can be made in\nlieu of including the resource ID in the data for the request.\n\nAsana limits a single sync token to 100 events. If more than 100 events exist\nfor a given resource, `has_more: true` will be returned in the response, indicating\nthat there are more events to pull.\n\n*Note: The resource returned will be the resource that triggered the" } ] }, { "info": { "name": "Goal Relationships", "type": "folder" }, "items": [ { "info": { "name": "Asana Get a goal relationship", "type": "http" }, "http": { "method": "GET", "url": "https://app.asana.com/api/1.0/goal_relationships/:goal_relationship_gid", "params": [ { "name": "goal_relationship_gid", "value": "12345", "type": "path", "description": "Globally unique identifier for the goal relationship." }, { "name": "opt_pretty", "value": "true", "type": "query", "description": "Provides “pretty” output.\nProvides 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." }, { "name": "opt_fields", "value": "contribution_weight,resource_subtype,supported_goal,supported_goal.name,supported_goal.owner,supported_goal.owner.name,supporting_resource,supporting_resource.name", "type": "query", "description": "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." } ] }, "docs": "Returns the complete updated goal relationship record for a single goal relationship." }, { "info": { "name": "Asana Update a goal relationship", "type": "http" }, "http": { "method": "PUT", "url": "https://app.asana.com/api/1.0/goal_relationships/:goal_relationship_gid", "params": [ { "name": "goal_relationship_gid", "value": "12345", "type": "path", "description": "Globally unique identifier for the goal relationship." }, { "name": "opt_pretty", "value": "true", "type": "query", "description": "Provides “pretty” output.\nProvides 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." }, { "name": "opt_fields", "value": "contribution_weight,resource_subtype,supported_goal,supported_goal.name,supported_goal.owner,supported_goal.owner.name,supporting_resource,supporting_resource.name", "type": "query", "description": "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." } ], "body": { "type": "json", "data": "{}" } }, "docs": "An existing goal relationship can be updated by making a PUT request on the URL for\nthat goal relationship. Only the fields provided in the `data` block will be updated;\nany unspecified fields will remain unchanged.\n\nReturns the complete updated goal relationship record." }, { "info": { "name": "Asana Get goal relationships", "type": "http" }, "http": { "method": "GET", "url": "https://app.asana.com/api/1.0/goal_relationships", "params": [ { "name": "opt_pretty", "value": "true", "type": "query", "description": "Provides “pretty” output.\nProvides 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." }, { "name": "limit", "value": "50", "type": "query", "description": "Results per page.\nThe number of objects to return per page. The value must be between 1 and 100." }, { "name": "offset", "value": "eyJ0eXAiOJiKV1iQLCJhbGciOiJIUzI1NiJ9", "type": "query", "description": "Offset token.\nAn 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.\n*Note: You can only pass in an offset that was returned to you via a previously paginated request.*" }, { "name": "supported_goal", "value": "12345", "type": "query", "description": "Globally unique identifier for the supported goal in the goal relationship." }, { "name": "resource_subtype", "value": "subgoal", "type": "query", "description": "If provided, filter to goal relationships with a given resource_subtype." }, { "name": "opt_fields", "value": "contribution_weight,offset,path,resource_subtype,supported_goal,supported_goal.name,supported_goal.owner,supported_goal.owner.name,supporting_resource,supporting_resource.name,uri", "type": "query", "description": "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." } ] }, "docs": "Returns compact goal relationship records." }, { "info": { "name": "Asana Add a supporting goal relationship", "type": "http" }, "http": { "method": "POST", "url": "https://app.asana.com/api/1.0/goals/:goal_gid/addSupportingRelationship", "params": [ { "name": "goal_gid", "value": "12345", "type": "path", "description": "Globally unique identifier for the goal." }, { "name": "opt_pretty", "value": "true", "type": "query", "description": "Provides “pretty” output.\nProvides 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." }, { "name": "opt_fields", "value": "contribution_weight,resource_subtype,supported_goal,supported_goal.name,supported_goal.owner,supported_goal.owner.name,supporting_resource,supporting_resource.name", "type": "query", "description": "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." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a goal relationship by adding a supporting resource to a given goal.\n\nReturns the newly created goal relationship record." }, { "info": { "name": "Asana Removes a supporting goal relationship", "type": "http" }, "http": { "method": "POST", "url": "https://app.asana.com/api/1.0/goals/:goal_gid/removeSupportingRelationship", "params": [ { "name": "goal_gid", "value": "12345", "type": "path", "description": "Globally unique identifier for the goal." }, { "name": "opt_pretty", "value": "true", "type": "query", "description": "Provides “pretty” output.\nProvides 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." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Removes a goal relationship for a given parent goal." } ] }, { "info": { "name": "Goals", "type": "folder" }, "items": [ { "info": { "name": "Asana Get a goal", "type": "http" }, "http": { "method": "GET", "url": "https://app.asana.com/api/1.0/goals/:goal_gid", "params": [ { "name": "goal_gid", "value": "12345", "type": "path", "description": "Globally unique identifier for the goal." }, { "name": "opt_pretty", "value": "true", "type": "query", "description": "Provides “pretty” output.\nProvides 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." }, { "name": "opt_fields", "value": "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.is_custom_weight,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", "type": "query", "description": "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." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://app.asana.com/-/oauth_authorize", "accessTokenUrl": "https://app.asana.com/-/oauth_token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Returns the complete goal record for a single goal." }, { "info": { "name": "Asana Update a goal", "type": "http" }, "http": { "method": "PUT", "url": "https://app.asana.com/api/1.0/goals/:goal_gid", "params": [ { "name": "goal_gid", "value": "12345", "type": "path", "description": "Globally unique identifier for the goal." }, { "name": "opt_pretty", "value": "true", "type": "query", "description": "Provides “pretty” output.\nProvides 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." }, { "name": "opt_fields", "value": "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.is_custom_weight,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", "type": "query", "description": "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." } ], "body": { "type": "json", "data": "{}" } }, "docs": "An existing goal can be updated by making a PUT request on the URL for\nthat goal. Only the fields provided in the `data` block will be updated;\nany unspecified fields will remain unchanged.\n\nReturns the complete updated goal record." }, { "info": { "name": "Asana Delete a goal", "type": "http" }, "http": { "method": "DELETE", "url": "https://app.asana.com/api/1.0/goals/:goal_gid", "params": [ { "name": "goal_gid", "value": "12345", "type": "path", "description": "Globally unique identifier for the goal." }, { "name": "opt_pretty", "value": "true", "type": "query", "description": "Provides “pretty” output.\nProvides 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." } ] }, "docs": "A specific, existing goal can be deleted by making a DELETE request on the URL for that goal.\n\nReturns an empty data record." }, { "info": { "name": "Asana Get goals", "type": "http" }, "http": { "method": "GET", "url": "https://app.asana.com/api/1.0/goals", "params": [ { "name": "opt_pretty", "value": "true", "type": "query", "description": "Provides “pretty” output.\nProvides 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." }, { "name": "portfolio", "value": "159874", "type": "query", "description": "Globally unique identifier for supporting portfolio." }, { "name": "project", "value": "512241", "type": "query", "description": "Globally unique identifier for supporting project." }, { "name": "task", "value": "78424", "type": "query", "description": "Globally unique identifier for supporting task." }, { "name": "is_workspace_level", "value": "false", "type": "query", "description": "Filter to goals with is_workspace_level set to query value. Must be used with the workspace parameter." }, { "name": "team", "value": "31326", "type": "query", "description": "Globally unique identifier for the team." }, { "name": "workspace", "value": "31326", "type": "query", "description": "Globally unique identifier for the workspace." }, { "name": "time_periods", "value": "221693,506165", "type": "query", "description": "Globally unique identifiers for the time periods." }, { "name": "limit", "value": "50", "type": "query", "description": "Results per page.\nThe number of objects to return per page. The value must be between 1 and 100." }, { "name": "offset", "value": "eyJ0eXAiOJiKV1iQLCJhbGciOiJIUzI1NiJ9", "type": "query", "description": "Offset token.\nAn 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.\n*Note: You can only pass in an offset that was returned to you via a previously paginated request.*" }, { "name": "opt_fields", "value": "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.is_custom_weight,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", "type": "query", "description": "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." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://app.asana.com/-/oauth_authorize", "accessTokenUrl": "https://app.asana.com/-/oauth_token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Returns compact goal records." }, { "info": { "name": "Asana Create a goal", "type": "http" }, "http": { "method": "POST", "url": "https://app.asana.com/api/1.0/goals", "params": [ { "name": "opt_pretty", "value": "true", "type": "query", "description": "Provides “pretty” output.\nProvides 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." }, { "name": "opt_fields", "value": "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.is_custom_weight,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", "type": "query", "description": "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." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new goal in a workspace or team.\n\nReturns the full record of the newly created goal." }, { "info": { "name": "Asana Create a goal metric", "type": "http" }, "http": { "method": "POST", "url": "https://app.asana.com/api/1.0/goals/:goal_gid/setMetric", "params": [ { "name": "goal_gid", "value": "12345", "type": "path", "description": "Globally unique identifier for the goal." }, { "name": "opt_pretty", "value": "true", "type": "query", "description": "Provides “pretty” output.\nProvides 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." }, { "name": "opt_fields", "value": "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.is_custom_weight,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", "type": "query", "description": "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." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates and adds a goal metric to a specified goal. Note that this replaces an existing goal metric if one already exists." }, { "info": { "name": "Asana Update a goal metric", "type": "http" }, "http": { "method": "POST", "url": "https://app.asana.com/api/1.0/goals/:goal_gid/setMetricCurrentValue", "params": [ { "name": "goal_gid", "value": "12345", "type": "path", "description": "Globally unique identifier for the goal." }, { "name": "opt_pretty", "value": "true", "type": "query", "description": "Provides “pretty” output.\nProvides 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." }, { "name": "opt_fields", "value": "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.is_custom_weight,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", "type": "query", "description": "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." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a goal's existing metric's `current_number_value` if one exists,\notherwise responds with a 400 status code.\n\nReturns the complete updated goal metric record." }, { "info": { "name": "Asana Add a collaborator to a goal", "type": "http" }, "http": { "method": "POST", "url": "https://app.asana.com/api/1.0/goals/:goal_gid/addFollowers", "params": [ { "name": "goal_gid", "value": "12345", "type": "path", "description": "Globally unique identifier for the goal." }, { "name": "opt_pretty", "value": "true", "type": "query", "description": "Provides “pretty” output.\nProvides 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." }, { "name": "opt_fields", "value": "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.is_custom_weight,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", "type": "query", "description": "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." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Adds followers to a goal. Returns the goal the followers were added to.\nEach goal can be associated with zero or more followers in the system.\nRequests to add/remove followers, if successful, will return the complete updated goal record, described above." }, { "info": { "name": "Asana Remove a collaborator from a goal", "type": "http" }, "http": { "method": "POST", "url": "https://app.asana.com/api/1.0/goals/:goal_gid/removeFollowers", "params": [ { "name": "goal_gid", "value": "12345", "type": "path", "description": "Globally unique identifier for the goal." }, { "name": "opt_pretty", "value": "true", "type": "query", "description": "Provides “pretty” output.\nProvides 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." }, { "name": "opt_fields", "value": "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.is_custom_weight,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", "type": "query", "description": "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." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Removes followers from a goal. Returns the goal the followers were removed from.\nEach goal can be associated with zero or more followers in the system.\nRequests to add/remove followers, if successful, will return the complete updated goal record, described above." }, { "info": { "name": "Asana Get parent goals from a goal", "type": "http" }, "http": { "method": "GET", "url": "https://app.asana.com/api/1.0/goals/:goal_gid/parentGoals", "params": [ { "name": "goal_gid", "value": "12345", "type": "path", "description": "Globally unique identifier for the goal." }, { "name": "opt_pretty", "value": "true", "type": "query", "description": "Provides “pretty” output.\nProvides 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." }, { "name": "opt_fields", "value": "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.is_custom_weight,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", "type": "query", "description": "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." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://app.asana.com/-/oauth_authorize", "accessTokenUrl": "https://app.asana.com/-/oauth_token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Returns a compact representation of all of the parent goals of a goal." } ] }, { "info": { "name": "Jobs", "type": "folder" }, "items": [ { "info": { "name": "Asana Get a job by id", "type": "http" }, "http": { "method": "GET", "url": "https://app.asana.com/api/1.0/jobs/:job_gid", "params": [ { "name": "job_gid", "value": "12345", "type": "path", "description": "Globally unique identifier for the job." }, { "name": "opt_pretty", "value": "true", "type": "query", "description": "Provides “pretty” output.\nProvides 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." }, { "name": "opt_fields", "value": "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", "type": "query", "description": "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." } ] }, "docs": "Returns the full record for a job." } ] }, { "info": { "name": "Memberships", "type": "folder" }, "items": [ { "info": { "name": "Asana Get multiple memberships", "type": "http" }, "http": { "method": "GET", "url": "https://app.asana.com/api/1.0/memberships", "params": [ { "name": "opt_pretty", "value": "true", "type": "query", "description": "Provides “pretty” output.\nProvides 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." }, { "name": "parent", "value": "159874", "type": "query", "description": "Globally unique identifier for `goal`, `project`, or `portfolio`." }, { "name": "member", "value": "1061493", "type": "query", "description": "Globally unique identifier for `team` or `user`." }, { "name": "limit", "value": "50", "type": "query", "description": "Results per page.\nThe number of objects to return per page. The value must be between 1 and 100." }, { "name": "offset", "value": "eyJ0eXAiOJiKV1iQLCJhbGciOiJIUzI1NiJ9", "type": "query", "description": "Offset token.\nAn 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.\n*Note: You can only pass in an offset that was returned to you via a previously paginated request.*" }, { "name": "opt_fields", "value": "offset,path,uri", "type": "query", "description": "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." } ] }, "docs": "Returns compact `goal_membership`, `project_membership`, or `portfolio_membership` records. The possible types for `parent` in this request are `goal`, `project`, or `portfolio`. An additional member (user GID or team GID) can be passed in to filter to a specific membership. Teams are not supported for portfolios yet." }, { "info": { "name": "Asana Create a membership", "type": "http" }, "http": { "method": "POST", "url": "https://app.asana.com/api/1.0/memberships", "params": [ { "name": "opt_pretty", "value": "true", "type": "query", "description": "Provides “pretty” output.\nProvides 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." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new membership in a `goal`, `project`, or `portfolio`. Teams or users can be members of `goals` or `projects`. Portfolios only support `users` as members.\n\nReturns the full record of the newly created membership." }, { "info": { "name": "Asana Get a membership", "type": "http" }, "http": { "method": "GET", "url": "https://app.asana.com/api/1.0/memberships/:membership_gid", "params": [ { "name": "membership_gid", "value": "12345", "type": "path", "description": "Globally unique identifier for the membership." }, { "name": "opt_pretty", "value": "true", "type": "query", "description": "Provides “pretty” output.\nProvides 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." }, { "name": "opt_fields", "value": "access_level,member,member.name,parent,parent.name,resource_subtype", "type": "query", "description": "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." } ] }, "docs": "Returns compact `project_membership` record for a single membership. `GET` only supports project memberships currently" }, { "info": { "name": "Asana Update a membership", "type": "http" }, "http": { "method": "PUT", "url": "https://app.asana.com/api/1.0/memberships/:membership_gid", "params": [ { "name": "membership_gid", "value": "12345", "type": "path", "description": "Globally unique identifier for the membership." }, { "name": "opt_pretty", "value": "true", "type": "query", "description": "Provides “pretty” output.\nProvides 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." } ], "body": { "type": "json", "data": "{}" } }, "docs": "An existing membership can be updated by making a `PUT` request on the membership. Only the fields provided in the `data` block will be updated;\nany unspecified fields will remain unchanged. Memberships on `goals`, `projects` and `portfolios` can be updated.\n\nReturns the full record of the updated membership." }, { "info": { "name": "Asana Delete a membership", "type": "http" }, "http": { "method": "DELETE", "url": "https://app.asana.com/api/1.0/memberships/:membership_gid", "params": [ { "name": "membership_gid", "value": "12345", "type": "path", "description": "Globally unique identifier for the membership." }, { "name": "opt_pretty", "value": "true", "type": "query", "description": "Provides “pretty” output.\nProvides 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." } ] }, "docs": "A specific, existing membership for a `goal`, `project` and `portfolio` can be deleted by making a `DELETE` request\non the URL for that membership.\n\nReturns an empty data record." } ] }, { "info": { "name": "Organization Exports", "type": "folder" }, "items": [ { "info": { "name": "Asana Create an organization export request", "type": "http" }, "http": { "method": "POST", "url": "https://app.asana.com/api/1.0/organization_exports", "params": [ { "name": "opt_pretty", "value": "true", "type": "query", "description": "Provides “pretty” output.\nProvides 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." }, { "name": "opt_fields", "value": "created_at,download_url,organization,organization.name,state", "type": "query", "description": "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." } ], "body": { "type": "json", "data": "{}" } }, "docs": "This method creates a request to export an Organization. Asana will complete the export at some point after you create the request." }, { "info": { "name": "Asana Get details on an org export request", "type": "http" }, "http": { "method": "GET", "url": "https://app.asana.com/api/1.0/organization_exports/:organization_export_gid", "params": [ { "name": "organization_export_gid", "value": "12345", "type": "path", "description": "Globally unique identifier for the organization export." }, { "name": "opt_pretty", "value": "true", "type": "query", "description": "Provides “pretty” output.\nProvides 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." }, { "name": "opt_fields", "value": "created_at,download_url,organization,organization.name,state", "type": "query", "description": "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." } ] }, "docs": "Returns details of a previously-requested Organization export." } ] }, { "info": { "name": "Portfolio Memberships", "type": "folder" }, "items": [ { "info": { "name": "Asana Get multiple portfolio memberships", "type": "http" }, "http": { "method": "GET", "url": "https://app.asana.com/api/1.0/portfolio_memberships", "params": [ { "name": "portfolio", "value": "12345", "type": "query", "description": "The portfolio to filter results on." }, { "name": "workspace", "value": "12345", "type": "query", "description": "The workspace to filter results on." }, { "name": "user", "value": "me", "type": "query", "description": "A string identifying a user. This can either be the string \"me\", an email, or the gid of a user." }, { "name": "opt_pretty", "value": "true", "type": "query", "description": "Provides “pretty” output.\nProvides 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." }, { "name": "limit", "value": "50", "type": "query", "description": "Results per page.\nThe number of objects to return per page. The value must be between 1 and 100." }, { "name": "offset", "value": "eyJ0eXAiOJiKV1iQLCJhbGciOiJIUzI1NiJ9", "type": "query", "description": "Offset token.\nAn 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.\n*Note: You can only pass in an offset that was returned to you via a previously paginated request.*" }, { "name": "opt_fields", "value": "access_level,offset,path,portfolio,portfolio.name,uri,user,user.name", "type": "query", "description": "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." } ] }, "docs": "Returns a list of portfolio memberships in compact representation. You must specify `portfolio`, `portfolio` and `user`, or `workspace` and `user`." }, { "info": { "name": "Asana Get a portfolio membership", "type": "http" }, "http": { "method": "GET", "url": "https://app.asana.com/api/1.0/portfolio_memberships/:portfolio_membership_gid", "params": [ { "name": "portfolio_membership_gid", "value": "1331", "type": "path" }, { "name": "opt_pretty", "value": "true", "type": "query", "description": "Provides “pretty” output.\nProvides 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." }, { "name": "opt_fields", "value": "access_level,portfolio,portfolio.name,user,user.name", "type": "query", "description": "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." } ] }, "docs": "Returns the complete portfolio record for a single portfolio membership." }, { "info": { "name": "Asana Get memberships from a portfolio", "type": "http" }, "http": { "method": "GET", "url": "https://app.asana.com/api/1.0/portfolios/:portfolio_gid/portfolio_memberships", "params": [ { "name": "portfolio_gid", "value": "12345", "type": "path", "description": "Globally unique identifier for the portfolio." }, { "name": "user", "value": "me", "type": "query", "description": "A string identifying a user. This can either be the string \"me\", an email, or the gid of a user." }, { "name": "opt_pretty", "value": "true", "type": "query", "description": "Provides “pretty” output.\nProvides 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." }, { "name": "limit", "value": "50", "type": "query", "description": "Results per page.\nThe number of objects to return per page. The value must be between 1 and 100." }, { "name": "offset", "value": "eyJ0eXAiOJiKV1iQLCJhbGciOiJIUzI1NiJ9", "type": "query", "description": "Offset token.\nAn 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.\n*Note: You can only pass in an offset that was returned to you via a previously paginated request.*" }, { "name": "opt_fields", "value": "access_level,offset,path,portfolio,portfolio.name,uri,user,user.name", "type": "query", "description": "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." } ] }, "docs": "Returns the compact portfolio membership records for the portfolio." } ] }, { "info": { "name": "Portfolios", "type": "folder" }, "items": [ { "info": { "name": "Asana Get multiple portfolios", "type": "http" }, "http": { "method": "GET", "url": "https://app.asana.com/api/1.0/portfolios", "params": [ { "name": "opt_pretty", "value": "true", "type": "query", "description": "Provides “pretty” output.\nProvides 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." }, { "name": "limit", "value": "50", "type": "query", "description": "Results per page.\nThe number of objects to return per page. The value must be between 1 and 100." }, { "name": "offset", "value": "eyJ0eXAiOJiKV1iQLCJhbGciOiJIUzI1NiJ9", "type": "query", "description": "Offset token.\nAn 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.\n*Note: You can only pass in an offset that was returned to you via a previously paginated request.*" }, { "name": "workspace", "value": "1331", "type": "query", "description": "The workspace or organization to filter portfolios on." }, { "name": "owner", "value": "14916", "type": "query", "description": "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." }, { "name": "opt_fields", "value": "archived,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,default_access_level,due_on,members,members.name,name,offset,owner,owner.name,path,permalink_url,privacy_setting,project_templates,project_templates.name,public,start_on,uri,workspace,workspace.name", "type": "query", "description": "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." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://app.asana.com/-/oauth_authorize", "accessTokenUrl": "https://app.asana.com/-/oauth_token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Returns a list of the portfolios in compact representation that are owned by the current API user." }, { "info": { "name": "Asana Create a portfolio", "type": "http" }, "http": { "method": "POST", "url": "https://app.asana.com/api/1.0/portfolios", "params": [ { "name": "opt_pretty", "value": "true", "type": "query", "description": "Provides “pretty” output.\nProvides 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." }, { "name": "opt_fields", "value": "archived,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,default_access_level,due_on,members,members.name,name,owner,owner.name,permalink_url,privacy_setting,project_templates,project_templates.name,public,start_on,workspace,workspace.name", "type": "query", "description": "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." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new portfolio in the given workspace with the supplied name.\n\nNote that portfolios created in the Asana UI may have some state\n(like the “Priority” custom field) which is automatically added\nto the portfolio when it is created. Portfolios created via our\nAPI will *not* be created with the same initial state to allow\nintegrations to create their own starting state on a portfolio." }, { "info": { "name": "Asana Get a portfolio", "type": "http" }, "http": { "method": "GET", "url": "https://app.asana.com/api/1.0/portfolios/:portfolio_gid", "params": [ { "name": "portfolio_gid", "value": "12345", "type": "path", "description": "Globally unique identifier for the portfolio." }, { "name": "opt_pretty", "value": "true", "type": "query", "description": "Provides “pretty” output.\nProvides 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." }, { "name": "opt_fields", "value": "archived,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,default_access_level,due_on,members,members.name,name,owner,owner.name,permalink_url,privacy_setting,project_templates,project_templates.name,public,start_on,workspace,workspace.name", "type": "query", "description": "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." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://app.asana.com/-/oauth_authorize", "accessTokenUrl": "https://app.asana.com/-/oauth_token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Returns the complete portfolio record for a single portfolio." }, { "info": { "name": "Asana Update a portfolio", "type": "http" }, "http": { "method": "PUT", "url": "https://app.asana.com/api/1.0/portfolios/:portfolio_gid", "params": [ { "name": "portfolio_gid", "value": "12345", "type": "path", "description": "Globally unique identifier for the portfolio." }, { "name": "opt_pretty", "value": "true", "type": "query", "description": "Provides “pretty” output.\nProvides 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." }, { "name": "opt_fields", "value": "archived,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,default_access_level,due_on,members,members.name,name,owner,owner.name,permalink_url,privacy_setting,project_templates,project_templates.name,public,start_on,workspace,workspace.name", "type": "query", "description": "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." } ], "body": { "type": "json", "data": "{}" } }, "docs": "An existing portfolio can be updated by making a PUT request on the URL for\nthat portfolio. Only the fields provided in the `data` block will be updated;\nany unspecified fields will remain unchanged.\n\nReturns the complete updated portfolio record." }, { "info": { "name": "Asana Delete a portfolio", "type": "http" }, "http": { "method": "DELETE", "url": "https://app.asana.com/api/1.0/portfolios/:portfolio_gid", "params": [ { "name": "portfolio_gid", "value": "12345", "type": "path", "description": "Globally unique identifier for the portfolio." }, { "name": "opt_pretty", "value": "true", "type": "query", "description": "Provides “pretty” output.\nProvides 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." } ] }, "docs": "An existing portfolio can be deleted by making a DELETE request on\nthe URL for that portfolio.\n\nReturns an empty data record." }, { "info": { "name": "Asana Get portfolio items", "type": "http" }, "http": { "method": "GET", "url": "https://app.asana.com/api/1.0/portfolios/:portfolio_gid/items", "params": [ { "name": "portfolio_gid", "value": "12345", "type": "path", "description": "Globally unique identifier for the portfolio." }, { "name": "opt_pretty", "value": "true", "type": "query", "description": "Provides “pretty” output.\nProvides 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." }, { "name": "limit", "value": "50", "type": "query", "description": "Results per page.\nThe number of objects to return per page. The value must be between 1 and 100." }, { "name": "offset", "value": "eyJ0eXAiOJiKV1iQLCJhbGciOiJIUzI1NiJ9", "type": "query", "description": "Offset token.\nAn 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.\n*Note: You can only pass in an offset that was returned to you via a previously paginated request.*" }, { "name": "opt_fields", "value": "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", "type": "query", "description": "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." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://app.asana.com/-/oauth_authorize", "accessTokenUrl": "https://app.asana.com/-/oauth_token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Get a list of the items in compact form in a portfolio." }, { "info": { "name": "Asana Add a portfolio item", "type": "http" }, "http": { "method": "POST", "url": "https://app.asana.com/api/1.0/portfolios/:portfolio_gid/addItem", "params": [ { "name": "portfolio_gid", "value": "12345", "type": "path", "description": "Globally unique identifier for the portfolio." }, { "name": "opt_pretty", "value": "true", "type": "query", "description": "Provides “pretty” output.\nProvides 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." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Add an item to a portfolio.\nReturns an empty data block." }, { "info": { "name": "Asana Remove a portfolio item", "type": "http" }, "http": { "method": "POST", "url": "https://app.asana.com/api/1.0/portfolios/:portfolio_gid/removeItem", "params": [ { "name": "portfolio_gid", "value": "12345", "type": "path", "description": "Globally unique identifier for the portfolio." }, { "name": "opt_pretty", "value": "true", "type": "query", "description": "Provides “pretty” output.\nProvides 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." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Remove an item from a portfolio.\nReturns an empty data block." }, { "info": { "name": "Asana Add a custom field to a portfolio", "type": "http" }, "http": { "method": "POST", "url": "https://app.asana.com/api/1.0/portfolios/:portfolio_gid/addCustomFieldSetting", "params": [ { "name": "portfolio_gid", "value": "12345", "type": "path", "description": "Globally unique identifier for the portfolio." }, { "name": "opt_pretty", "value": "true", "type": "query", "description": "Provides “pretty” output.\nProvides 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." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Custom fields are associated with portfolios by way of custom field settings. This method creates a setting for the portfolio." }, { "info": { "name": "Asana Remove a custom field from a portfolio", "type": "http" }, "http": { "method": "POST", "url": "https://app.asana.com/api/1.0/portfolios/:portfolio_gid/removeCustomFieldSetting", "params": [ { "name": "portfolio_gid", "value": "12345", "type": "path", "description": "Globally unique identifier for the portfolio." }, { "name": "opt_pretty", "value": "true", "type": "query", "description": "Provides “pretty” output.\nProvides 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." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Removes a custom field setting from a portfolio." }, { "info": { "name": "Asana Add users to a portfolio", "type": "http" }, "http": { "method": "POST", "url": "https://app.asana.com/api/1.0/portfolios/:portfolio_gid/addMembers", "params": [ { "name": "portfolio_gid", "value": "12345", "type": "path", "description": "Globally unique identifier for the portfolio." }, { "name": "opt_pretty", "value": "true", "type": "query", "description": "Provides “pretty” output.\nProvides 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." }, { "name": "opt_fields", "value": "archived,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,default_access_level,due_on,members,members.name,name,owner,owner.name,permalink_url,privacy_setting,project_templates,project_templates.name,public,start_on,workspace,workspace.name", "type": "query", "description": "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." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Adds the specified list of users as members of the portfolio.\nReturns the updated portfolio record." }, { "info": { "name": "Asana Remove users from a portfolio", "type": "http" }, "http": { "method": "POST", "url": "https://app.asana.com/api/1.0/portfolios/:portfolio_gid/removeMembers", "params": [ { "name": "portfolio_gid", "value": "12345", "type": "path", "description": "Globally unique identifier for the portfolio." }, { "name": "opt_pretty", "value": "true", "type": "query", "description": "Provides “pretty” output.\nProvides 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." }, { "name": "opt_fields", "value": "archived,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,default_access_level,due_on,members,members.name,name,owner,owner.name,permalink_url,privacy_setting,project_templates,project_templates.name,public,start_on,workspace,workspace.name", "type": "query", "description": "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." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Removes the specified list of users from members of the portfolio.\nReturns the updated portfolio record." } ] }, { "info": { "name": "Project Briefs", "type": "folder" }, "items": [ { "info": { "name": "Asana Get a project brief", "type": "http" }, "http": { "method": "GET", "url": "https://app.asana.com/api/1.0/project_briefs/:project_brief_gid", "params": [ { "name": "project_brief_gid", "value": "12345", "type": "path", "description": "Globally unique identifier for the project brief." }, { "name": "opt_pretty", "value": "true", "type": "query", "description": "Provides “pretty” output.\nProvides 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." }, { "name": "opt_fields", "value": "html_text,permalink_url,project,project.name,text,title", "type": "query", "description": "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." } ] }, "docs": "Get the full record for a project brief." }, { "info": { "name": "Asana Update a project brief", "type": "http" }, "http": { "method": "PUT", "url": "https://app.asana.com/api/1.0/project_briefs/:project_brief_gid", "params": [ { "name": "project_brief_gid", "value": "12345", "type": "path", "description": "Globally unique identifier for the project brief." }, { "name": "opt_pretty", "value": "true", "type": "query", "description": "Provides “pretty” output.\nProvides 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." }, { "name": "opt_fields", "value": "html_text,permalink_url,project,project.name,text,title", "type": "query", "description": "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." } ], "body": { "type": "json", "data": "{}" } }, "docs": "An existing project brief can be updated by making a PUT request on the URL for\nthat project brief. Only the fields provided in the `data` block will be updated;\nany unspecified fields will remain unchanged.\n\nReturns the complete updated project brief record." }, { "info": { "name": "Asana Delete a project brief", "type": "http" }, "http": { "method": "DELETE", "url": "https://app.asana.com/api/1.0/project_briefs/:project_brief_gid", "params": [ { "name": "project_brief_gid", "value": "12345", "type": "path", "description": "Globally unique identifier for the project brief." }, { "name": "opt_pretty", "value": "true", "type": "query", "description": "Provides “pretty” output.\nProvides 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." } ] }, "docs": "Deletes a specific, existing project brief.\n\nReturns an empty data record." }, { "info": { "name": "Asana Create a project brief", "type": "http" }, "http": { "method": "POST", "url": "https://app.asana.com/api/1.0/projects/:project_gid/project_briefs", "params": [ { "name": "project_gid", "value": "1331", "type": "path", "description": "Globally unique identifier for the project." }, { "name": "opt_pretty", "value": "true", "type": "query", "description": "Provides “pretty” output.\nProvides 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." }, { "name": "opt_fields", "value": "html_text,permalink_url,project,project.name,text,title", "type": "query", "description": "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." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new project brief.\n\nReturns the full record of the newly created project brief." } ] }, { "info": { "name": "Project Memberships", "type": "folder" }, "items": [ { "info": { "name": "Asana Get a project membership", "type": "http" }, "http": { "method": "GET", "url": "https://app.asana.com/api/1.0/project_memberships/:project_membership_gid", "params": [ { "name": "project_membership_gid", "value": "1331", "type": "path" }, { "name": "opt_pretty", "value": "true", "type": "query", "description": "Provides “pretty” output.\nProvides 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." }, { "name": "opt_fields", "value": "access_level,member,member.name,parent,parent.name,project,project.name,user,user.name,write_access", "type": "query", "description": "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." } ] }, "docs": "Returns the complete project record for a single project membership." }, { "info": { "name": "Asana Get memberships from a project", "type": "http" }, "http": { "method": "GET", "url": "https://app.asana.com/api/1.0/projects/:project_gid/project_memberships", "params": [ { "name": "project_gid", "value": "1331", "type": "path", "description": "Globally unique identifier for the project." }, { "name": "user", "value": "me", "type": "query", "description": "A string identifying a user. This can either be the string \"me\", an email, or the gid of a user." }, { "name": "opt_pretty", "value": "true", "type": "query", "description": "Provides “pretty” output.\nProvides 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." }, { "name": "limit", "value": "50", "type": "query", "description": "Results per page.\nThe number of objects to return per page. The value must be between 1 and 100." }, { "name": "offset", "value": "eyJ0eXAiOJiKV1iQLCJhbGciOiJIUzI1NiJ9", "type": "query", "description": "Offset token.\nAn 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.\n*Note: You can only pass in an offset that was returned to you via a previously paginated request.*" }, { "name": "opt_fields", "value": "access_level,member,member.name,offset,parent,parent.name,path,uri", "type": "query", "description": "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." } ] }, "docs": "Returns the compact project membership records for the project." } ] }, { "info": { "name": "Project Statuses", "type": "folder" }, "items": [ { "info": { "name": "Asana Get a project status", "type": "http" }, "http": { "method": "GET", "url": "https://app.asana.com/api/1.0/project_statuses/:project_status_gid", "params": [ { "name": "project_status_gid", "value": "321654", "type": "path", "description": "The project status update to get." }, { "name": "opt_pretty", "value": "true", "type": "query", "description": "Provides “pretty” output.\nProvides 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." }, { "name": "opt_fields", "value": "author,author.name,color,created_at,created_by,created_by.name,html_text,modified_at,text,title", "type": "query", "description": "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." } ] }, "docs": "*Deprecated: new integrations should prefer the `/status_updates/{status_gid}` route.*\n\nReturns the complete record for a single status update." }, { "info": { "name": "Asana Delete a project status", "type": "http" }, "http": { "method": "DELETE", "url": "https://app.asana.com/api/1.0/project_statuses/:project_status_gid", "params": [ { "name": "project_status_gid", "value": "321654", "type": "path", "description": "The project status update to get." }, { "name": "opt_pretty", "value": "true", "type": "query", "description": "Provides “pretty” output.\nProvides 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." } ] }, "docs": "*Deprecated: new integrations should prefer the `/status_updates/{status_gid}` route.*\n\nDeletes a specific, existing project status update.\n\nReturns an empty data record." }, { "info": { "name": "Asana Get statuses from a project", "type": "http" }, "http": { "method": "GET", "url": "https://app.asana.com/api/1.0/projects/:project_gid/project_statuses", "params": [ { "name": "project_gid", "value": "1331", "type": "path", "description": "Globally unique identifier for the project." }, { "name": "opt_pretty", "value": "true", "type": "query", "description": "Provides “pretty” output.\nProvides 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." }, { "name": "limit", "value": "50", "type": "query", "description": "Results per page.\nThe number of objects to return per page. The value must be between 1 and 100." }, { "name": "offset", "value": "eyJ0eXAiOJiKV1iQLCJhbGciOiJIUzI1NiJ9", "type": "query", "description": "Offset token.\nAn 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.\n*Note: You can only pass in an offset that was returned to you via a previously paginated request.*" }, { "name": "opt_fields", "value": "author,author.name,color,created_at,created_by,created_by.name,html_text,modified_at,offset,path,text,title,uri", "type": "query", "description": "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." } ] }, "docs": "*Deprecated: new integrations should prefer the `/status_updates` route.*\n\nReturns the compact project status update records for all updates on the project." }, { "info": { "name": "Asana Create a project status", "type": "http" }, "http": { "method": "POST", "url": "https://app.asana.com/api/1.0/projects/:project_gid/project_statuses", "params": [ { "name": "project_gid", "value": "1331", "type": "path", "description": "Globally unique identifier for the project." }, { "name": "opt_pretty", "value": "true", "type": "query", "description": "Provides “pretty” output.\nProvides 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." }, { "name": "opt_fields", "value": "author,author.name,color,created_at,created_by,created_by.name,html_text,modified_at,text,title", "type": "query", "description": "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." } ], "body": { "type": "json", "data": "{}" } }, "docs": "*Deprecated: new integrations should prefer the `/status_updates` route.*\n\nCreates a new status update on the project.\n\nReturns the full record of the newly created project status update." } ] }, { "info": { "name": "Project Templates", "type": "folder" }, "items": [ { "info": { "name": "Asana Get a project template", "type": "http" }, "http": { "method": "GET", "url": "https://app.asana.com/api/1.0/project_templates/:project_template_gid", "params": [ { "name": "project_template_gid", "value": "1331", "type": "path", "description": "Globally unique identifier for the project template." }, { "name": "opt_pretty", "value": "true", "type": "query", "description": "Provides “pretty” output.\nProvides 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." }, { "name": "opt_fields", "value": "color,description,html_description,name,owner,public,requested_dates,requested_dates.description,requested_dates.name,requested_roles,requested_roles.name,team,team.name", "type": "query", "description": "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." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://app.asana.com/-/oauth_authorize", "accessTokenUrl": "https://app.asana.com/-/oauth_token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Returns the complete project template record for a single project template." }, { "info": { "name": "Asana Delete a project template", "type": "http" }, "http": { "method": "DELETE", "url": "https://app.asana.com/api/1.0/project_templates/:project_template_gid", "params": [ { "name": "project_template_gid", "value": "1331", "type": "path", "description": "Globally unique identifier for the project template." }, { "name": "opt_pretty", "value": "true", "type": "query", "description": "Provides “pretty” output.\nProvides 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." } ] }, "docs": "A specific, existing project template can be deleted by making a DELETE request on the URL for that project template.\n\nReturns an empty data record." }, { "info": { "name": "Asana Get multiple project templates", "type": "http" }, "http": { "method": "GET", "url": "https://app.asana.com/api/1.0/project_templates", "params": [ { "name": "opt_pretty", "value": "true", "type": "query", "description": "Provides “pretty” output.\nProvides 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." }, { "name": "workspace", "value": "12345", "type": "query", "description": "The workspace to filter results on." }, { "name": "team", "value": "14916", "type": "query", "description": "The team to filter projects on." }, { "name": "limit", "value": "50", "type": "query", "description": "Results per page.\nThe number of objects to return per page. The value must be between 1 and 100." }, { "name": "offset", "value": "eyJ0eXAiOJiKV1iQLCJhbGciOiJIUzI1NiJ9", "type": "query", "description": "Offset token.\nAn 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.\n*Note: You can only pass in an offset that was returned to you via a previously paginated request.*" }, { "name": "opt_fields", "value": "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", "type": "query", "description": "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." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://app.asana.com/-/oauth_authorize", "accessTokenUrl": "https://app.asana.com/-/oauth_token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Returns the compact project template records for all project templates in the given team or workspace." }, { "info": { "name": "Asana Get a team's project templates", "type": "http" }, "http": { "method": "GET", "url": "https://app.asana.com/api/1.0/teams/:team_gid/project_templates", "params": [ { "name": "team_gid", "value": "159874", "type": "path", "description": "Globally unique identifier for the team." }, { "name": "opt_pretty", "value": "true", "type": "query", "description": "Provides “pretty” output.\nProvides 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." }, { "name": "limit", "value": "50", "type": "query", "description": "Results per page.\nThe number of objects to return per page. The value must be between 1 and 100." }, { "name": "offset", "value": "eyJ0eXAiOJiKV1iQLCJhbGciOiJIUzI1NiJ9", "type": "query", "description": "Offset token.\nAn 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.\n*Note: You can only pass in an offset that was returned to you via a previously paginated request.*" }, { "name": "opt_fields", "value": "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", "type": "query", "description": "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." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://app.asana.com/-/oauth_authorize", "accessTokenUrl": "https://app.asana.com/-/oauth_token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Returns the compact project template records for all project templates in the team." }, { "info": { "name": "Asana Instantiate a project from a project template", "type": "http" }, "http": { "method": "POST", "url": "https://app.asana.com/api/1.0/project_templates/:project_template_gid/instantiateProject", "params": [ { "name": "project_template_gid", "value": "1331", "type": "path", "description": "Globally unique identifier for the project template." }, { "name": "opt_pretty", "value": "true", "type": "query", "description": "Provides “pretty” output.\nProvides 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." }, { "name": "opt_fields", "value": "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", "type": "query", "description": "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." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://app.asana.com/-/oauth_authorize", "accessTokenUrl": "https://app.asana.com/-/oauth_token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Creates and returns a job that will asynchronously handle the project instantiation.\n\nTo form this request, it is recommended to first make a request to [get a project template](/reference/getprojecttemplate). Then, from the response, copy the `gid` from the object in the `requested_dates` array. This `gid` should be used in `requested_dates` to instantiate a project.\n\n_Note: The body of this request will differ if your workspace is an organization. To determine if your workspace is an organizat" } ] }, { "info": { "name": "Projects", "type": "folder" }, "items": [ { "info": { "name": "Asana Get multiple projects", "type": "http" }, "http": { "method": "GET", "url": "https://app.asana.com/api/1.0/projects", "params": [ { "name": "opt_pretty", "value": "true", "type": "query", "description": "Provides “pretty” output.\nProvides 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." }, { "name": "limit", "value": "50", "type": "query", "description": "Results per page.\nThe number of objects to return per page. The value must be between 1 and 100." }, { "name": "offset", "value": "eyJ0eXAiOJiKV1iQLCJhbGciOiJIUzI1NiJ9", "type": "query", "description": "Offset token.\nAn 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.\n*Note: You can only pass in an offset that was returned to you via a previously paginated request.*" }, { "name": "workspace", "value": "1331", "type": "query", "description": "The workspace or organization to filter projects on." }, { "name": "team", "value": "14916", "type": "query", "description": "The team to filter projects on." }, { "name": "archived", "value": "false", "type": "query", "description": "Only return projects whose `archived` field takes on the value of this parameter." }, { "name": "opt_fields", "value": "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", "type": "query", "description": "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." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://app.asana.com/-/oauth_authorize", "accessTokenUrl": "https://app.asana.com/-/oauth_token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Returns the compact project records for some filtered set of projects. Use one or more of the parameters provided to filter the projects returned.\n*Note: This endpoint may timeout for large domains. Try filtering by team!*" }, { "info": { "name": "Asana Create a project", "type": "http" }, "http": { "method": "POST", "url": "https://app.asana.com/api/1.0/projects", "params": [ { "name": "opt_pretty", "value": "true", "type": "query", "description": "Provides “pretty” output.\nProvides 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." }, { "name": "opt_fields", "value": "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", "type": "query", "description": "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." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://app.asana.com/-/oauth_authorize", "accessTokenUrl": "https://app.asana.com/-/oauth_token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Create a new project in a workspace or team.\n\nEvery project is required to be created in a specific workspace or\norganization, and this cannot be changed once set. Note that you can use\nthe `workspace` parameter regardless of whether or not it is an\norganization.\n\nIf the workspace for your project is an organization, you must also\nsupply a `team` to share the project with.\n\nReturns the full record of the newly created project." }, { "info": { "name": "Asana Get a project", "type": "http" }, "http": { "method": "GET", "url": "https://app.asana.com/api/1.0/projects/:project_gid", "params": [ { "name": "project_gid", "value": "1331", "type": "path", "description": "Globally unique identifier for the project." }, { "name": "opt_pretty", "value": "true", "type": "query", "description": "Provides “pretty” output.\nProvides 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." }, { "name": "opt_fields", "value": "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", "type": "query", "description": "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." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://app.asana.com/-/oauth_authorize", "accessTokenUrl": "https://app.asana.com/-/oauth_token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Returns the complete project record for a single project." }, { "info": { "name": "Asana Update a project", "type": "http" }, "http": { "method": "PUT", "url": "https://app.asana.com/api/1.0/projects/:project_gid", "params": [ { "name": "project_gid", "value": "1331", "type": "path", "description": "Globally unique identifier for the project." }, { "name": "opt_pretty", "value": "true", "type": "query", "description": "Provides “pretty” output.\nProvides 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." }, { "name": "opt_fields", "value": "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", "type": "query", "description": "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." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://app.asana.com/-/oauth_authorize", "accessTokenUrl": "https://app.asana.com/-/oauth_token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "A specific, existing project can be updated by making a PUT request on\nthe URL for that project. Only the fields provided in the `data` block\nwill be updated; any unspecified fields will remain unchanged.\n\nWhen using this method, it is best to specify only those fields you wish\nto change, or else you may overwrite changes made by another user since\nyou last retrieved the task.\n\nReturns the complete updated project record." }, { "info": { "name": "Asana Delete a project", "type": "http" }, "http": { "method": "DELETE", "url": "https://app.asana.com/api/1.0/projects/:project_gid", "params": [ { "name": "project_gid", "value": "1331", "type": "path", "description": "Globally unique identifier for the project." }, { "name": "opt_pretty", "value": "true", "type": "query", "description": "Provides “pretty” output.\nProvides 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." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://app.asana.com/-/oauth_authorize", "accessTokenUrl": "https://app.asana.com/-/oauth_token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "A specific, existing project can be deleted by making a DELETE request on\nthe URL for that project.\n\nReturns an empty data record." }, { "info": { "name": "Asana Duplicate a project", "type": "http" }, "http": { "method": "POST", "url": "https://app.asana.com/api/1.0/projects/:project_gid/duplicate", "params": [ { "name": "project_gid", "value": "1331", "type": "path", "description": "Globally unique identifier for the project." }, { "name": "opt_pretty", "value": "true", "type": "query", "description": "Provides “pretty” output.\nProvides 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." }, { "name": "opt_fields", "value": "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", "type": "query", "description": "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." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://app.asana.com/-/oauth_authorize", "accessTokenUrl": "https://app.asana.com/-/oauth_token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Creates and returns a job that will asynchronously handle the duplication." }, { "info": { "name": "Asana Get projects a task is in", "type": "http" }, "http": { "method": "GET", "url": "https://app.asana.com/api/1.0/tasks/:task_gid/projects", "params": [ { "name": "task_gid", "value": "321654", "type": "path", "description": "The task to operate on." }, { "name": "opt_pretty", "value": "true", "type": "query", "description": "Provides “pretty” output.\nProvides 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." }, { "name": "limit", "value": "50", "type": "query", "description": "Results per page.\nThe number of objects to return per page. The value must be between 1 and 100." }, { "name": "offset", "value": "eyJ0eXAiOJiKV1iQLCJhbGciOiJIUzI1NiJ9", "type": "query", "description": "Offset token.\nAn 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.\n*Note: You can only pass in an offset that was returned to you via a previously paginated request.*" }, { "name": "opt_fields", "value": "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", "type": "query", "description": "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." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://app.asana.com/-/oauth_authorize", "accessTokenUrl": "https://app.asana.com/-/oauth_token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Returns a compact representation of all of the projects the task is in." }, { "info": { "name": "Asana Get a team's projects", "type": "http" }, "http": { "method": "GET", "url": "https://app.asana.com/api/1.0/teams/:team_gid/projects", "params": [ { "name": "team_gid", "value": "159874", "type": "path", "description": "Globally unique identifier for the team." }, { "name": "opt_pretty", "value": "true", "type": "query", "description": "Provides “pretty” output.\nProvides 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." }, { "name": "limit", "value": "50", "type": "query", "description": "Results per page.\nThe number of objects to return per page. The value must be between 1 and 100." }, { "name": "offset", "value": "eyJ0eXAiOJiKV1iQLCJhbGciOiJIUzI1NiJ9", "type": "query", "description": "Offset token.\nAn 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.\n*Note: You can only pass in an offset that was returned to you via a previously paginated request.*" }, { "name": "archived", "value": "false", "type": "query", "description": "Only return projects whose `archived` field takes on the value of this parameter." }, { "name": "opt_fields", "value": "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", "type": "query", "description": "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." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://app.asana.com/-/oauth_authorize", "accessTokenUrl": "https://app.asana.com/-/oauth_token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Returns the compact project records for all projects in the team." }, { "info": { "name": "Asana Create a project in a team", "type": "http" }, "http": { "method": "POST", "url": "https://app.asana.com/api/1.0/teams/:team_gid/projects", "params": [ { "name": "team_gid", "value": "159874", "type": "path", "description": "Globally unique identifier for the team." }, { "name": "opt_pretty", "value": "true", "type": "query", "description": "Provides “pretty” output.\nProvides 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." }, { "name": "opt_fields", "value": "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", "type": "query", "description": "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." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://app.asana.com/-/oauth_authorize", "accessTokenUrl": "https://app.asana.com/-/oauth_token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Creates a project shared with the given team.\n\nReturns the full record of the newly created project." }, { "info": { "name": "Asana Get all projects in a workspace", "type": "http" }, "http": { "method": "GET", "url": "https://app.asana.com/api/1.0/workspaces/:workspace_gid/projects", "params": [ { "name": "workspace_gid", "value": "12345", "type": "path", "description": "Globally unique identifier for the workspace or organization." }, { "name": "opt_pretty", "value": "true", "type": "query", "description": "Provides “pretty” output.\nProvides 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." }, { "name": "limit", "value": "50", "type": "query", "description": "Results per page.\nThe number of objects to return per page. The value must be between 1 and 100." }, { "name": "offset", "value": "eyJ0eXAiOJiKV1iQLCJhbGciOiJIUzI1NiJ9", "type": "query", "description": "Offset token.\nAn 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.\n*Note: You can only pass in an offset that was returned to you via a previously paginated request.*" }, { "name": "archived", "value": "false", "type": "query", "description": "Only return projects whose `archived` field takes on the value of this parameter." }, { "name": "opt_fields", "value": "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", "type": "query", "description": "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." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://app.asana.com/-/oauth_authorize", "accessTokenUrl": "https://app.asana.com/-/oauth_token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Returns the compact project records for all projects in the workspace.\n*Note: This endpoint may timeout for large domains. Prefer the `/teams/{team_gid}/projects` endpoint.*" }, { "info": { "name": "Asana Create a project in a workspace", "type": "http" }, "http": { "method": "POST", "url": "https://app.asana.com/api/1.0/workspaces/:workspace_gid/projects", "params": [ { "name": "workspace_gid", "value": "12345", "type": "path", "description": "Globally unique identifier for the workspace or organization." }, { "name": "opt_pretty", "value": "true", "type": "query", "description": "Provides “pretty” output.\nProvides 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." }, { "name": "opt_fields", "value": "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", "type": "query", "description": "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." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://app.asana.com/-/oauth_authorize", "accessTokenUrl": "https://app.asana.com/-/oauth_token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Creates a project in the workspace.\n\nIf the workspace for your project is an organization, you must also\nsupply a team to share the project with.\n\nReturns the full record of the newly created project." }, { "info": { "name": "Asana Add a custom field to a project", "type": "http" }, "http": { "method": "POST", "url": "https://app.asana.com/api/1.0/projects/:project_gid/addCustomFieldSetting", "params": [ { "name": "project_gid", "value": "1331", "type": "path", "description": "Globally unique identifier for the project." }, { "name": "opt_pretty", "value": "true", "type": "query", "description": "Provides “pretty” output.\nProvides 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." }, { "name": "opt_fields", "value": "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", "type": "query", "description": "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." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://app.asana.com/-/oauth_authorize", "accessTokenUrl": "https://app.asana.com/-/oauth_token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Custom fields are associated with projects by way of custom field settings. This method creates a setting for the project." }, { "info": { "name": "Asana Remove a custom field from a project", "type": "http" }, "http": { "method": "POST", "url": "https://app.asana.com/api/1.0/projects/:project_gid/removeCustomFieldSetting", "params": [ { "name": "project_gid", "value": "1331", "type": "path", "description": "Globally unique identifier for the project." }, { "name": "opt_pretty", "value": "true", "type": "query", "description": "Provides “pretty” output.\nProvides 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." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://app.asana.com/-/oauth_authorize", "accessTokenUrl": "https://app.asana.com/-/oauth_token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Removes a custom field setting from a project." }, { "info": { "name": "Asana Get task count of a project", "type": "http" }, "http": { "method": "GET", "url": "https://app.asana.com/api/1.0/projects/:project_gid/task_counts", "params": [ { "name": "project_gid", "value": "1331", "type": "path", "description": "Globally unique identifier for the project." }, { "name": "opt_pretty", "value": "true", "type": "query", "description": "Provides “pretty” output.\nProvides 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." }, { "name": "opt_fields", "value": "num_completed_milestones,num_completed_tasks,num_incomplete_milestones,num_incomplete_tasks,num_milestones,num_tasks", "type": "query", "description": "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." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://app.asana.com/-/oauth_authorize", "accessTokenUrl": "https://app.asana.com/-/oauth_token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Get an object that holds task count fields. **All fields are excluded by default**. You must [opt in](/docs/inputoutput-options) using `opt_fields` to get any information from this endpoint.\n\nThis endpoint has an additional [rate limit](/docs/rate-limits) and each field counts especially high against our [cost limits](/docs/rate-limits#cost-limits).\n\nMilestones are just tasks, so they are included in the `num_tasks`, `num_incomplete_tasks`, and `num_completed_tasks` counts." }, { "info": { "name": "Asana Add users to a project", "type": "http" }, "http": { "method": "POST", "url": "https://app.asana.com/api/1.0/projects/:project_gid/addMembers", "params": [ { "name": "project_gid", "value": "1331", "type": "path", "description": "Globally unique identifier for the project." }, { "name": "opt_pretty", "value": "true", "type": "query", "description": "Provides “pretty” output.\nProvides 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." }, { "name": "opt_fields", "value": "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", "type": "query", "description": "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." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://app.asana.com/-/oauth_authorize", "accessTokenUrl": "https://app.asana.com/-/oauth_token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Adds the specified list of users as members of the project. Note that a user being added as a member may also be added as a *follower* as a result of this operation. This is because the user's default notification settings (i.e., in the \"Notifications\" tab of \"My Profile Settings\") will override this endpoint's default behavior of setting \"Tasks added\" notifications to `false`.\nReturns the updated project record." }, { "info": { "name": "Asana Remove users from a project", "type": "http" }, "http": { "method": "POST", "url": "https://app.asana.com/api/1.0/projects/:project_gid/removeMembers", "params": [ { "name": "project_gid", "value": "1331", "type": "path", "description": "Globally unique identifier for the project." }, { "name": "opt_pretty", "value": "true", "type": "query", "description": "Provides “pretty” output.\nProvides 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." }, { "name": "opt_fields", "value": "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", "type": "query", "description": "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." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://app.asana.com/-/oauth_authorize", "accessTokenUrl": "https://app.asana.com/-/oauth_token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Removes the specified list of users from members of the project.\nReturns the updated project record." }, { "info": { "name": "Asana Add followers to a project", "type": "http" }, "http": { "method": "POST", "url": "https://app.asana.com/api/1.0/projects/:project_gid/addFollowers", "params": [ { "name": "project_gid", "value": "1331", "type": "path", "description": "Globally unique identifier for the project." }, { "name": "opt_pretty", "value": "true", "type": "query", "description": "Provides “pretty” output.\nProvides 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." }, { "name": "opt_fields", "value": "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", "type": "query", "description": "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." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://app.asana.com/-/oauth_authorize", "accessTokenUrl": "https://app.asana.com/-/oauth_token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Adds the specified list of users as followers to the project. Followers are a subset of members who have opted in to receive \"tasks added\" notifications for a project. Therefore, if the users are not already members of the project, they will also become members as a result of this operation.\nReturns the updated project record." }, { "info": { "name": "Asana Remove followers from a project", "type": "http" }, "http": { "method": "POST", "url": "https://app.asana.com/api/1.0/projects/:project_gid/removeFollowers", "params": [ { "name": "project_gid", "value": "1331", "type": "path", "description": "Globally unique identifier for the project." }, { "name": "opt_pretty", "value": "true", "type": "query", "description": "Provides “pretty” output.\nProvides 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." }, { "name": "opt_fields", "value": "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", "type": "query", "description": "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." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://app.asana.com/-/oauth_authorize", "accessTokenUrl": "https://app.asana.com/-/oauth_token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Removes the specified list of users from following the project, this will not affect project membership status.\nReturns the updated project record." }, { "info": { "name": "Asana Create a project template from a project", "type": "http" }, "http": { "method": "POST", "url": "https://app.asana.com/api/1.0/projects/:project_gid/saveAsTemplate", "params": [ { "name": "project_gid", "value": "1331", "type": "path", "description": "Globally unique identifier for the project." }, { "name": "opt_pretty", "value": "true", "type": "query", "description": "Provides “pretty” output.\nProvides 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." }, { "name": "opt_fields", "value": "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", "type": "query", "description": "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." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates and returns a job that will asynchronously handle the project template creation." } ] }, { "info": { "name": "Rules", "type": "folder" }, "items": [ { "info": { "name": "Asana Trigger a rule", "type": "http" }, "http": { "method": "POST", "url": "https://app.asana.com/api/1.0/rule_triggers/:rule_trigger_gid/run", "params": [ { "name": "rule_trigger_gid", "value": "12345", "type": "path", "description": "The ID of the incoming web request trigger. This value is a path parameter that is automatically generated for the API endpoint." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Trigger a rule which uses an [\"incoming web request\"](/docs/incoming-web-requests) trigger." } ] }, { "info": { "name": "Sections", "type": "folder" }, "items": [ { "info": { "name": "Asana Get a section", "type": "http" }, "http": { "method": "GET", "url": "https://app.asana.com/api/1.0/sections/:section_gid", "params": [ { "name": "section_gid", "value": "321654", "type": "path", "description": "The globally unique identifier for the section." }, { "name": "opt_pretty", "value": "true", "type": "query", "description": "Provides “pretty” output.\nProvides 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." }, { "name": "opt_fields", "value": "created_at,name,project,project.name,projects,projects.name", "type": "query", "description": "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." } ] }, "docs": "Returns the complete record for a single section." }, { "info": { "name": "Asana Update a section", "type": "http" }, "http": { "method": "PUT", "url": "https://app.asana.com/api/1.0/sections/:section_gid", "params": [ { "name": "section_gid", "value": "321654", "type": "path", "description": "The globally unique identifier for the section." }, { "name": "opt_pretty", "value": "true", "type": "query", "description": "Provides “pretty” output.\nProvides 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." }, { "name": "opt_fields", "value": "created_at,name,project,project.name,projects,projects.name", "type": "query", "description": "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." } ], "body": { "type": "json", "data": "{}" } }, "docs": "A specific, existing section can be updated by making a PUT request on\nthe URL for that project. Only the fields provided in the `data` block\nwill be updated; any unspecified fields will remain unchanged. (note that\nat this time, the only field that can be updated is the `name` field.)\n\nWhen using this method, it is best to specify only those fields you wish\nto change, or else you may overwrite changes made by another user since\nyou last retrieved the task.\n\nReturns the complete updated section " }, { "info": { "name": "Asana Delete a section", "type": "http" }, "http": { "method": "DELETE", "url": "https://app.asana.com/api/1.0/sections/:section_gid", "params": [ { "name": "section_gid", "value": "321654", "type": "path", "description": "The globally unique identifier for the section." }, { "name": "opt_pretty", "value": "true", "type": "query", "description": "Provides “pretty” output.\nProvides 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." } ] }, "docs": "A specific, existing section can be deleted by making a DELETE request on\nthe URL for that section.\n\nNote that sections must be empty to be deleted.\n\nThe last remaining section cannot be deleted.\n\nReturns an empty data block." }, { "info": { "name": "Asana Get sections in a project", "type": "http" }, "http": { "method": "GET", "url": "https://app.asana.com/api/1.0/projects/:project_gid/sections", "params": [ { "name": "project_gid", "value": "1331", "type": "path", "description": "Globally unique identifier for the project." }, { "name": "opt_pretty", "value": "true", "type": "query", "description": "Provides “pretty” output.\nProvides 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." }, { "name": "limit", "value": "50", "type": "query", "description": "Results per page.\nThe number of objects to return per page. The value must be between 1 and 100." }, { "name": "offset", "value": "eyJ0eXAiOJiKV1iQLCJhbGciOiJIUzI1NiJ9", "type": "query", "description": "Offset token.\nAn 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.\n*Note: You can only pass in an offset that was returned to you via a previously paginated request.*" }, { "name": "opt_fields", "value": "created_at,name,offset,path,project,project.name,projects,projects.name,uri", "type": "query", "description": "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." } ] }, "docs": "Returns the compact records for all sections in the specified project." }, { "info": { "name": "Asana Create a section in a project", "type": "http" }, "http": { "method": "POST", "url": "https://app.asana.com/api/1.0/projects/:project_gid/sections", "params": [ { "name": "project_gid", "value": "1331", "type": "path", "description": "Globally unique identifier for the project." }, { "name": "opt_pretty", "value": "true", "type": "query", "description": "Provides “pretty” output.\nProvides 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." }, { "name": "opt_fields", "value": "created_at,name,project,project.name,projects,projects.name", "type": "query", "description": "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." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new section in a project.\nReturns the full record of the newly created section." }, { "info": { "name": "Asana Add task to section", "type": "http" }, "http": { "method": "POST", "url": "https://app.asana.com/api/1.0/sections/:section_gid/addTask", "params": [ { "name": "section_gid", "value": "321654", "type": "path", "description": "The globally unique identifier for the section." }, { "name": "opt_pretty", "value": "true", "type": "query", "description": "Provides “pretty” output.\nProvides 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." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://app.asana.com/-/oauth_authorize", "accessTokenUrl": "https://app.asana.com/-/oauth_token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Add a task to a specific, existing section. This will remove the task from other sections of the project.\n\nThe task will be inserted at the top of a section unless an insert_before or insert_after parameter is declared.\n\nThis does not work for separators (tasks with the resource_subtype of section)." }, { "info": { "name": "Asana Move or Insert sections", "type": "http" }, "http": { "method": "POST", "url": "https://app.asana.com/api/1.0/projects/:project_gid/sections/insert", "params": [ { "name": "project_gid", "value": "1331", "type": "path", "description": "Globally unique identifier for the project." }, { "name": "opt_pretty", "value": "true", "type": "query", "description": "Provides “pretty” output.\nProvides 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." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Move sections relative to each other. One of\n`before_section` or `after_section` is required.\n\nSections cannot be moved between projects.\n\nReturns an empty data block." } ] }, { "info": { "name": "Status Updates", "type": "folder" }, "items": [ { "info": { "name": "Asana Get a status update", "type": "http" }, "http": { "method": "GET", "url": "https://app.asana.com/api/1.0/status_updates/:status_update_gid", "params": [ { "name": "status_update_gid", "value": "321654", "type": "path", "description": "The status update to get." }, { "name": "opt_pretty", "value": "true", "type": "query", "description": "Provides “pretty” output.\nProvides 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." }, { "name": "opt_fields", "value": "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", "type": "query", "description": "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." } ] }, "docs": "Returns the complete record for a single status update." }, { "info": { "name": "Asana Delete a status update", "type": "http" }, "http": { "method": "DELETE", "url": "https://app.asana.com/api/1.0/status_updates/:status_update_gid", "params": [ { "name": "status_update_gid", "value": "321654", "type": "path", "description": "The status update to get." }, { "name": "opt_pretty", "value": "true", "type": "query", "description": "Provides “pretty” output.\nProvides 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." } ] }, "docs": "Deletes a specific, existing status update.\n\nReturns an empty data record." }, { "info": { "name": "Asana Get status updates from an object", "type": "http" }, "http": { "method": "GET", "url": "https://app.asana.com/api/1.0/status_updates", "params": [ { "name": "opt_pretty", "value": "true", "type": "query", "description": "Provides “pretty” output.\nProvides 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." }, { "name": "limit", "value": "50", "type": "query", "description": "Results per page.\nThe number of objects to return per page. The value must be between 1 and 100." }, { "name": "offset", "value": "eyJ0eXAiOJiKV1iQLCJhbGciOiJIUzI1NiJ9", "type": "query", "description": "Offset token.\nAn 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.\n*Note: You can only pass in an offset that was returned to you via a previously paginated request.*" }, { "name": "parent", "value": "159874", "type": "query", "description": "Globally unique identifier for object to fetch statuses from. Must be a GID for a project, portfolio, or goal." }, { "name": "created_since", "value": "2012-02-22T02:06:58.158Z", "type": "query", "description": "Only return statuses that have been created since the given time." }, { "name": "opt_fields", "value": "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", "type": "query", "description": "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." } ] }, "docs": "Returns the compact status update records for all updates on the object." }, { "info": { "name": "Asana Create a status update", "type": "http" }, "http": { "method": "POST", "url": "https://app.asana.com/api/1.0/status_updates", "params": [ { "name": "opt_pretty", "value": "true", "type": "query", "description": "Provides “pretty” output.\nProvides 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." }, { "name": "limit", "value": "50", "type": "query", "description": "Results per page.\nThe number of objects to return per page. The value must be between 1 and 100." }, { "name": "offset", "value": "eyJ0eXAiOJiKV1iQLCJhbGciOiJIUzI1NiJ9", "type": "query", "description": "Offset token.\nAn 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.\n*Note: You can only pass in an offset that was returned to you via a previously paginated request.*" }, { "name": "opt_fields", "value": "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", "type": "query", "description": "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." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new status update on an object.\nReturns the full record of the newly created status update." } ] }, { "info": { "name": "Stories", "type": "folder" }, "items": [ { "info": { "name": "Asana Get a story", "type": "http" }, "http": { "method": "GET", "url": "https://app.asana.com/api/1.0/stories/:story_gid", "params": [ { "name": "story_gid", "value": "35678", "type": "path", "description": "Globally unique identifier for the story." }, { "name": "opt_pretty", "value": "true", "type": "query", "description": "Provides “pretty” output.\nProvides 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." }, { "name": "opt_fields", "value": "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", "type": "query", "description": "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." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://app.asana.com/-/oauth_authorize", "accessTokenUrl": "https://app.asana.com/-/oauth_token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Returns the full record for a single story." }, { "info": { "name": "Asana Update a story", "type": "http" }, "http": { "method": "PUT", "url": "https://app.asana.com/api/1.0/stories/:story_gid", "params": [ { "name": "story_gid", "value": "35678", "type": "path", "description": "Globally unique identifier for the story." }, { "name": "opt_pretty", "value": "true", "type": "query", "description": "Provides “pretty” output.\nProvides 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." }, { "name": "opt_fields", "value": "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", "type": "query", "description": "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." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the story and returns the full record for the updated story. Only comment stories can have their text updated, and only comment stories and attachment stories can be pinned. Only one of `text` and `html_text` can be specified." }, { "info": { "name": "Asana Delete a story", "type": "http" }, "http": { "method": "DELETE", "url": "https://app.asana.com/api/1.0/stories/:story_gid", "params": [ { "name": "story_gid", "value": "35678", "type": "path", "description": "Globally unique identifier for the story." }, { "name": "opt_pretty", "value": "true", "type": "query", "description": "Provides “pretty” output.\nProvides 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." } ] }, "docs": "Deletes a story. A user can only delete stories they have created.\n\nReturns an empty data record." }, { "info": { "name": "Asana Get stories from a task", "type": "http" }, "http": { "method": "GET", "url": "https://app.asana.com/api/1.0/tasks/:task_gid/stories", "params": [ { "name": "task_gid", "value": "321654", "type": "path", "description": "The task to operate on." }, { "name": "opt_pretty", "value": "true", "type": "query", "description": "Provides “pretty” output.\nProvides 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." }, { "name": "limit", "value": "50", "type": "query", "description": "Results per page.\nThe number of objects to return per page. The value must be between 1 and 100." }, { "name": "offset", "value": "eyJ0eXAiOJiKV1iQLCJhbGciOiJIUzI1NiJ9", "type": "query", "description": "Offset token.\nAn 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.\n*Note: You can only pass in an offset that was returned to you via a previously paginated request.*" }, { "name": "opt_fields", "value": "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", "type": "query", "description": "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." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://app.asana.com/-/oauth_authorize", "accessTokenUrl": "https://app.asana.com/-/oauth_token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Returns the compact records for all stories on the task." }, { "info": { "name": "Asana Create a story on a task", "type": "http" }, "http": { "method": "POST", "url": "https://app.asana.com/api/1.0/tasks/:task_gid/stories", "params": [ { "name": "task_gid", "value": "321654", "type": "path", "description": "The task to operate on." }, { "name": "opt_pretty", "value": "true", "type": "query", "description": "Provides “pretty” output.\nProvides 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." }, { "name": "opt_fields", "value": "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", "type": "query", "description": "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." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Adds a story to a task. This endpoint currently only allows for comment\nstories to be created. The comment will be authored by the currently\nauthenticated user, and timestamped when the server receives the request.\n\nReturns the full record for the new story added to the task." } ] }, { "info": { "name": "Default", "type": "folder" }, "items": [ { "info": { "name": "Asana Get multiple tags", "type": "http" }, "http": { "method": "GET", "url": "https://app.asana.com/api/1.0/tags", "params": [ { "name": "opt_pretty", "value": "true", "type": "query", "description": "Provides “pretty” output.\nProvides 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." }, { "name": "limit", "value": "50", "type": "query", "description": "Results per page.\nThe number of objects to return per page. The value must be between 1 and 100." }, { "name": "offset", "value": "eyJ0eXAiOJiKV1iQLCJhbGciOiJIUzI1NiJ9", "type": "query", "description": "Offset token.\nAn 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.\n*Note: You can only pass in an offset that was returned to you via a previously paginated request.*" }, { "name": "workspace", "value": "1331", "type": "query", "description": "The workspace to filter tags on." }, { "name": "opt_fields", "value": "color,created_at,followers,followers.name,name,notes,offset,path,permalink_url,uri,workspace,workspace.name", "type": "query", "description": "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." } ] }, "docs": "Returns the compact tag records for some filtered set of tags. Use one or more of the parameters provided to filter the tags returned." }, { "info": { "name": "Asana Create a tag", "type": "http" }, "http": { "method": "POST", "url": "https://app.asana.com/api/1.0/tags", "params": [ { "name": "opt_pretty", "value": "true", "type": "query", "description": "Provides “pretty” output.\nProvides 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." }, { "name": "opt_fields", "value": "color,created_at,followers,followers.name,name,notes,permalink_url,workspace,workspace.name", "type": "query", "description": "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." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new tag in a workspace or organization.\n\nEvery tag is required to be created in a specific workspace or\norganization, and this cannot be changed once set. Note that you can use\nthe workspace parameter regardless of whether or not it is an\norganization.\n\nReturns the full record of the newly created tag." }, { "info": { "name": "Asana Get a tag", "type": "http" }, "http": { "method": "GET", "url": "https://app.asana.com/api/1.0/tags/:tag_gid", "params": [ { "name": "tag_gid", "value": "11235", "type": "path", "description": "Globally unique identifier for the tag." }, { "name": "opt_pretty", "value": "true", "type": "query", "description": "Provides “pretty” output.\nProvides 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." }, { "name": "opt_fields", "value": "color,created_at,followers,followers.name,name,notes,permalink_url,workspace,workspace.name", "type": "query", "description": "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." } ] }, "docs": "Returns the complete tag record for a single tag." }, { "info": { "name": "Asana Update a tag", "type": "http" }, "http": { "method": "PUT", "url": "https://app.asana.com/api/1.0/tags/:tag_gid", "params": [ { "name": "tag_gid", "value": "11235", "type": "path", "description": "Globally unique identifier for the tag." }, { "name": "opt_pretty", "value": "true", "type": "query", "description": "Provides “pretty” output.\nProvides 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." }, { "name": "opt_fields", "value": "color,created_at,followers,followers.name,name,notes,permalink_url,workspace,workspace.name", "type": "query", "description": "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." } ] }, "docs": "Updates the properties of a tag. Only the fields provided in the `data`\nblock will be updated; any unspecified fields will remain unchanged.\n\nWhen using this method, it is best to specify only those fields you wish\nto change, or else you may overwrite changes made by another user since\nyou last retrieved the tag.\n\nReturns the complete updated tag record." }, { "info": { "name": "Asana Delete a tag", "type": "http" }, "http": { "method": "DELETE", "url": "https://app.asana.com/api/1.0/tags/:tag_gid", "params": [ { "name": "tag_gid", "value": "11235", "type": "path", "description": "Globally unique identifier for the tag." }, { "name": "opt_pretty", "value": "true", "type": "query", "description": "Provides “pretty” output.\nProvides 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." } ] }, "docs": "A specific, existing tag can be deleted by making a DELETE request on\nthe URL for that tag.\n\nReturns an empty data record." }, { "info": { "name": "Asana Get a task's tags", "type": "http" }, "http": { "method": "GET", "url": "https://app.asana.com/api/1.0/tasks/:task_gid/tags", "params": [ { "name": "task_gid", "value": "321654", "type": "path", "description": "The task to operate on." }, { "name": "opt_pretty", "value": "true", "type": "query", "description": "Provides “pretty” output.\nProvides 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." }, { "name": "limit", "value": "50", "type": "query", "description": "Results per page.\nThe number of objects to return per page. The value must be between 1 and 100." }, { "name": "offset", "value": "eyJ0eXAiOJiKV1iQLCJhbGciOiJIUzI1NiJ9", "type": "query", "description": "Offset token.\nAn 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.\n*Note: You can only pass in an offset that was returned to you via a previously paginated request.*" }, { "name": "opt_fields", "value": "color,created_at,followers,followers.name,name,notes,offset,path,permalink_url,uri,workspace,workspace.name", "type": "query", "description": "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." } ] }, "docs": "Get a compact representation of all of the tags the task has." }, { "info": { "name": "Asana Get tags in a workspace", "type": "http" }, "http": { "method": "GET", "url": "https://app.asana.com/api/1.0/workspaces/:workspace_gid/tags", "params": [ { "name": "workspace_gid", "value": "12345", "type": "path", "description": "Globally unique identifier for the workspace or organization." }, { "name": "opt_pretty", "value": "true", "type": "query", "description": "Provides “pretty” output.\nProvides 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." }, { "name": "limit", "value": "50", "type": "query", "description": "Results per page.\nThe number of objects to return per page. The value must be between 1 and 100." }, { "name": "offset", "value": "eyJ0eXAiOJiKV1iQLCJhbGciOiJIUzI1NiJ9", "type": "query", "description": "Offset token.\nAn 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.\n*Note: You can only pass in an offset that was returned to you via a previously paginated request.*" }, { "name": "opt_fields", "value": "color,created_at,followers,followers.name,name,notes,offset,path,permalink_url,uri,workspace,workspace.name", "type": "query", "description": "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." } ] }, "docs": "Returns the compact tag records for some filtered set of tags. Use one or more of the parameters provided to filter the tags returned." }, { "info": { "name": "Asana Create a tag in a workspace", "type": "http" }, "http": { "method": "POST", "url": "https://app.asana.com/api/1.0/workspaces/:workspace_gid/tags", "params": [ { "name": "workspace_gid", "value": "12345", "type": "path", "description": "Globally unique identifier for the workspace or organization." }, { "name": "opt_pretty", "value": "true", "type": "query", "description": "Provides “pretty” output.\nProvides 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." }, { "name": "opt_fields", "value": "color,created_at,followers,followers.name,name,notes,permalink_url,workspace,workspace.name", "type": "query", "description": "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." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new tag in a workspace or organization.\n\nEvery tag is required to be created in a specific workspace or\norganization, and this cannot be changed once set. Note that you can use\nthe workspace parameter regardless of whether or not it is an\norganization.\n\nReturns the full record of the newly created tag." } ] }, { "info": { "name": "Task Templates", "type": "folder" }, "items": [ { "info": { "name": "Asana Get multiple task templates", "type": "http" }, "http": { "method": "GET", "url": "https://app.asana.com/api/1.0/task_templates", "params": [ { "name": "opt_pretty", "value": "true", "type": "query", "description": "Provides “pretty” output.\nProvides 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." }, { "name": "limit", "value": "50", "type": "query", "description": "Results per page.\nThe number of objects to return per page. The value must be between 1 and 100." }, { "name": "offset", "value": "eyJ0eXAiOJiKV1iQLCJhbGciOiJIUzI1NiJ9", "type": "query", "description": "Offset token.\nAn 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.\n*Note: You can only pass in an offset that was returned to you via a previously paginated request.*" }, { "name": "project", "value": "321654", "type": "query", "description": "The project to filter task templates on." }, { "name": "opt_fields", "value": "created_at,created_by,name,project,template", "type": "query", "description": "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." } ] }, "docs": "Returns the compact task template records for some filtered set of task templates. You must specify a `project`" }, { "info": { "name": "Asana Get a task template", "type": "http" }, "http": { "method": "GET", "url": "https://app.asana.com/api/1.0/task_templates/:task_template_gid", "params": [ { "name": "task_template_gid", "value": "1331", "type": "path", "description": "Globally unique identifier for the task template." }, { "name": "opt_pretty", "value": "true", "type": "query", "description": "Provides “pretty” output.\nProvides 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." }, { "name": "opt_fields", "value": "created_at,created_by,name,project,template", "type": "query", "description": "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." } ] }, "docs": "Returns the complete task template record for a single task template." }, { "info": { "name": "Asana Delete a task template", "type": "http" }, "http": { "method": "DELETE", "url": "https://app.asana.com/api/1.0/task_templates/:task_template_gid", "params": [ { "name": "task_template_gid", "value": "1331", "type": "path", "description": "Globally unique identifier for the task template." }, { "name": "opt_pretty", "value": "true", "type": "query", "description": "Provides “pretty” output.\nProvides 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." } ] }, "docs": "A specific, existing task template can be deleted by making a DELETE request on the URL for that task template. Returns an empty data record." }, { "info": { "name": "Asana Instantiate a task from a task template", "type": "http" }, "http": { "method": "POST", "url": "https://app.asana.com/api/1.0/task_templates/:task_template_gid/instantiateTask", "params": [ { "name": "task_template_gid", "value": "1331", "type": "path", "description": "Globally unique identifier for the task template." }, { "name": "opt_pretty", "value": "true", "type": "query", "description": "Provides “pretty” output.\nProvides 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." }, { "name": "opt_fields", "value": "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", "type": "query", "description": "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." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates and returns a job that will asynchronously handle the task instantiation." } ] }, { "info": { "name": "Tasks", "type": "folder" }, "items": [ { "info": { "name": "Asana Get multiple tasks", "type": "http" }, "http": { "method": "GET", "url": "https://app.asana.com/api/1.0/tasks", "params": [ { "name": "opt_pretty", "value": "true", "type": "query", "description": "Provides “pretty” output.\nProvides 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." }, { "name": "limit", "value": "50", "type": "query", "description": "Results per page.\nThe number of objects to return per page. The value must be between 1 and 100." }, { "name": "offset", "value": "eyJ0eXAiOJiKV1iQLCJhbGciOiJIUzI1NiJ9", "type": "query", "description": "Offset token.\nAn 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.\n*Note: You can only pass in an offset that was returned to you via a previously paginated request.*" }, { "name": "assignee", "value": "14641", "type": "query", "description": "The assignee to filter tasks on. If searching for unassigned tasks, assignee.any = null can be specified.\n*Note: If you specify `assignee`, you must also specify the `workspace` to filter on.*" }, { "name": "project", "value": "321654", "type": "query", "description": "The project to filter tasks on." }, { "name": "section", "value": "321654", "type": "query", "description": "The section to filter tasks on." }, { "name": "workspace", "value": "321654", "type": "query", "description": "The workspace to filter tasks on.\n*Note: If you specify `workspace`, you must also specify the `assignee` to filter on.*" }, { "name": "completed_since", "value": "", "type": "query", "description": "Only return tasks that are either incomplete or that have been completed since this time." }, { "name": "modified_since", "value": "2012-02-22T02:06:58.158Z", "type": "query", "description": "Only return tasks that have been modified since the given time.\n\n*Note: A task is considered “modified” if any of its properties\nchange, or associations between it and other objects are modified\n(e.g. a task being added to a project). A task is not considered\nmodified just because another object it is associated with (e.g. a\nsubtask) is modified. Actions that count as modifying the task\ninclude assigning, renaming, completing, and adding stories.*" }, { "name": "opt_fields", "value": "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", "type": "query", "description": "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." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://app.asana.com/-/oauth_authorize", "accessTokenUrl": "https://app.asana.com/-/oauth_token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Returns the compact task records for some filtered set of tasks. Use one or more of the parameters provided to filter the tasks returned. You must specify a `project` or `tag` if you do not specify `assignee` and `workspace`.\n\nFor more complex task retrieval, use [workspaces/{workspace_gid}/tasks/search](/reference/searchtasksforworkspace)." }, { "info": { "name": "Asana Create a task", "type": "http" }, "http": { "method": "POST", "url": "https://app.asana.com/api/1.0/tasks", "params": [ { "name": "opt_pretty", "value": "true", "type": "query", "description": "Provides “pretty” output.\nProvides 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." }, { "name": "opt_fields", "value": "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", "type": "query", "description": "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." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://app.asana.com/-/oauth_authorize", "accessTokenUrl": "https://app.asana.com/-/oauth_token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Creating a new task is as easy as POSTing to the `/tasks` endpoint with a\ndata block containing the fields you’d like to set on the task. Any\nunspecified fields will take on default values.\n\nEvery task is required to be created in a specific workspace, and this\nworkspace cannot be changed once set. The workspace need not be set\nexplicitly if you specify `projects` or a `parent` task instead." }, { "info": { "name": "Asana Get a task", "type": "http" }, "http": { "method": "GET", "url": "https://app.asana.com/api/1.0/tasks/:task_gid", "params": [ { "name": "task_gid", "value": "321654", "type": "path", "description": "The task to operate on." }, { "name": "opt_pretty", "value": "true", "type": "query", "description": "Provides “pretty” output.\nProvides 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." }, { "name": "opt_fields", "value": "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", "type": "query", "description": "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." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://app.asana.com/-/oauth_authorize", "accessTokenUrl": "https://app.asana.com/-/oauth_token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Returns the complete task record for a single task." }, { "info": { "name": "Asana Update a task", "type": "http" }, "http": { "method": "PUT", "url": "https://app.asana.com/api/1.0/tasks/:task_gid", "params": [ { "name": "task_gid", "value": "321654", "type": "path", "description": "The task to operate on." }, { "name": "opt_pretty", "value": "true", "type": "query", "description": "Provides “pretty” output.\nProvides 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." }, { "name": "opt_fields", "value": "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", "type": "query", "description": "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." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://app.asana.com/-/oauth_authorize", "accessTokenUrl": "https://app.asana.com/-/oauth_token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "A specific, existing task can be updated by making a PUT request on the\nURL for that task. Only the fields provided in the `data` block will be\nupdated; any unspecified fields will remain unchanged.\n\nWhen using this method, it is best to specify only those fields you wish\nto change, or else you may overwrite changes made by another user since\nyou last retrieved the task.\n\nReturns the complete updated task record." }, { "info": { "name": "Asana Delete a task", "type": "http" }, "http": { "method": "DELETE", "url": "https://app.asana.com/api/1.0/tasks/:task_gid", "params": [ { "name": "task_gid", "value": "321654", "type": "path", "description": "The task to operate on." }, { "name": "opt_pretty", "value": "true", "type": "query", "description": "Provides “pretty” output.\nProvides 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." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://app.asana.com/-/oauth_authorize", "accessTokenUrl": "https://app.asana.com/-/oauth_token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "A specific, existing task can be deleted by making a DELETE request on\nthe URL for that task. Deleted tasks go into the “trash” of the user\nmaking the delete request. Tasks can be recovered from the trash within a\nperiod of 30 days; afterward they are completely removed from the system.\n\nReturns an empty data record." }, { "info": { "name": "Asana Duplicate a task", "type": "http" }, "http": { "method": "POST", "url": "https://app.asana.com/api/1.0/tasks/:task_gid/duplicate", "params": [ { "name": "task_gid", "value": "321654", "type": "path", "description": "The task to operate on." }, { "name": "opt_pretty", "value": "true", "type": "query", "description": "Provides “pretty” output.\nProvides 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." }, { "name": "opt_fields", "value": "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", "type": "query", "description": "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." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://app.asana.com/-/oauth_authorize", "accessTokenUrl": "https://app.asana.com/-/oauth_token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Creates and returns a job that will asynchronously handle the duplication." }, { "info": { "name": "Asana Get tasks from a project", "type": "http" }, "http": { "method": "GET", "url": "https://app.asana.com/api/1.0/projects/:project_gid/tasks", "params": [ { "name": "completed_since", "value": "2012-02-22T02:06:58.158Z", "type": "query", "description": "Only return tasks that are either incomplete or that have been completed since this time. Accepts a date-time string or the keyword *now*.\n" }, { "name": "project_gid", "value": "1331", "type": "path", "description": "Globally unique identifier for the project." }, { "name": "opt_pretty", "value": "true", "type": "query", "description": "Provides “pretty” output.\nProvides 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." }, { "name": "limit", "value": "50", "type": "query", "description": "Results per page.\nThe number of objects to return per page. The value must be between 1 and 100." }, { "name": "offset", "value": "eyJ0eXAiOJiKV1iQLCJhbGciOiJIUzI1NiJ9", "type": "query", "description": "Offset token.\nAn 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.\n*Note: You can only pass in an offset that was returned to you via a previously paginated request.*" }, { "name": "opt_fields", "value": "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", "type": "query", "description": "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." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://app.asana.com/-/oauth_authorize", "accessTokenUrl": "https://app.asana.com/-/oauth_token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Returns the compact task records for all tasks within the given project, ordered by their priority within the project. Tasks can exist in more than one project at a time." }, { "info": { "name": "Asana Get tasks from a section", "type": "http" }, "http": { "method": "GET", "url": "https://app.asana.com/api/1.0/sections/:section_gid/tasks", "params": [ { "name": "section_gid", "value": "321654", "type": "path", "description": "The globally unique identifier for the section." }, { "name": "opt_pretty", "value": "true", "type": "query", "description": "Provides “pretty” output.\nProvides 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." }, { "name": "limit", "value": "50", "type": "query", "description": "Results per page.\nThe number of objects to return per page. The value must be between 1 and 100." }, { "name": "offset", "value": "eyJ0eXAiOJiKV1iQLCJhbGciOiJIUzI1NiJ9", "type": "query", "description": "Offset token.\nAn 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.\n*Note: You can only pass in an offset that was returned to you via a previously paginated request.*" }, { "name": "completed_since", "value": "2012-02-22T02:06:58.158Z", "type": "query", "description": "Only return tasks that are either incomplete or that have been completed since this time. Accepts a date-time string or the keyword *now*.\n" }, { "name": "opt_fields", "value": "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", "type": "query", "description": "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." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://app.asana.com/-/oauth_authorize", "accessTokenUrl": "https://app.asana.com/-/oauth_token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "*Board view only*: Returns the compact section records for all tasks within the given section." }, { "info": { "name": "Asana Get tasks from a tag", "type": "http" }, "http": { "method": "GET", "url": "https://app.asana.com/api/1.0/tags/:tag_gid/tasks", "params": [ { "name": "tag_gid", "value": "11235", "type": "path", "description": "Globally unique identifier for the tag." }, { "name": "opt_pretty", "value": "true", "type": "query", "description": "Provides “pretty” output.\nProvides 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." }, { "name": "limit", "value": "50", "type": "query", "description": "Results per page.\nThe number of objects to return per page. The value must be between 1 and 100." }, { "name": "offset", "value": "eyJ0eXAiOJiKV1iQLCJhbGciOiJIUzI1NiJ9", "type": "query", "description": "Offset token.\nAn 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.\n*Note: You can only pass in an offset that was returned to you via a previously paginated request.*" }, { "name": "opt_fields", "value": "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", "type": "query", "description": "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." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://app.asana.com/-/oauth_authorize", "accessTokenUrl": "https://app.asana.com/-/oauth_token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Returns the compact task records for all tasks with the given tag. Tasks can have more than one tag at a time." }, { "info": { "name": "Asana Get tasks from a user task list", "type": "http" }, "http": { "method": "GET", "url": "https://app.asana.com/api/1.0/user_task_lists/:user_task_list_gid/tasks", "params": [ { "name": "completed_since", "value": "2012-02-22T02:06:58.158Z", "type": "query", "description": "Only return tasks that are either incomplete or that have been completed since this time. Accepts a date-time string or the keyword *now*.\n" }, { "name": "user_task_list_gid", "value": "12345", "type": "path", "description": "Globally unique identifier for the user task list." }, { "name": "opt_pretty", "value": "true", "type": "query", "description": "Provides “pretty” output.\nProvides 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." }, { "name": "limit", "value": "50", "type": "query", "description": "Results per page.\nThe number of objects to return per page. The value must be between 1 and 100." }, { "name": "offset", "value": "eyJ0eXAiOJiKV1iQLCJhbGciOiJIUzI1NiJ9", "type": "query", "description": "Offset token.\nAn 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.\n*Note: You can only pass in an offset that was returned to you via a previously paginated request.*" }, { "name": "opt_fields", "value": "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", "type": "query", "description": "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." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://app.asana.com/-/oauth_authorize", "accessTokenUrl": "https://app.asana.com/-/oauth_token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Returns the compact list of tasks in a user’s My Tasks list.\n*Note: Access control is enforced for this endpoint as with all Asana API endpoints, meaning a user’s private tasks will be filtered out if the API-authenticated user does not have access to them.*\n*Note: Both complete and incomplete tasks are returned by default unless they are filtered out (for example, setting `completed_since=now` will return only incomplete tasks, which is the default view for “My Tasks” in Asana.)*" }, { "info": { "name": "Asana Get subtasks from a task", "type": "http" }, "http": { "method": "GET", "url": "https://app.asana.com/api/1.0/tasks/:task_gid/subtasks", "params": [ { "name": "task_gid", "value": "321654", "type": "path", "description": "The task to operate on." }, { "name": "opt_pretty", "value": "true", "type": "query", "description": "Provides “pretty” output.\nProvides 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." }, { "name": "limit", "value": "50", "type": "query", "description": "Results per page.\nThe number of objects to return per page. The value must be between 1 and 100." }, { "name": "offset", "value": "eyJ0eXAiOJiKV1iQLCJhbGciOiJIUzI1NiJ9", "type": "query", "description": "Offset token.\nAn 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.\n*Note: You can only pass in an offset that was returned to you via a previously paginated request.*" }, { "name": "opt_fields", "value": "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", "type": "query", "description": "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." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://app.asana.com/-/oauth_authorize", "accessTokenUrl": "https://app.asana.com/-/oauth_token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Returns a compact representation of all of the subtasks of a task." }, { "info": { "name": "Asana Create a subtask", "type": "http" }, "http": { "method": "POST", "url": "https://app.asana.com/api/1.0/tasks/:task_gid/subtasks", "params": [ { "name": "task_gid", "value": "321654", "type": "path", "description": "The task to operate on." }, { "name": "opt_pretty", "value": "true", "type": "query", "description": "Provides “pretty” output.\nProvides 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." }, { "name": "opt_fields", "value": "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", "type": "query", "description": "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." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://app.asana.com/-/oauth_authorize", "accessTokenUrl": "https://app.asana.com/-/oauth_token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Creates a new subtask and adds it to the parent task. Returns the full record for the newly created subtask." }, { "info": { "name": "Asana Set the parent of a task", "type": "http" }, "http": { "method": "POST", "url": "https://app.asana.com/api/1.0/tasks/:task_gid/setParent", "params": [ { "name": "task_gid", "value": "321654", "type": "path", "description": "The task to operate on." }, { "name": "opt_pretty", "value": "true", "type": "query", "description": "Provides “pretty” output.\nProvides 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." }, { "name": "opt_fields", "value": "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", "type": "query", "description": "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." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://app.asana.com/-/oauth_authorize", "accessTokenUrl": "https://app.asana.com/-/oauth_token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "parent, or no parent task at all. Returns an empty data block. When using `insert_before` and `insert_after`, at most one of those two options can be specified, and they must already be subtasks of the parent." }, { "info": { "name": "Asana Get dependencies from a task", "type": "http" }, "http": { "method": "GET", "url": "https://app.asana.com/api/1.0/tasks/:task_gid/dependencies", "params": [ { "name": "task_gid", "value": "321654", "type": "path", "description": "The task to operate on." }, { "name": "opt_pretty", "value": "true", "type": "query", "description": "Provides “pretty” output.\nProvides 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." }, { "name": "limit", "value": "50", "type": "query", "description": "Results per page.\nThe number of objects to return per page. The value must be between 1 and 100." }, { "name": "offset", "value": "eyJ0eXAiOJiKV1iQLCJhbGciOiJIUzI1NiJ9", "type": "query", "description": "Offset token.\nAn 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.\n*Note: You can only pass in an offset that was returned to you via a previously paginated request.*" }, { "name": "opt_fields", "value": "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", "type": "query", "description": "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." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://app.asana.com/-/oauth_authorize", "accessTokenUrl": "https://app.asana.com/-/oauth_token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Returns the compact representations of all of the dependencies of a task." }, { "info": { "name": "Asana Set dependencies for a task", "type": "http" }, "http": { "method": "POST", "url": "https://app.asana.com/api/1.0/tasks/:task_gid/addDependencies", "params": [ { "name": "task_gid", "value": "321654", "type": "path", "description": "The task to operate on." }, { "name": "opt_pretty", "value": "true", "type": "query", "description": "Provides “pretty” output.\nProvides 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." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://app.asana.com/-/oauth_authorize", "accessTokenUrl": "https://app.asana.com/-/oauth_token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Marks a set of tasks as dependencies of this task, if they are not already dependencies. *A task can have at most 30 dependents and dependencies combined*." }, { "info": { "name": "Asana Unlink dependencies from a task", "type": "http" }, "http": { "method": "POST", "url": "https://app.asana.com/api/1.0/tasks/:task_gid/removeDependencies", "params": [ { "name": "task_gid", "value": "321654", "type": "path", "description": "The task to operate on." }, { "name": "opt_pretty", "value": "true", "type": "query", "description": "Provides “pretty” output.\nProvides 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." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://app.asana.com/-/oauth_authorize", "accessTokenUrl": "https://app.asana.com/-/oauth_token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Unlinks a set of dependencies from this task." }, { "info": { "name": "Asana Get dependents from a task", "type": "http" }, "http": { "method": "GET", "url": "https://app.asana.com/api/1.0/tasks/:task_gid/dependents", "params": [ { "name": "task_gid", "value": "321654", "type": "path", "description": "The task to operate on." }, { "name": "opt_pretty", "value": "true", "type": "query", "description": "Provides “pretty” output.\nProvides 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." }, { "name": "limit", "value": "50", "type": "query", "description": "Results per page.\nThe number of objects to return per page. The value must be between 1 and 100." }, { "name": "offset", "value": "eyJ0eXAiOJiKV1iQLCJhbGciOiJIUzI1NiJ9", "type": "query", "description": "Offset token.\nAn 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.\n*Note: You can only pass in an offset that was returned to you via a previously paginated request.*" }, { "name": "opt_fields", "value": "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", "type": "query", "description": "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." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://app.asana.com/-/oauth_authorize", "accessTokenUrl": "https://app.asana.com/-/oauth_token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Returns the compact representations of all of the dependents of a task." }, { "info": { "name": "Asana Set dependents for a task", "type": "http" }, "http": { "method": "POST", "url": "https://app.asana.com/api/1.0/tasks/:task_gid/addDependents", "params": [ { "name": "task_gid", "value": "321654", "type": "path", "description": "The task to operate on." }, { "name": "opt_pretty", "value": "true", "type": "query", "description": "Provides “pretty” output.\nProvides 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." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://app.asana.com/-/oauth_authorize", "accessTokenUrl": "https://app.asana.com/-/oauth_token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Marks a set of tasks as dependents of this task, if they are not already dependents. *A task can have at most 30 dependents and dependencies combined*." }, { "info": { "name": "Asana Unlink dependents from a task", "type": "http" }, "http": { "method": "POST", "url": "https://app.asana.com/api/1.0/tasks/:task_gid/removeDependents", "params": [ { "name": "task_gid", "value": "321654", "type": "path", "description": "The task to operate on." }, { "name": "opt_pretty", "value": "true", "type": "query", "description": "Provides “pretty” output.\nProvides 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." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://app.asana.com/-/oauth_authorize", "accessTokenUrl": "https://app.asana.com/-/oauth_token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Unlinks a set of dependents from this task." }, { "info": { "name": "Asana Add a project to a task", "type": "http" }, "http": { "method": "POST", "url": "https://app.asana.com/api/1.0/tasks/:task_gid/addProject", "params": [ { "name": "task_gid", "value": "321654", "type": "path", "description": "The task to operate on." }, { "name": "opt_pretty", "value": "true", "type": "query", "description": "Provides “pretty” output.\nProvides 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." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://app.asana.com/-/oauth_authorize", "accessTokenUrl": "https://app.asana.com/-/oauth_token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Adds the task to the specified project, in the optional location\nspecified. If no location arguments are given, the task will be added to\nthe end of the project.\n\n`addProject` can also be used to reorder a task within a project or\nsection that already contains it.\n\nAt most one of `insert_before`, `insert_after`, or `section` should be\nspecified. Inserting into a section in an non-order-dependent way can be\ndone by specifying section, otherwise, to insert within a section in a\nparticular place, s" }, { "info": { "name": "Asana Remove a project from a task", "type": "http" }, "http": { "method": "POST", "url": "https://app.asana.com/api/1.0/tasks/:task_gid/removeProject", "params": [ { "name": "task_gid", "value": "321654", "type": "path", "description": "The task to operate on." }, { "name": "opt_pretty", "value": "true", "type": "query", "description": "Provides “pretty” output.\nProvides 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." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://app.asana.com/-/oauth_authorize", "accessTokenUrl": "https://app.asana.com/-/oauth_token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Removes the task from the specified project. The task will still exist in\nthe system, but it will not be in the project anymore.\n\nReturns an empty data block." }, { "info": { "name": "Asana Add a tag to a task", "type": "http" }, "http": { "method": "POST", "url": "https://app.asana.com/api/1.0/tasks/:task_gid/addTag", "params": [ { "name": "task_gid", "value": "321654", "type": "path", "description": "The task to operate on." }, { "name": "opt_pretty", "value": "true", "type": "query", "description": "Provides “pretty” output.\nProvides 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." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://app.asana.com/-/oauth_authorize", "accessTokenUrl": "https://app.asana.com/-/oauth_token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Adds a tag to a task. Returns an empty data block." }, { "info": { "name": "Asana Remove a tag from a task", "type": "http" }, "http": { "method": "POST", "url": "https://app.asana.com/api/1.0/tasks/:task_gid/removeTag", "params": [ { "name": "task_gid", "value": "321654", "type": "path", "description": "The task to operate on." }, { "name": "opt_pretty", "value": "true", "type": "query", "description": "Provides “pretty” output.\nProvides 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." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://app.asana.com/-/oauth_authorize", "accessTokenUrl": "https://app.asana.com/-/oauth_token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Removes a tag from a task. Returns an empty data block." }, { "info": { "name": "Asana Add followers to a task", "type": "http" }, "http": { "method": "POST", "url": "https://app.asana.com/api/1.0/tasks/:task_gid/addFollowers", "params": [ { "name": "task_gid", "value": "321654", "type": "path", "description": "The task to operate on." }, { "name": "opt_pretty", "value": "true", "type": "query", "description": "Provides “pretty” output.\nProvides 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." }, { "name": "opt_fields", "value": "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", "type": "query", "description": "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." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://app.asana.com/-/oauth_authorize", "accessTokenUrl": "https://app.asana.com/-/oauth_token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Adds followers to a task. Returns an empty data block.\nEach task can be associated with zero or more followers in the system.\nRequests to add/remove followers, if successful, will return the complete updated task record, described above." }, { "info": { "name": "Asana Remove followers from a task", "type": "http" }, "http": { "method": "POST", "url": "https://app.asana.com/api/1.0/tasks/:task_gid/removeFollowers", "params": [ { "name": "task_gid", "value": "321654", "type": "path", "description": "The task to operate on." }, { "name": "opt_pretty", "value": "true", "type": "query", "description": "Provides “pretty” output.\nProvides 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." }, { "name": "opt_fields", "value": "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", "type": "query", "description": "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." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://app.asana.com/-/oauth_authorize", "accessTokenUrl": "https://app.asana.com/-/oauth_token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Removes each of the specified followers from the task if they are following. Returns the complete, updated record for the affected task." }, { "info": { "name": "Asana Get a task for a given custom ID", "type": "http" }, "http": { "method": "GET", "url": "https://app.asana.com/api/1.0/workspaces/:workspace_gid/tasks/custom_id/:custom_id", "params": [ { "name": "workspace_gid", "value": "12345", "type": "path", "description": "Globally unique identifier for the workspace or organization." }, { "name": "custom_id", "value": "EX-1", "type": "path", "description": "Generated custom ID for a task." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://app.asana.com/-/oauth_authorize", "accessTokenUrl": "https://app.asana.com/-/oauth_token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Returns a task given a custom ID shortcode." }, { "info": { "name": "Asana Search tasks in a workspace", "type": "http" }, "http": { "method": "GET", "url": "https://app.asana.com/api/1.0/workspaces/:workspace_gid/tasks/search", "params": [ { "name": "workspace_gid", "value": "12345", "type": "path", "description": "Globally unique identifier for the workspace or organization." }, { "name": "opt_pretty", "value": "true", "type": "query", "description": "Provides “pretty” output.\nProvides 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." }, { "name": "text", "value": "Bug", "type": "query", "description": "Performs full-text search on both task name and description" }, { "name": "resource_subtype", "value": "", "type": "query", "description": "Filters results by the task's resource_subtype" }, { "name": "assignee.any", "value": "12345,23456,34567", "type": "query", "description": "Comma-separated list of user identifiers" }, { "name": "assignee.not", "value": "12345,23456,34567", "type": "query", "description": "Comma-separated list of user identifiers" }, { "name": "portfolios.any", "value": "12345,23456,34567", "type": "query", "description": "Comma-separated list of portfolio IDs" }, { "name": "projects.any", "value": "12345,23456,34567", "type": "query", "description": "Comma-separated list of project IDs" }, { "name": "projects.not", "value": "12345,23456,34567", "type": "query", "description": "Comma-separated list of project IDs" }, { "name": "projects.all", "value": "12345,23456,34567", "type": "query", "description": "Comma-separated list of project IDs" }, { "name": "sections.any", "value": "12345,23456,34567", "type": "query", "description": "Comma-separated list of section or column IDs" }, { "name": "sections.not", "value": "12345,23456,34567", "type": "query", "description": "Comma-separated list of section or column IDs" }, { "name": "sections.all", "value": "12345,23456,34567", "type": "query", "description": "Comma-separated list of section or column IDs" }, { "name": "tags.any", "value": "12345,23456,34567", "type": "query", "description": "Comma-separated list of tag IDs" }, { "name": "tags.not", "value": "12345,23456,34567", "type": "query", "description": "Comma-separated list of tag IDs" }, { "name": "tags.all", "value": "12345,23456,34567", "type": "query", "description": "Comma-separated list of tag IDs" }, { "name": "teams.any", "value": "12345,23456,34567", "type": "query", "description": "Comma-separated list of team IDs" }, { "name": "followers.not", "value": "12345,23456,34567", "type": "query", "description": "Comma-separated list of user identifiers" }, { "name": "created_by.any", "value": "12345,23456,34567", "type": "query", "description": "Comma-separated list of user identifiers" }, { "name": "created_by.not", "value": "12345,23456,34567", "type": "query", "description": "Comma-separated list of user identifiers" }, { "name": "assigned_by.any", "value": "12345,23456,34567", "type": "query", "description": "Comma-separated list of user identifiers" }, { "name": "assigned_by.not", "value": "12345,23456,34567", "type": "query", "description": "Comma-separated list of user identifiers" }, { "name": "liked_by.not", "value": "12345,23456,34567", "type": "query", "description": "Comma-separated list of user identifiers" }, { "name": "commented_on_by.not", "value": "12345,23456,34567", "type": "query", "description": "Comma-separated list of user identifiers" }, { "name": "due_on.before", "value": "2019-09-15", "type": "query", "description": "ISO 8601 date string" }, { "name": "due_on.after", "value": "2019-09-15", "type": "query", "description": "ISO 8601 date string" }, { "name": "due_on", "value": "2019-09-15", "type": "query", "description": "ISO 8601 date string or `null`" }, { "name": "due_at.before", "value": "2019-04-15T01:01:46.055Z", "type": "query", "description": "ISO 8601 datetime string" }, { "name": "due_at.after", "value": "2019-04-15T01:01:46.055Z", "type": "query", "description": "ISO 8601 datetime string" }, { "name": "start_on.before", "value": "2019-09-15", "type": "query", "description": "ISO 8601 date string" }, { "name": "start_on.after", "value": "2019-09-15", "type": "query", "description": "ISO 8601 date string" }, { "name": "start_on", "value": "2019-09-15", "type": "query", "description": "ISO 8601 date string or `null`" }, { "name": "created_on.before", "value": "2019-09-15", "type": "query", "description": "ISO 8601 date string" }, { "name": "created_on.after", "value": "2019-09-15", "type": "query", "description": "ISO 8601 date string" }, { "name": "created_on", "value": "2019-09-15", "type": "query", "description": "ISO 8601 date string or `null`" }, { "name": "created_at.before", "value": "2019-04-15T01:01:46.055Z", "type": "query", "description": "ISO 8601 datetime string" }, { "name": "created_at.after", "value": "2019-04-15T01:01:46.055Z", "type": "query", "description": "ISO 8601 datetime string" }, { "name": "completed_on.before", "value": "2019-09-15", "type": "query", "description": "ISO 8601 date string" }, { "name": "completed_on.after", "value": "2019-09-15", "type": "query", "description": "ISO 8601 date string" }, { "name": "completed_on", "value": "2019-09-15", "type": "query", "description": "ISO 8601 date string or `null`" }, { "name": "completed_at.before", "value": "2019-04-15T01:01:46.055Z", "type": "query", "description": "ISO 8601 datetime string" }, { "name": "completed_at.after", "value": "2019-04-15T01:01:46.055Z", "type": "query", "description": "ISO 8601 datetime string" }, { "name": "modified_on.before", "value": "2019-09-15", "type": "query", "description": "ISO 8601 date string" }, { "name": "modified_on.after", "value": "2019-09-15", "type": "query", "description": "ISO 8601 date string" }, { "name": "modified_on", "value": "2019-09-15", "type": "query", "description": "ISO 8601 date string or `null`" }, { "name": "modified_at.before", "value": "2019-04-15T01:01:46.055Z", "type": "query", "description": "ISO 8601 datetime string" }, { "name": "modified_at.after", "value": "2019-04-15T01:01:46.055Z", "type": "query", "description": "ISO 8601 datetime string" }, { "name": "is_blocking", "value": "false", "type": "query", "description": "Filter to incomplete tasks with dependents" }, { "name": "is_blocked", "value": "false", "type": "query", "description": "Filter to tasks with incomplete dependencies" }, { "name": "has_attachment", "value": "false", "type": "query", "description": "Filter to tasks with attachments" }, { "name": "completed", "value": "false", "type": "query", "description": "Filter to completed tasks" }, { "name": "is_subtask", "value": "false", "type": "query", "description": "Filter to subtasks" }, { "name": "sort_by", "value": "likes", "type": "query", "description": "One of `due_date`, `created_at`, `completed_at`, `likes`, or `modified_at`, defaults to `modified_at`" }, { "name": "sort_ascending", "value": "true", "type": "query", "description": "Default `false`" }, { "name": "opt_fields", "value": "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", "type": "query", "description": "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." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://app.asana.com/-/oauth_authorize", "accessTokenUrl": "https://app.asana.com/-/oauth_token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "To mirror the functionality of the Asana web app's advanced search feature, the Asana API has a task search endpoint that allows you to build complex filters to find and retrieve the exact data you need.\n#### Premium access\nLike the Asana web product's advance search feature, this search endpoint will only be available to premium Asana users. A user is premium if any of the following is true:\n\n- The workspace in which the search is being performed is a premium workspace - The user is a member of" } ] }, { "info": { "name": "Team Memberships", "type": "folder" }, "items": [ { "info": { "name": "Asana Get a team membership", "type": "http" }, "http": { "method": "GET", "url": "https://app.asana.com/api/1.0/team_memberships/:team_membership_gid", "params": [ { "name": "team_membership_gid", "value": "724362", "type": "path" }, { "name": "opt_pretty", "value": "true", "type": "query", "description": "Provides “pretty” output.\nProvides 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." }, { "name": "opt_fields", "value": "is_admin,is_guest,is_limited_access,team,team.name,user,user.name", "type": "query", "description": "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." } ] }, "docs": "Returns the complete team membership record for a single team membership." }, { "info": { "name": "Asana Get team memberships", "type": "http" }, "http": { "method": "GET", "url": "https://app.asana.com/api/1.0/team_memberships", "params": [ { "name": "opt_pretty", "value": "true", "type": "query", "description": "Provides “pretty” output.\nProvides 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." }, { "name": "limit", "value": "50", "type": "query", "description": "Results per page.\nThe number of objects to return per page. The value must be between 1 and 100." }, { "name": "offset", "value": "eyJ0eXAiOJiKV1iQLCJhbGciOiJIUzI1NiJ9", "type": "query", "description": "Offset token.\nAn 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.\n*Note: You can only pass in an offset that was returned to you via a previously paginated request.*" }, { "name": "team", "value": "159874", "type": "query", "description": "Globally unique identifier for the team." }, { "name": "user", "value": "512241", "type": "query", "description": "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." }, { "name": "workspace", "value": "31326", "type": "query", "description": "Globally unique identifier for the workspace. This parameter must be used with the user parameter." }, { "name": "opt_fields", "value": "is_admin,is_guest,is_limited_access,offset,path,team,team.name,uri,user,user.name", "type": "query", "description": "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." } ] }, "docs": "Returns compact team membership records." }, { "info": { "name": "Asana Get memberships from a team", "type": "http" }, "http": { "method": "GET", "url": "https://app.asana.com/api/1.0/teams/:team_gid/team_memberships", "params": [ { "name": "team_gid", "value": "159874", "type": "path", "description": "Globally unique identifier for the team." }, { "name": "opt_pretty", "value": "true", "type": "query", "description": "Provides “pretty” output.\nProvides 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." }, { "name": "limit", "value": "50", "type": "query", "description": "Results per page.\nThe number of objects to return per page. The value must be between 1 and 100." }, { "name": "offset", "value": "eyJ0eXAiOJiKV1iQLCJhbGciOiJIUzI1NiJ9", "type": "query", "description": "Offset token.\nAn 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.\n*Note: You can only pass in an offset that was returned to you via a previously paginated request.*" }, { "name": "opt_fields", "value": "is_admin,is_guest,is_limited_access,offset,path,team,team.name,uri,user,user.name", "type": "query", "description": "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." } ] }, "docs": "Returns the compact team memberships for the team." }, { "info": { "name": "Asana Get memberships from a user", "type": "http" }, "http": { "method": "GET", "url": "https://app.asana.com/api/1.0/users/:user_gid/team_memberships", "params": [ { "name": "user_gid", "value": "me", "type": "path", "description": "A string identifying a user. This can either be the string \"me\", an email, or the gid of a user." }, { "name": "opt_pretty", "value": "true", "type": "query", "description": "Provides “pretty” output.\nProvides 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." }, { "name": "limit", "value": "50", "type": "query", "description": "Results per page.\nThe number of objects to return per page. The value must be between 1 and 100." }, { "name": "offset", "value": "eyJ0eXAiOJiKV1iQLCJhbGciOiJIUzI1NiJ9", "type": "query", "description": "Offset token.\nAn 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.\n*Note: You can only pass in an offset that was returned to you via a previously paginated request.*" }, { "name": "workspace", "value": "31326", "type": "query", "description": "Globally unique identifier for the workspace." }, { "name": "opt_fields", "value": "is_admin,is_guest,is_limited_access,offset,path,team,team.name,uri,user,user.name", "type": "query", "description": "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." } ] }, "docs": "Returns the compact team membership records for the user." } ] }, { "info": { "name": "Teams", "type": "folder" }, "items": [ { "info": { "name": "Asana Create a team", "type": "http" }, "http": { "method": "POST", "url": "https://app.asana.com/api/1.0/teams", "params": [ { "name": "opt_pretty", "value": "true", "type": "query", "description": "Provides “pretty” output.\nProvides 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." }, { "name": "opt_fields", "value": "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_content_management_access_level,team_member_removal_access_level,visibility", "type": "query", "description": "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." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a team within the current workspace." }, { "info": { "name": "Asana Get a team", "type": "http" }, "http": { "method": "GET", "url": "https://app.asana.com/api/1.0/teams/:team_gid", "params": [ { "name": "team_gid", "value": "159874", "type": "path", "description": "Globally unique identifier for the team." }, { "name": "opt_pretty", "value": "true", "type": "query", "description": "Provides “pretty” output.\nProvides 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." }, { "name": "opt_fields", "value": "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_content_management_access_level,team_member_removal_access_level,visibility", "type": "query", "description": "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." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://app.asana.com/-/oauth_authorize", "accessTokenUrl": "https://app.asana.com/-/oauth_token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Returns the full record for a single team." }, { "info": { "name": "Asana Update a team", "type": "http" }, "http": { "method": "PUT", "url": "https://app.asana.com/api/1.0/teams/:team_gid", "params": [ { "name": "team_gid", "value": "159874", "type": "path", "description": "Globally unique identifier for the team." }, { "name": "opt_pretty", "value": "true", "type": "query", "description": "Provides “pretty” output.\nProvides 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." }, { "name": "opt_fields", "value": "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_content_management_access_level,team_member_removal_access_level,visibility", "type": "query", "description": "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." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a team within the current workspace." }, { "info": { "name": "Asana Get teams in a workspace", "type": "http" }, "http": { "method": "GET", "url": "https://app.asana.com/api/1.0/workspaces/:workspace_gid/teams", "params": [ { "name": "workspace_gid", "value": "12345", "type": "path", "description": "Globally unique identifier for the workspace or organization." }, { "name": "opt_pretty", "value": "true", "type": "query", "description": "Provides “pretty” output.\nProvides 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." }, { "name": "limit", "value": "50", "type": "query", "description": "Results per page.\nThe number of objects to return per page. The value must be between 1 and 100." }, { "name": "offset", "value": "eyJ0eXAiOJiKV1iQLCJhbGciOiJIUzI1NiJ9", "type": "query", "description": "Offset token.\nAn 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.\n*Note: You can only pass in an offset that was returned to you via a previously paginated request.*" }, { "name": "opt_fields", "value": "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_content_management_access_level,team_member_removal_access_level,uri,visibility", "type": "query", "description": "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." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://app.asana.com/-/oauth_authorize", "accessTokenUrl": "https://app.asana.com/-/oauth_token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Returns the compact records for all teams in the workspace visible to the authorized user." }, { "info": { "name": "Asana Get teams for a user", "type": "http" }, "http": { "method": "GET", "url": "https://app.asana.com/api/1.0/users/:user_gid/teams", "params": [ { "name": "user_gid", "value": "me", "type": "path", "description": "A string identifying a user. This can either be the string \"me\", an email, or the gid of a user." }, { "name": "opt_pretty", "value": "true", "type": "query", "description": "Provides “pretty” output.\nProvides 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." }, { "name": "limit", "value": "50", "type": "query", "description": "Results per page.\nThe number of objects to return per page. The value must be between 1 and 100." }, { "name": "offset", "value": "eyJ0eXAiOJiKV1iQLCJhbGciOiJIUzI1NiJ9", "type": "query", "description": "Offset token.\nAn 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.\n*Note: You can only pass in an offset that was returned to you via a previously paginated request.*" }, { "name": "organization", "value": "1331", "type": "query", "description": "The workspace or organization to filter teams on." }, { "name": "opt_fields", "value": "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_content_management_access_level,team_member_removal_access_level,uri,visibility", "type": "query", "description": "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." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://app.asana.com/-/oauth_authorize", "accessTokenUrl": "https://app.asana.com/-/oauth_token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Returns the compact records for all teams to which the given user is assigned." }, { "info": { "name": "Asana Add a user to a team", "type": "http" }, "http": { "method": "POST", "url": "https://app.asana.com/api/1.0/teams/:team_gid/addUser", "params": [ { "name": "team_gid", "value": "159874", "type": "path", "description": "Globally unique identifier for the team." }, { "name": "opt_pretty", "value": "true", "type": "query", "description": "Provides “pretty” output.\nProvides 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." }, { "name": "opt_fields", "value": "is_admin,is_guest,is_limited_access,team,team.name,user,user.name", "type": "query", "description": "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." } ], "body": { "type": "json", "data": "{}" } }, "docs": "The user making this call must be a member of the team in order to add others. The user being added must exist in the same organization as the team.\n\nReturns the complete team membership record for the newly added user." }, { "info": { "name": "Asana Remove a user from a team", "type": "http" }, "http": { "method": "POST", "url": "https://app.asana.com/api/1.0/teams/:team_gid/removeUser", "params": [ { "name": "team_gid", "value": "159874", "type": "path", "description": "Globally unique identifier for the team." }, { "name": "opt_pretty", "value": "true", "type": "query", "description": "Provides “pretty” output.\nProvides 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." } ], "body": { "type": "json", "data": "{}" } }, "docs": "The user making this call must be a member of the team in order to remove themselves or others." } ] }, { "info": { "name": "Time Periods", "type": "folder" }, "items": [ { "info": { "name": "Asana Get a time period", "type": "http" }, "http": { "method": "GET", "url": "https://app.asana.com/api/1.0/time_periods/:time_period_gid", "params": [ { "name": "time_period_gid", "value": "917392", "type": "path", "description": "Globally unique identifier for the time period." }, { "name": "opt_pretty", "value": "true", "type": "query", "description": "Provides “pretty” output.\nProvides 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." }, { "name": "opt_fields", "value": "display_name,end_on,parent,parent.display_name,parent.end_on,parent.period,parent.start_on,period,start_on", "type": "query", "description": "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." } ] }, "docs": "Returns the full record for a single time period." }, { "info": { "name": "Asana Get time periods", "type": "http" }, "http": { "method": "GET", "url": "https://app.asana.com/api/1.0/time_periods", "params": [ { "name": "opt_pretty", "value": "true", "type": "query", "description": "Provides “pretty” output.\nProvides 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." }, { "name": "limit", "value": "50", "type": "query", "description": "Results per page.\nThe number of objects to return per page. The value must be between 1 and 100." }, { "name": "offset", "value": "eyJ0eXAiOJiKV1iQLCJhbGciOiJIUzI1NiJ9", "type": "query", "description": "Offset token.\nAn 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.\n*Note: You can only pass in an offset that was returned to you via a previously paginated request.*" }, { "name": "start_on", "value": "2019-09-15", "type": "query", "description": "ISO 8601 date string" }, { "name": "end_on", "value": "2019-09-15", "type": "query", "description": "ISO 8601 date string" }, { "name": "workspace", "value": "31326", "type": "query", "description": "Globally unique identifier for the workspace." }, { "name": "opt_fields", "value": "display_name,end_on,offset,parent,parent.display_name,parent.end_on,parent.period,parent.start_on,path,period,start_on,uri", "type": "query", "description": "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." } ] }, "docs": "Returns compact time period records." } ] }, { "info": { "name": "Time Tracking Entries", "type": "folder" }, "items": [ { "info": { "name": "Asana Get time tracking entries for a task", "type": "http" }, "http": { "method": "GET", "url": "https://app.asana.com/api/1.0/tasks/:task_gid/time_tracking_entries", "params": [ { "name": "task_gid", "value": "321654", "type": "path", "description": "The task to operate on." }, { "name": "opt_pretty", "value": "true", "type": "query", "description": "Provides “pretty” output.\nProvides 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." }, { "name": "limit", "value": "50", "type": "query", "description": "Results per page.\nThe number of objects to return per page. The value must be between 1 and 100." }, { "name": "offset", "value": "eyJ0eXAiOJiKV1iQLCJhbGciOiJIUzI1NiJ9", "type": "query", "description": "Offset token.\nAn 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.\n*Note: You can only pass in an offset that was returned to you via a previously paginated request.*" }, { "name": "opt_fields", "value": "created_by,created_by.name,duration_minutes,entered_on,offset,path,uri", "type": "query", "description": "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." } ] }, "docs": "Returns time tracking entries for a given task." }, { "info": { "name": "Asana Create a time tracking entry", "type": "http" }, "http": { "method": "POST", "url": "https://app.asana.com/api/1.0/tasks/:task_gid/time_tracking_entries", "params": [ { "name": "task_gid", "value": "321654", "type": "path", "description": "The task to operate on." }, { "name": "opt_pretty", "value": "true", "type": "query", "description": "Provides “pretty” output.\nProvides 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." }, { "name": "opt_fields", "value": "created_at,created_by,created_by.name,duration_minutes,entered_on,task,task.created_by,task.name,task.resource_subtype", "type": "query", "description": "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." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a time tracking entry on a given task.\n\nReturns the record of the newly created time tracking entry." }, { "info": { "name": "Asana Get a time tracking entry", "type": "http" }, "http": { "method": "GET", "url": "https://app.asana.com/api/1.0/time_tracking_entries/:time_tracking_entry_gid", "params": [ { "name": "time_tracking_entry_gid", "value": "917392", "type": "path", "description": "Globally unique identifier for the time tracking entry." }, { "name": "opt_pretty", "value": "true", "type": "query", "description": "Provides “pretty” output.\nProvides 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." }, { "name": "opt_fields", "value": "created_at,created_by,created_by.name,duration_minutes,entered_on,task,task.created_by,task.name,task.resource_subtype", "type": "query", "description": "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." } ] }, "docs": "Returns the complete time tracking entry record for a single time tracking entry." }, { "info": { "name": "Asana Update a time tracking entry", "type": "http" }, "http": { "method": "PUT", "url": "https://app.asana.com/api/1.0/time_tracking_entries/:time_tracking_entry_gid", "params": [ { "name": "time_tracking_entry_gid", "value": "917392", "type": "path", "description": "Globally unique identifier for the time tracking entry." }, { "name": "opt_pretty", "value": "true", "type": "query", "description": "Provides “pretty” output.\nProvides 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." }, { "name": "opt_fields", "value": "created_at,created_by,created_by.name,duration_minutes,entered_on,task,task.created_by,task.name,task.resource_subtype", "type": "query", "description": "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." } ], "body": { "type": "json", "data": "{}" } }, "docs": "A specific, existing time tracking entry can be updated by making a `PUT` request on\nthe URL for that time tracking entry. Only the fields provided in the `data` block\nwill be updated; any unspecified fields will remain unchanged.\n\nWhen using this method, it is best to specify only those fields you wish\nto change, or else you may overwrite changes made by another user since\nyou last retrieved the task.\n\nReturns the complete updated time tracking entry record." }, { "info": { "name": "Asana Delete a time tracking entry", "type": "http" }, "http": { "method": "DELETE", "url": "https://app.asana.com/api/1.0/time_tracking_entries/:time_tracking_entry_gid", "params": [ { "name": "time_tracking_entry_gid", "value": "917392", "type": "path", "description": "Globally unique identifier for the time tracking entry." }, { "name": "opt_pretty", "value": "true", "type": "query", "description": "Provides “pretty” output.\nProvides 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." } ] }, "docs": "A specific, existing time tracking entry can be deleted by making a `DELETE` request on\nthe URL for that time tracking entry.\n\nReturns an empty data record." } ] }, { "info": { "name": "Typeahead", "type": "folder" }, "items": [ { "info": { "name": "Asana Get objects via typeahead", "type": "http" }, "http": { "method": "GET", "url": "https://app.asana.com/api/1.0/workspaces/:workspace_gid/typeahead", "params": [ { "name": "workspace_gid", "value": "12345", "type": "path", "description": "Globally unique identifier for the workspace or organization." }, { "name": "resource_type", "value": "", "type": "query", "description": "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`, and `user`. 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." }, { "name": "type", "value": "", "type": "query", "description": "*Deprecated: new integrations should prefer the resource_type field.*" }, { "name": "query", "value": "Greg", "type": "query", "description": "The string that will be used to search for relevant objects. If an empty string is passed in, the API will return results." }, { "name": "count", "value": "20", "type": "query", "description": "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." }, { "name": "opt_pretty", "value": "true", "type": "query", "description": "Provides “pretty” output.\nProvides 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." }, { "name": "opt_fields", "value": "name", "type": "query", "description": "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." } ] }, "docs": "Retrieves objects in the workspace based via an auto-completion/typeahead\nsearch algorithm. This feature is meant to provide results quickly, so do\nnot rely on this API to provide extremely accurate search results. The\nresult set is limited to a single page of results with a maximum size, so\nyou won’t be able to fetch large numbers of results.\n\nThe typeahead search API provides search for objects from a single\nworkspace. This endpoint should be used to query for objects when\ncreating an auto-com" } ] }, { "info": { "name": "User Task Lists", "type": "folder" }, "items": [ { "info": { "name": "Asana Get a user task list", "type": "http" }, "http": { "method": "GET", "url": "https://app.asana.com/api/1.0/user_task_lists/:user_task_list_gid", "params": [ { "name": "user_task_list_gid", "value": "12345", "type": "path", "description": "Globally unique identifier for the user task list." }, { "name": "opt_pretty", "value": "true", "type": "query", "description": "Provides “pretty” output.\nProvides 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." }, { "name": "opt_fields", "value": "name,owner,workspace", "type": "query", "description": "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." } ] }, "docs": "Returns the full record for a user task list." }, { "info": { "name": "Asana Get a user's task list", "type": "http" }, "http": { "method": "GET", "url": "https://app.asana.com/api/1.0/users/:user_gid/user_task_list", "params": [ { "name": "user_gid", "value": "me", "type": "path", "description": "A string identifying a user. This can either be the string \"me\", an email, or the gid of a user." }, { "name": "opt_pretty", "value": "true", "type": "query", "description": "Provides “pretty” output.\nProvides 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." }, { "name": "workspace", "value": "1234", "type": "query", "description": "The workspace in which to get the user task list." }, { "name": "opt_fields", "value": "name,owner,workspace", "type": "query", "description": "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." } ] }, "docs": "Returns the full record for a user's task list." } ] }, { "info": { "name": "Users", "type": "folder" }, "items": [ { "info": { "name": "Asana Get multiple users", "type": "http" }, "http": { "method": "GET", "url": "https://app.asana.com/api/1.0/users", "params": [ { "name": "workspace", "value": "1331", "type": "query", "description": "The workspace or organization ID to filter users on." }, { "name": "team", "value": "15627", "type": "query", "description": "The team ID to filter users on." }, { "name": "opt_pretty", "value": "true", "type": "query", "description": "Provides “pretty” output.\nProvides 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." }, { "name": "limit", "value": "50", "type": "query", "description": "Results per page.\nThe number of objects to return per page. The value must be between 1 and 100." }, { "name": "offset", "value": "eyJ0eXAiOJiKV1iQLCJhbGciOiJIUzI1NiJ9", "type": "query", "description": "Offset token.\nAn 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.\n*Note: You can only pass in an offset that was returned to you via a previously paginated request.*" }, { "name": "opt_fields", "value": "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", "type": "query", "description": "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." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://app.asana.com/-/oauth_authorize", "accessTokenUrl": "https://app.asana.com/-/oauth_token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Returns the user records for all users in all workspaces and organizations accessible to the authenticated user. Accepts an optional workspace ID parameter.\nResults are sorted by user ID." }, { "info": { "name": "Asana Get a user", "type": "http" }, "http": { "method": "GET", "url": "https://app.asana.com/api/1.0/users/:user_gid", "params": [ { "name": "user_gid", "value": "me", "type": "path", "description": "A string identifying a user. This can either be the string \"me\", an email, or the gid of a user." }, { "name": "opt_pretty", "value": "true", "type": "query", "description": "Provides “pretty” output.\nProvides 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." }, { "name": "opt_fields", "value": "email,name,photo,photo.image_1024x1024,photo.image_128x128,photo.image_21x21,photo.image_27x27,photo.image_36x36,photo.image_60x60,workspaces,workspaces.name", "type": "query", "description": "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." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://app.asana.com/-/oauth_authorize", "accessTokenUrl": "https://app.asana.com/-/oauth_token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Returns the full user record for the single user with the provided ID." }, { "info": { "name": "Asana Get a user's favorites", "type": "http" }, "http": { "method": "GET", "url": "https://app.asana.com/api/1.0/users/:user_gid/favorites", "params": [ { "name": "user_gid", "value": "me", "type": "path", "description": "A string identifying a user. This can either be the string \"me\", an email, or the gid of a user." }, { "name": "opt_pretty", "value": "true", "type": "query", "description": "Provides “pretty” output.\nProvides 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." }, { "name": "limit", "value": "50", "type": "query", "description": "Results per page.\nThe number of objects to return per page. The value must be between 1 and 100." }, { "name": "offset", "value": "eyJ0eXAiOJiKV1iQLCJhbGciOiJIUzI1NiJ9", "type": "query", "description": "Offset token.\nAn 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.\n*Note: You can only pass in an offset that was returned to you via a previously paginated request.*" }, { "name": "resource_type", "value": "", "type": "query", "description": "The resource type of favorites to be returned." }, { "name": "workspace", "value": "1234", "type": "query", "description": "The workspace in which to get favorites." }, { "name": "opt_fields", "value": "name,offset,path,uri", "type": "query", "description": "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." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://app.asana.com/-/oauth_authorize", "accessTokenUrl": "https://app.asana.com/-/oauth_token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Returns all of a user's favorites in the given workspace, of the given type.\nResults are given in order (The same order as Asana's sidebar)." }, { "info": { "name": "Asana Get users in a team", "type": "http" }, "http": { "method": "GET", "url": "https://app.asana.com/api/1.0/teams/:team_gid/users", "params": [ { "name": "team_gid", "value": "159874", "type": "path", "description": "Globally unique identifier for the team." }, { "name": "opt_pretty", "value": "true", "type": "query", "description": "Provides “pretty” output.\nProvides 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." }, { "name": "offset", "value": "eyJ0eXAiOJiKV1iQLCJhbGciOiJIUzI1NiJ9", "type": "query", "description": "Offset token.\nAn 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.\n*Note: You can only pass in an offset that was returned to you via a previously paginated request.*" }, { "name": "opt_fields", "value": "email,name,photo,photo.image_1024x1024,photo.image_128x128,photo.image_21x21,photo.image_27x27,photo.image_36x36,photo.image_60x60,workspaces,workspaces.name", "type": "query", "description": "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." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://app.asana.com/-/oauth_authorize", "accessTokenUrl": "https://app.asana.com/-/oauth_token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Returns the compact records for all users that are members of the team.\nResults are sorted alphabetically and limited to 2000. For more results use the `/users` endpoint." }, { "info": { "name": "Asana Get users in a workspace or organization", "type": "http" }, "http": { "method": "GET", "url": "https://app.asana.com/api/1.0/workspaces/:workspace_gid/users", "params": [ { "name": "workspace_gid", "value": "12345", "type": "path", "description": "Globally unique identifier for the workspace or organization." }, { "name": "opt_pretty", "value": "true", "type": "query", "description": "Provides “pretty” output.\nProvides 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." }, { "name": "offset", "value": "eyJ0eXAiOJiKV1iQLCJhbGciOiJIUzI1NiJ9", "type": "query", "description": "Offset token.\nAn 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.\n*Note: You can only pass in an offset that was returned to you via a previously paginated request.*" }, { "name": "opt_fields", "value": "email,name,photo,photo.image_1024x1024,photo.image_128x128,photo.image_21x21,photo.image_27x27,photo.image_36x36,photo.image_60x60,workspaces,workspaces.name", "type": "query", "description": "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." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://app.asana.com/-/oauth_authorize", "accessTokenUrl": "https://app.asana.com/-/oauth_token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Returns the compact records for all users in the specified workspace or organization.\nResults are sorted alphabetically and limited to 2000. For more results use the `/users` endpoint." } ] }, { "info": { "name": "Webhooks", "type": "folder" }, "items": [ { "info": { "name": "Asana Get multiple webhooks", "type": "http" }, "http": { "method": "GET", "url": "https://app.asana.com/api/1.0/webhooks", "params": [ { "name": "opt_pretty", "value": "true", "type": "query", "description": "Provides “pretty” output.\nProvides 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." }, { "name": "limit", "value": "50", "type": "query", "description": "Results per page.\nThe number of objects to return per page. The value must be between 1 and 100." }, { "name": "offset", "value": "eyJ0eXAiOJiKV1iQLCJhbGciOiJIUzI1NiJ9", "type": "query", "description": "Offset token.\nAn 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.\n*Note: You can only pass in an offset that was returned to you via a previously paginated request.*" }, { "name": "workspace", "value": "1331", "type": "query", "description": "The workspace to query for webhooks in." }, { "name": "resource", "value": "51648", "type": "query", "description": "Only return webhooks for the given resource." }, { "name": "opt_fields", "value": "active,created_at,delivery_retry_count,failure_deletion_timestamp,filters,filters.action,filters.fields,filters.resource_subtype,last_failure_at,last_failure_content,last_success_at,next_attempt_after,offset,path,resource,resource.name,target,uri", "type": "query", "description": "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." } ] }, "docs": "Get the compact representation of all webhooks your app has registered for the authenticated user in the given workspace." }, { "info": { "name": "Asana Establish a webhook", "type": "http" }, "http": { "method": "POST", "url": "https://app.asana.com/api/1.0/webhooks", "params": [ { "name": "opt_pretty", "value": "true", "type": "query", "description": "Provides “pretty” output.\nProvides 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." }, { "name": "opt_fields", "value": "active,created_at,delivery_retry_count,failure_deletion_timestamp,filters,filters.action,filters.fields,filters.resource_subtype,last_failure_at,last_failure_content,last_success_at,next_attempt_after,resource,resource.name,target", "type": "query", "description": "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." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Establishing a webhook is a two-part process. First, a simple HTTP POST\nrequest initiates the creation similar to creating any other resource.\n\nNext, in the middle of this request comes the confirmation handshake.\nWhen a webhook is created, we will send a test POST to the target with an\n`X-Hook-Secret` header. The target must respond with a `200 OK` or `204\nNo Content` and a matching `X-Hook-Secret` header to confirm that this\nwebhook subscription is indeed expected. We strongly recommend storin" }, { "info": { "name": "Asana Get a webhook", "type": "http" }, "http": { "method": "GET", "url": "https://app.asana.com/api/1.0/webhooks/:webhook_gid", "params": [ { "name": "webhook_gid", "value": "12345", "type": "path", "description": "Globally unique identifier for the webhook." }, { "name": "opt_pretty", "value": "true", "type": "query", "description": "Provides “pretty” output.\nProvides 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." }, { "name": "opt_fields", "value": "active,created_at,delivery_retry_count,failure_deletion_timestamp,filters,filters.action,filters.fields,filters.resource_subtype,last_failure_at,last_failure_content,last_success_at,next_attempt_after,resource,resource.name,target", "type": "query", "description": "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." } ] }, "docs": "Returns the full record for the given webhook." }, { "info": { "name": "Asana Update a webhook", "type": "http" }, "http": { "method": "PUT", "url": "https://app.asana.com/api/1.0/webhooks/:webhook_gid", "params": [ { "name": "webhook_gid", "value": "12345", "type": "path", "description": "Globally unique identifier for the webhook." }, { "name": "opt_pretty", "value": "true", "type": "query", "description": "Provides “pretty” output.\nProvides 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." }, { "name": "opt_fields", "value": "active,created_at,delivery_retry_count,failure_deletion_timestamp,filters,filters.action,filters.fields,filters.resource_subtype,last_failure_at,last_failure_content,last_success_at,next_attempt_after,resource,resource.name,target", "type": "query", "description": "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." } ], "body": { "type": "json", "data": "{}" } }, "docs": "An existing webhook's filters can be updated by making a PUT request on the URL for that webhook. Note that the webhook's previous `filters` array will be completely overwritten by the `filters` sent in the PUT request." }, { "info": { "name": "Asana Delete a webhook", "type": "http" }, "http": { "method": "DELETE", "url": "https://app.asana.com/api/1.0/webhooks/:webhook_gid", "params": [ { "name": "webhook_gid", "value": "12345", "type": "path", "description": "Globally unique identifier for the webhook." }, { "name": "opt_pretty", "value": "true", "type": "query", "description": "Provides “pretty” output.\nProvides 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." } ] }, "docs": "This method *permanently* removes a webhook. Note that it may be possible to receive a request that was already in flight after deleting the webhook, but no further requests will be issued." } ] }, { "info": { "name": "Workspace Memberships", "type": "folder" }, "items": [ { "info": { "name": "Asana Get a workspace membership", "type": "http" }, "http": { "method": "GET", "url": "https://app.asana.com/api/1.0/workspace_memberships/:workspace_membership_gid", "params": [ { "name": "workspace_membership_gid", "value": "12345", "type": "path" }, { "name": "opt_pretty", "value": "true", "type": "query", "description": "Provides “pretty” output.\nProvides 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." }, { "name": "opt_fields", "value": "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", "type": "query", "description": "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." } ] }, "docs": "Returns the complete workspace record for a single workspace membership." }, { "info": { "name": "Asana Get workspace memberships for a user", "type": "http" }, "http": { "method": "GET", "url": "https://app.asana.com/api/1.0/users/:user_gid/workspace_memberships", "params": [ { "name": "user_gid", "value": "me", "type": "path", "description": "A string identifying a user. This can either be the string \"me\", an email, or the gid of a user." }, { "name": "opt_pretty", "value": "true", "type": "query", "description": "Provides “pretty” output.\nProvides 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." }, { "name": "limit", "value": "50", "type": "query", "description": "Results per page.\nThe number of objects to return per page. The value must be between 1 and 100." }, { "name": "offset", "value": "eyJ0eXAiOJiKV1iQLCJhbGciOiJIUzI1NiJ9", "type": "query", "description": "Offset token.\nAn 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.\n*Note: You can only pass in an offset that was returned to you via a previously paginated request.*" }, { "name": "opt_fields", "value": "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", "type": "query", "description": "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." } ] }, "docs": "Returns the compact workspace membership records for the user." }, { "info": { "name": "Asana Get the workspace memberships for a workspace", "type": "http" }, "http": { "method": "GET", "url": "https://app.asana.com/api/1.0/workspaces/:workspace_gid/workspace_memberships", "params": [ { "name": "workspace_gid", "value": "12345", "type": "path", "description": "Globally unique identifier for the workspace or organization." }, { "name": "user", "value": "me", "type": "query", "description": "A string identifying a user. This can either be the string \"me\", an email, or the gid of a user." }, { "name": "opt_pretty", "value": "true", "type": "query", "description": "Provides “pretty” output.\nProvides 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." }, { "name": "limit", "value": "50", "type": "query", "description": "Results per page.\nThe number of objects to return per page. The value must be between 1 and 100." }, { "name": "offset", "value": "eyJ0eXAiOJiKV1iQLCJhbGciOiJIUzI1NiJ9", "type": "query", "description": "Offset token.\nAn 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.\n*Note: You can only pass in an offset that was returned to you via a previously paginated request.*" }, { "name": "opt_fields", "value": "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", "type": "query", "description": "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." } ] }, "docs": "Returns the compact workspace membership records for the workspace." } ] }, { "info": { "name": "Workspaces", "type": "folder" }, "items": [ { "info": { "name": "Asana Get multiple workspaces", "type": "http" }, "http": { "method": "GET", "url": "https://app.asana.com/api/1.0/workspaces", "params": [ { "name": "opt_pretty", "value": "true", "type": "query", "description": "Provides “pretty” output.\nProvides 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." }, { "name": "limit", "value": "50", "type": "query", "description": "Results per page.\nThe number of objects to return per page. The value must be between 1 and 100." }, { "name": "offset", "value": "eyJ0eXAiOJiKV1iQLCJhbGciOiJIUzI1NiJ9", "type": "query", "description": "Offset token.\nAn 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.\n*Note: You can only pass in an offset that was returned to you via a previously paginated request.*" }, { "name": "opt_fields", "value": "email_domains,is_organization,name,offset,path,uri", "type": "query", "description": "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." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://app.asana.com/-/oauth_authorize", "accessTokenUrl": "https://app.asana.com/-/oauth_token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Returns the compact records for all workspaces visible to the authorized user." }, { "info": { "name": "Asana Get a workspace", "type": "http" }, "http": { "method": "GET", "url": "https://app.asana.com/api/1.0/workspaces/:workspace_gid", "params": [ { "name": "workspace_gid", "value": "12345", "type": "path", "description": "Globally unique identifier for the workspace or organization." }, { "name": "opt_pretty", "value": "true", "type": "query", "description": "Provides “pretty” output.\nProvides 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." }, { "name": "opt_fields", "value": "email_domains,is_organization,name", "type": "query", "description": "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." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://app.asana.com/-/oauth_authorize", "accessTokenUrl": "https://app.asana.com/-/oauth_token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Returns the full workspace record for a single workspace." }, { "info": { "name": "Asana Update a workspace", "type": "http" }, "http": { "method": "PUT", "url": "https://app.asana.com/api/1.0/workspaces/:workspace_gid", "params": [ { "name": "workspace_gid", "value": "12345", "type": "path", "description": "Globally unique identifier for the workspace or organization." }, { "name": "opt_pretty", "value": "true", "type": "query", "description": "Provides “pretty” output.\nProvides 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." }, { "name": "opt_fields", "value": "email_domains,is_organization,name", "type": "query", "description": "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." } ], "body": { "type": "json", "data": "{}" } }, "docs": "A specific, existing workspace can be updated by making a PUT request on the URL for that workspace. Only the fields provided in the data block will be updated; any unspecified fields will remain unchanged.\nCurrently the only field that can be modified for a workspace is its name.\nReturns the complete, updated workspace record." }, { "info": { "name": "Asana Add a user to a workspace or organization", "type": "http" }, "http": { "method": "POST", "url": "https://app.asana.com/api/1.0/workspaces/:workspace_gid/addUser", "params": [ { "name": "workspace_gid", "value": "12345", "type": "path", "description": "Globally unique identifier for the workspace or organization." }, { "name": "opt_pretty", "value": "true", "type": "query", "description": "Provides “pretty” output.\nProvides 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." }, { "name": "opt_fields", "value": "email,name,photo,photo.image_1024x1024,photo.image_128x128,photo.image_21x21,photo.image_27x27,photo.image_36x36,photo.image_60x60", "type": "query", "description": "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." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Add a user to a workspace or organization.\nThe user can be referenced by their globally unique user ID or their email address. Returns the full user record for the invited user." }, { "info": { "name": "Asana Remove a user from a workspace or organization", "type": "http" }, "http": { "method": "POST", "url": "https://app.asana.com/api/1.0/workspaces/:workspace_gid/removeUser", "params": [ { "name": "workspace_gid", "value": "12345", "type": "path", "description": "Globally unique identifier for the workspace or organization." }, { "name": "opt_pretty", "value": "true", "type": "query", "description": "Provides “pretty” output.\nProvides 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." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Remove a user from a workspace or organization.\nThe user making this call must be an admin in the workspace. The user can be referenced by their globally unique user ID or their email address.\nReturns an empty data record." } ] } ], "bundled": true }