JUMP TOCTRL-/AsanaOverviewAllocationsGet an allocationgetUpdate an allocationputDelete an allocationdeleteGet multiple allocationsgetCreate an allocationpostAttachmentsGet an attachmentgetDelete an attachmentdeleteGet attachments from an objectgetUpload an attachmentpostAudit log APIGet audit log eventsgetBatch APISubmit parallel requestspostCustom fieldsCreate a custom fieldpostGet a custom fieldgetUpdate a custom fieldputDelete a custom fielddeleteGet a workspace's custom fieldsgetCreate an enum optionpostReorder a custom field's enumpostUpdate an enum optionputCustom field settingsGet a project's custom fieldsgetGet a portfolio's custom fieldsgetEventsGet events on a resourcegetGoalsGet a goalgetUpdate a goalputDelete a goaldeleteGet goalsgetCreate a goalpostCreate a goal metricpostUpdate a goal metricpostAdd a collaborator to a goalpostRemove a collaborator from a goalpostGet parent goals from a goalgetGoal relationshipsGet a goal relationshipgetUpdate a goal relationshipputGet goal relationshipsgetAdd a supporting goal relationshippostRemoves a supporting goal relationshippostJobsGet a job by idgetMembershipsGet multiple membershipsgetCreate a membershippostGet a membershipgetUpdate a membershipputDelete a membershipdeleteOrganization exportsCreate an organization export requestpostGet details on an org export requestgetPortfoliosGet multiple portfoliosgetCreate a portfoliopostGet a portfoliogetUpdate a portfolioputDelete a portfoliodeleteGet portfolio itemsgetAdd a portfolio itempostRemove a portfolio itempostAdd a custom field to a portfoliopostRemove a custom field from a portfoliopostAdd users to a portfoliopostRemove users from a portfoliopostPortfolio membershipsGet multiple portfolio membershipsgetGet a portfolio membershipgetGet memberships from a portfoliogetProjectsGet multiple projectsgetCreate a projectpostGet a projectgetUpdate a projectputDelete a projectdeleteDuplicate a projectpostGet projects a task is ingetGet a team's projectsgetCreate a project in a teampostGet all projects in a workspacegetCreate a project in a workspacepostAdd a custom field to a projectpostRemove a custom field from a projectpostGet task count of a projectgetAdd users to a projectpostRemove users from a projectpostAdd followers to a projectpostRemove followers from a projectpostCreate a project template from a projectpostProject briefsGet a project briefgetUpdate a project briefputDelete a project briefdeleteCreate a project briefpostProject membershipsGet a project membershipgetGet memberships from a projectgetProject statusesGet a project statusgetDelete a project statusdeleteGet statuses from a projectgetCreate a project statuspostProject templatesGet a project templategetDelete a project templatedeleteGet multiple project templatesgetGet a team's project templatesgetInstantiate a project from a project templatepostRulesTrigger a rulepostSectionsGet a sectiongetUpdate a sectionputDelete a sectiondeleteGet sections in a projectgetCreate a section in a projectpostAdd task to sectionpostMove or Insert sectionspostStatus updatesGet a status updategetDelete a status updatedeleteGet status updates from an objectgetCreate a status updatepostStoriesGet a storygetUpdate a storyputDelete a storydeleteGet stories from a taskgetCreate a story on a taskpostTagsGet multiple tagsgetCreate a tagpostGet a taggetUpdate a tagputDelete a tagdeleteGet a task's tagsgetGet tags in a workspacegetCreate a tag in a workspacepostTasksGet multiple tasksgetCreate a taskpostGet a taskgetUpdate a taskputDelete a taskdeleteDuplicate a taskpostGet tasks from a projectgetGet tasks from a sectiongetGet tasks from a taggetGet tasks from a user task listgetGet subtasks from a taskgetCreate a subtaskpostSet the parent of a taskpostGet dependencies from a taskgetSet dependencies for a taskpostUnlink dependencies from a taskpostGet dependents from a taskgetSet dependents for a taskpostUnlink dependents from a taskpostAdd a project to a taskpostRemove a project from a taskpostAdd a tag to a taskpostRemove a tag from a taskpostAdd followers to a taskpostRemove followers from a taskpostGet a task for a given custom IDgetSearch tasks in a workspacegetTask templatesGet multiple task templatesgetGet a task templategetDelete a task templatedeleteInstantiate a task from a task templatepostTeamsCreate a teampostGet a teamgetUpdate a teamputGet teams in a workspacegetGet teams for a usergetAdd a user to a teampostRemove a user from a teampostTeam membershipsGet a team membershipgetGet team membershipsgetGet memberships from a teamgetGet memberships from a usergetTime periodsGet a time periodgetGet time periodsgetTime tracking entriesGet time tracking entries for a taskgetCreate a time tracking entrypostGet a time tracking entrygetUpdate a time tracking entryputDelete a time tracking entrydeleteTypeaheadGet objects via typeaheadgetUsersGet multiple usersgetGet a usergetGet a user's favoritesgetGet users in a teamgetGet users in a workspace or organizationgetUser task listsGet a user task listgetGet a user's task listgetWebhooksGet multiple webhooksgetEstablish a webhookpostGet a webhookgetUpdate a webhookputDelete a webhookdeleteWorkspacesGet multiple workspacesgetGet a workspacegetUpdate a workspaceputAdd a user to a workspace or organizationpostRemove a user from a workspace or organizationpostWorkspace membershipsGet a workspace membershipgetGet workspace memberships for a usergetGet the workspace memberships for a workspacegetApp ComponentsOverviewModal formsGet form metadatagetGet modal form typeahead resultsgetOn change callbackpostOn submit callbackpostRule actionsGet rule action typeahead resultsgetRun actionpostGet action metadatagetOn action change callbackpostOn action submit callbackpostLookupsAttach resourcepostGet lookup typeahead resultsgetWidgetsGet widget metadatagetGet multiple tagsget https://app.asana.com/api/1.0/tagsReturns the compact tag records for some filtered set of tags. Use one or more of the parameters provided to filter the tags returned.📘Customizing the responseRequests to this endpoint return "compact" tag objects (schema) by default. To include more fields in the response, see input/output options.Query Paramslimitinteger1 to 100Results per page. The number of objects to return per page. The value must be between 1 and 100.offsetstringOffset 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.workspacestringThe workspace to filter tags on.opt_fieldsarray of stringsThis endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include.opt_fieldsADD stringopt_prettybooleanProvides “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.truefalseResponses 200Successfully retrieved the specified set of tags.Response bodyobjectdataarray of objectsdataobjectgidstringGlobally unique identifier of the resource, as a string.resource_typestringThe base type of this resource.namestringName of the tag. This is generally a short sentence fragment that fits on a line in the UI for maximum readability. However, it can be longer.next_pageobject | nullConditional. This property is only present when a limit query parameter is provided in the request. When making a paginated request, the API will return a number of results as specified by the limit parameter. If more results exist, then the response will contain a next_page attribute, which will include an offset, a relative path attribute, and a full uri attribute. If there are no more pages available, next_page will be null and no offset will be provided. Note that an offset token will expire after some time, as data may have changed.offsetstringPagination offset for the request.pathstringA relative path containing the query parameters to fetch for next_pageuriuriA full uri containing the query parameters to fetch for next_page 400This usually occurs because of a missing or malformed parameter. Check the documentation and the syntax of your request and try again.Response bodyobjecterrorsarray of objectserrorsobjectmessagestringMessage providing more detail about the error that occurred, if available.helpstringAdditional information directing developers to resources on how to address and fix the problem, if available.phrasestring500 errors only. A unique error phrase which can be used when contacting developer support to help identify the exact occurrence of the problem in Asana’s logs. 401A valid authentication token was not provided with the request, so the API could not associate a user with the request.Response bodyobjecterrorsarray of objectserrorsobjectmessagestringMessage providing more detail about the error that occurred, if available.helpstringAdditional information directing developers to resources on how to address and fix the problem, if available.phrasestring500 errors only. A unique error phrase which can be used when contacting developer support to help identify the exact occurrence of the problem in Asana’s logs. 403The authentication and request syntax was valid but the server is refusing to complete the request. This can happen if you try to read or write to objects or properties that the user does not have access to.Response bodyobjecterrorsarray of objectserrorsobjectmessagestringMessage providing more detail about the error that occurred, if available.helpstringAdditional information directing developers to resources on how to address and fix the problem, if available.phrasestring500 errors only. A unique error phrase which can be used when contacting developer support to help identify the exact occurrence of the problem in Asana’s logs. 404Either the request method and path supplied do not specify a known action in the API, or the object specified by the request does not exist.Response bodyobjecterrorsarray of objectserrorsobjectmessagestringMessage providing more detail about the error that occurred, if available.helpstringAdditional information directing developers to resources on how to address and fix the problem, if available.phrasestring500 errors only. A unique error phrase which can be used when contacting developer support to help identify the exact occurrence of the problem in Asana’s logs. 500There was a problem on Asana’s end. In the event of a server error the response body should contain an error phrase. These phrases can be used by Asana support to quickly look up the incident that caused the server error. Some errors are due to server load, and will not supply an error phrase.Response bodyobjecterrorsarray of objectserrorsobjectmessagestringMessage providing more detail about the error that occurred, if available.helpstringAdditional information directing developers to resources on how to address and fix the problem, if available.phrasestring500 errors only. A unique error phrase which can be used when contacting developer support to help identify the exact occurrence of the problem in Asana’s logs.Updated about 1 year ago TagsCreate a tagDid this page help you?YesNo