Skip to main content
Server path: /asana-utilities | Type: Application | PCID required: Yes

Tools

ToolDescription
asana_utilities_approve_access_requestApprove an access request
asana_utilities_create_access_requestCreate an access request
asana_utilities_create_attachment_for_objectUpload an attachment
asana_utilities_create_batch_requestSubmit parallel requests
asana_utilities_create_graph_exportInitiate a graph export
asana_utilities_create_organization_exportCreate an organization export request
asana_utilities_create_resource_exportInitiate a resource export
asana_utilities_create_status_for_objectCreate a status update
asana_utilities_create_timesheet_approval_statusCreate a timesheet approval status
asana_utilities_create_webhookEstablish a webhook
asana_utilities_delete_attachmentDelete an attachment
asana_utilities_delete_statusDelete a status update
asana_utilities_delete_webhookDelete a webhook
asana_utilities_get_access_requestsGet access requests
asana_utilities_get_attachmentGet an attachment
asana_utilities_get_attachments_for_objectGet attachments from an object
asana_utilities_get_audit_log_eventsGet audit log events
asana_utilities_get_eventsGet events on a resource
asana_utilities_get_jobGet a job by id
asana_utilities_get_organization_exportGet details on an org export request
asana_utilities_get_statusGet a status update
asana_utilities_get_statuses_for_objectGet status updates from an object
asana_utilities_get_time_periodGet a time period
asana_utilities_get_time_periodsGet time periods
asana_utilities_get_timesheet_approval_statusGet a timesheet approval status
asana_utilities_get_timesheet_approval_statusesGet multiple timesheet approval statuses
asana_utilities_get_webhookGet a webhook
asana_utilities_get_webhooksGet multiple webhooks
asana_utilities_reject_access_requestReject an access request
asana_utilities_trigger_ruleTrigger a rule
asana_utilities_update_timesheet_approval_statusUpdate a timesheet approval status
asana_utilities_update_webhookUpdate a webhook

asana_utilities_approve_access_request

Approve an access request Parameters:
ParameterTypeRequiredDefaultDescription
access_request_gidstringYesGlobally unique identifier for the access request.

asana_utilities_create_access_request

Create an access request Parameters:
ParameterTypeRequiredDefaultDescription
dataobjectNoA request to create shareable access for a user.

asana_utilities_create_attachment_for_object

Upload an attachment Parameters:
ParameterTypeRequiredDefaultDescription
opt_prettybooleanNoProvides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging.
opt_fieldsstring[]NoThis endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include.
connect_to_appbooleanNoOptional. Only relevant for external attachments with a parent task. A boolean indicating whether the current app should be connected with the attachment for the purposes of showing an app components widget. Requires the app to have been added to a project the parent task is in. This property can only be set if an OAuth token is used to authenticate the request. Criteria for displaying app widget: 1. An OAuth token must be used to authenticate the request 2. The app needs to have its widget_metadata_url configured in the developer console 3. The task the attachment is being attached to must be in a project with the app installed
filestringNoRequired for asana attachments.
namestringNoThe name of the external resource being attached. Required for attachments of type external.
parentstringYesRequired identifier of the parent task, project, or project_brief, as a string.
resource_subtypestringNoThe type of the attachment. Must be one of the given values. If not specified, a file attachment of type asana will be assumed. Note that if the value of resource_subtype is external, a parent, name, and url must also be provided.
urlstringNoThe URL of the external resource being attached. Required for attachments of type external.

asana_utilities_create_batch_request

Submit parallel requests Parameters:
ParameterTypeRequiredDefaultDescription
opt_prettybooleanNoProvides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging.
opt_fieldsstring[]NoThis endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include.
dataobjectNoA request object for use in a batch request.

asana_utilities_create_graph_export

Initiate a graph export Parameters:
ParameterTypeRequiredDefaultDescription
dataobjectNoA graph_export request starts a job to export data starting from a parent object.

asana_utilities_create_organization_export

Create an organization export request Parameters:
ParameterTypeRequiredDefaultDescription
opt_prettybooleanNoProvides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging.
opt_fieldsstring[]NoThis endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include.
dataobjectNoAn organization_export request starts a job to export the complete data of the given Organization.

asana_utilities_create_resource_export

Initiate a resource export Parameters:
ParameterTypeRequiredDefaultDescription
dataobjectNoA resource_export request starts a job to bulk export objects for one or more resources.

asana_utilities_create_status_for_object

Create a status update Parameters:
ParameterTypeRequiredDefaultDescription
opt_prettybooleanNoProvides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging.
limitintegerNoResults per page. The number of objects to return per page. The value must be between 1 and 100.
offsetstringNoOffset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. Note: You can only pass in an offset that was returned to you via a previously paginated request.
opt_fieldsstring[]NoThis endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include.
dataobjectNoThe data value

asana_utilities_create_timesheet_approval_status

Create a timesheet approval status Parameters:
ParameterTypeRequiredDefaultDescription
opt_prettybooleanNoProvides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging.
opt_fieldsstring[]NoThis endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include.
dataobjectNoA request to create a timesheet approval status.

asana_utilities_create_webhook

Establish a webhook Parameters:
ParameterTypeRequiredDefaultDescription
opt_prettybooleanNoProvides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging.
opt_fieldsstring[]NoThis endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include.
dataobjectNoThe data value

asana_utilities_delete_attachment

Delete an attachment Parameters:
ParameterTypeRequiredDefaultDescription
attachment_gidstringYesGlobally unique identifier for the attachment.
opt_prettybooleanNoProvides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging.

asana_utilities_delete_status

Delete a status update Parameters:
ParameterTypeRequiredDefaultDescription
status_update_gidstringYesThe status update to get.
opt_prettybooleanNoProvides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging.

asana_utilities_delete_webhook

Delete a webhook Parameters:
ParameterTypeRequiredDefaultDescription
webhook_gidstringYesGlobally unique identifier for the webhook.
opt_prettybooleanNoProvides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging.

asana_utilities_get_access_requests

Get access requests Parameters:
ParameterTypeRequiredDefaultDescription
targetstringYesGlobally unique identifier for the target object.
userstringNoA string identifying a user. This can either be the string “me”, an email, or the gid of a user.
opt_prettybooleanNoProvides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging.
opt_fieldsstring[]NoThis endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include.

asana_utilities_get_attachment

Get an attachment Parameters:
ParameterTypeRequiredDefaultDescription
attachment_gidstringYesGlobally unique identifier for the attachment.
opt_prettybooleanNoProvides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging.
opt_fieldsstring[]NoThis endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include.

asana_utilities_get_attachments_for_object

Get attachments from an object Parameters:
ParameterTypeRequiredDefaultDescription
opt_prettybooleanNoProvides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging.
limitintegerNoResults per page. The number of objects to return per page. The value must be between 1 and 100.
offsetstringNoOffset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. Note: You can only pass in an offset that was returned to you via a previously paginated request.
parentstringYesGlobally unique identifier for object to fetch statuses from. Must be a GID for a project, project_brief, or task.
opt_fieldsstring[]NoThis endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include.

asana_utilities_get_audit_log_events

Get audit log events Parameters:
ParameterTypeRequiredDefaultDescription
workspace_gidstringYesGlobally unique identifier for the workspace or organization.
start_atstringNoFilter to events created after this time (inclusive).
end_atstringNoFilter to events created before this time (exclusive).
event_typestringNoFilter to events of this type. Refer to the supported audit log events for a full list of values.
actor_typestringNoFilter to events with an actor of this type. This only needs to be included if querying for actor types without an ID. If actor_gid is included, this should be excluded.
actor_gidstringNoFilter to events triggered by the actor with this ID.
resource_gidstringNoFilter to events with this resource ID.
limitintegerNoResults per page. The number of objects to return per page. The value must be between 1 and 100.
offsetstringNoOffset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. Note: You can only pass in an offset that was returned to you via a previously paginated request.

asana_utilities_get_events

Get events on a resource Parameters:
ParameterTypeRequiredDefaultDescription
resourcestringYesA resource ID to subscribe to. The resource can be a task, project, or goal.
syncstringNoA sync token received from the last request, or none on first sync. Events will be returned from the point in time that the sync token was generated. Note: On your first request, omit the sync token. The response will be the same as for an expired sync token, and will include a new valid sync token.If the sync token is too old (which may happen from time to time) the API will return a 412 Precondition Failed error, and include a fresh sync token in the response.
opt_prettybooleanNoProvides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging.
opt_fieldsstring[]NoThis endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include.

asana_utilities_get_job

Get a job by id Parameters:
ParameterTypeRequiredDefaultDescription
job_gidstringYesGlobally unique identifier for the job.
opt_prettybooleanNoProvides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging.
opt_fieldsstring[]NoThis endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include.

asana_utilities_get_organization_export

Get details on an org export request Parameters:
ParameterTypeRequiredDefaultDescription
organization_export_gidstringYesGlobally unique identifier for the organization export.
opt_prettybooleanNoProvides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging.
opt_fieldsstring[]NoThis endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include.

asana_utilities_get_status

Get a status update Parameters:
ParameterTypeRequiredDefaultDescription
status_update_gidstringYesThe status update to get.
opt_prettybooleanNoProvides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging.
opt_fieldsstring[]NoThis endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include.

asana_utilities_get_statuses_for_object

Get status updates from an object Parameters:
ParameterTypeRequiredDefaultDescription
opt_prettybooleanNoProvides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging.
limitintegerNoResults per page. The number of objects to return per page. The value must be between 1 and 100.
offsetstringNoOffset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. Note: You can only pass in an offset that was returned to you via a previously paginated request.
parentstringYesGlobally unique identifier for object to fetch statuses from. Must be a GID for a project, portfolio, or goal.
created_sincestringNoOnly return statuses that have been created since the given time.
opt_fieldsstring[]NoThis endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include.

asana_utilities_get_time_period

Get a time period Parameters:
ParameterTypeRequiredDefaultDescription
time_period_gidstringYesGlobally unique identifier for the time period.
opt_prettybooleanNoProvides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging.
opt_fieldsstring[]NoThis endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include.

asana_utilities_get_time_periods

Get time periods Parameters:
ParameterTypeRequiredDefaultDescription
opt_prettybooleanNoProvides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging.
limitintegerNoResults per page. The number of objects to return per page. The value must be between 1 and 100.
offsetstringNoOffset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. Note: You can only pass in an offset that was returned to you via a previously paginated request.
start_onstringNoISO 8601 date string
end_onstringNoISO 8601 date string
workspacestringYesGlobally unique identifier for the workspace.
opt_fieldsstring[]NoThis endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include.

asana_utilities_get_timesheet_approval_status

Get a timesheet approval status Parameters:
ParameterTypeRequiredDefaultDescription
timesheet_approval_status_gidstringYesGlobally unique identifier for the timesheet approval status.
opt_prettybooleanNoProvides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging.
opt_fieldsstring[]NoThis endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include.

asana_utilities_get_timesheet_approval_statuses

Get multiple timesheet approval statuses Parameters:
ParameterTypeRequiredDefaultDescription
opt_prettybooleanNoProvides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging.
workspacestringYesGlobally unique identifier for the workspace.
userstringNoGlobally unique identifier for the user to filter timesheet approval statuses by.
from_datestringNoThe start date for filtering timesheet approval statuses.
to_datestringNoThe end date for filtering timesheet approval statuses.
approval_statusesstringNoFilter by approval status. Can be one or more of draft, submitted, approved, or rejected.
limitintegerNoResults per page. The number of objects to return per page. The value must be between 1 and 100.
offsetstringNoOffset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. Note: You can only pass in an offset that was returned to you via a previously paginated request.
opt_fieldsstring[]NoThis endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include.

asana_utilities_get_webhook

Get a webhook Parameters:
ParameterTypeRequiredDefaultDescription
webhook_gidstringYesGlobally unique identifier for the webhook.
opt_prettybooleanNoProvides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging.
opt_fieldsstring[]NoThis endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include.

asana_utilities_get_webhooks

Get multiple webhooks Parameters:
ParameterTypeRequiredDefaultDescription
opt_prettybooleanNoProvides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging.
limitintegerNoResults per page. The number of objects to return per page. The value must be between 1 and 100.
offsetstringNoOffset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. Note: You can only pass in an offset that was returned to you via a previously paginated request.
workspacestringYesThe workspace to query for webhooks in.
resourcestringNoOnly return webhooks for the given resource.
opt_fieldsstring[]NoThis endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include.

asana_utilities_reject_access_request

Reject an access request Parameters:
ParameterTypeRequiredDefaultDescription
access_request_gidstringYesGlobally unique identifier for the access request.

asana_utilities_trigger_rule

Trigger a rule Parameters:
ParameterTypeRequiredDefaultDescription
rule_trigger_gidstringYesThe ID of the incoming web request trigger. This value is a path parameter that is automatically generated for the API endpoint.
dataobjectNoThe data value

asana_utilities_update_timesheet_approval_status

Update a timesheet approval status Parameters:
ParameterTypeRequiredDefaultDescription
timesheet_approval_status_gidstringYesGlobally unique identifier for the timesheet approval status.
opt_prettybooleanNoProvides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging.
opt_fieldsstring[]NoThis endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include.
dataobjectNoA request to update a timesheet approval status.

asana_utilities_update_webhook

Update a webhook Parameters:
ParameterTypeRequiredDefaultDescription
webhook_gidstringYesGlobally unique identifier for the webhook.
opt_prettybooleanNoProvides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging.
opt_fieldsstring[]NoThis endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include.
dataobjectNoThe data value