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 fieldsgetCustom typesGet all custom types associated with an objectgetEventsGet 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 organizationpostGet workspace eventsgetWorkspace 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 widget metadataget https://{siteUrl}/widget_metadata_url_path_placeholderNote: The path is a placeholder. The actual path is determined by the configuration of the app component. Get the metadata from the app server to render a widget. Query Paramsresource_urlstringrequiredThe URL of the URL attachment on the task (i.e., Jira issue, GitHub pull request)workspacestringrequiredThe workspace GID this hook is coming from.taskstringrequiredThe task GID this hook is coming from.userstringrequiredThe user GID this hook is coming from.attachmentstringrequiredThe attachment ID of the URL attachment.expires_atstringrequiredThe time (in ISO 8601 date format) when the request should expire.Responses 200Successfully retrieved the metadata for a single widget.Response bodyobjecttemplatestringrequiredThe interface name and version of a distinct widget UI layout. A template is directly associated with a particular metadata schema. summary_with_details_v0metadataobjectrequiredThe metadata (i.e., underlying definition) of a widget. metadata must exist alongside a template, and its schema must be specific to the value of that template.titlestringrequiredThe text to show in the title of the widget. Max length of 200 characters.fieldsarrayrequiredA list of fields showing data from external resources (i.e., an array of WidgetField objects). A widget must contain at least 1 field and no more than 5 fields. Valid object schemas: WidgetField-DatetimeWithIcon, WidgetField-Pill, WidgetField-TextWithIcon.fields*subtitlestringThe text to show under the title of the widget, next to "Open in {App Name}". If not provided, the resource_name from the app definition will be used as default.subicon_urlstringThe URL of the subicon next to the subtitle . If not provided, no icon will be shown.footerobjectrequiredContains the information to display a footer on the widget. Valid schemas: WidgetFooter-Created, WidgetFooter-CustomText, WidgetFooter-Updated.Has additional fieldsnum_commentsintegerThe number of comments to display on the lower right corner of the widget. If not provided, no comment count will be shown 400Bad requestResponse bodyobjectdataobjectAn object containing an error string to display to the user.errorstringThe error to display. 401UnauthorizedResponse bodyobjectdataobjectAn object containing an error string to display to the user.errorstringThe error to display. 403ForbiddenResponse bodyobjectdataobjectAn object containing an error string to display to the user.errorstringThe error to display. 404Not foundResponse bodyobjectdataobjectAn object containing an error string to display to the user.errorstringThe error to display. 418UnauthorizedResponse bodyobjectdataobjectAn object containing an error string to display to the user.errorstringThe error to display. 500Server errorResponse bodyobjectdataobjectAn object containing an error string to display to the user.errorstringThe error to display.Updated about 2 years ago WidgetsDid this page help you?YesNo