Skip to content

Support Developer Forum Login

Theme

Overview

Introduction Getting Started Integration Example (PSA)Authentication Error Handling Pagination Filtering Ordering Rate Limits Permissions Webhooks MCP Server Versioning Changelog Support API Reference

Custom Agents⌄

GETReturns all custom agents.POSTCreates a new custom agent.GETReturns connection configuration for the current user's custom agents.GETReturns the custom agent's configuration.PUTUpdates the custom agent's configuration.GETReturns a custom agent's connection configuration for the current user.POSTLinks a connector to an agent.DELETEUnlinks a connector from an agent.POSTCopies an existing custom agent.POSTArchives or unarchives an agent.GETLists agent skills.POSTCreates a private skill for an agent.DELETERemoves a skill from an agent.POSTLinks a skill to an agent.GETLists the agent's saved system prompt versions.POSTRestores a previous system prompt version.

Agent Files⌄

GETReturns all files of the specified agent.DELETEDeletes all files and versions for the specified agent.PUTUpdates metadata for the specified file.DELETEDeletes the specified agent file and its versions.POSTChanges file ownership within the same workspace after checking workspace file management access.POSTUploads a new version of the specified agent file.

Agent Skills⌄

GETLists skills the caller can access.POSTCreates a reusable skill.POSTImports a skill package.GETLists skill secret statuses.PUTSets a skill secret value.DELETEDeletes a skill secret value.GETReturns a skill.PUTUpdates a skill.DELETEDeletes a skill.POSTCreates an independent user-owned copy of a readable skill and its supporting content.GETExports a skill package.GETLists skill files.POSTUploads a skill file.DELETEDeletes a skill file.POSTStores an uploaded file as a bundled skill file.GETDownloads a skill file.GETLists skill secret requirements.PUTUpdates skill secret requirements.POSTChanges only the item's official status after rollout and item authorization.GETReturns a skill's sharing configuration.PUTUpdates a skill's sharing configuration.PUTChanges only the item's tags after rollout and item authorization.

Agent Schedules⌄

GETLists project schedules.GETLists owned schedules.GETCounts schedules that will lose context when readable tasks are deleted.GETLists agent schedules.POSTCreates an agent schedule.POSTPreviews a schedule occurrence.PUTUpdates an agent schedule.DELETEDeletes an agent schedule.POSTRuns an agent schedule.POSTChanges schedule state.

Agent Threads⌄

GETLists the current user's approved computers and folders.POSTCreates a single-use pairing token. Only the user may connect a Mac, not an agent.DELETERevokes one of the current user's computers. Only the user may do this, not an agent.GETReturns thread metadata for usage analytics.POSTCreates a conversation with the awork Agent or a custom agent.GETGets an agent thread.GETDownloads an agent thread artifact.POSTCancels the active run for the specified agent thread.GETLists the folders enabled for this private conversation.PUTEnables selected folders until the user changes the selection. Only the user may change it, not an agent.GETLists agent thread messages.POSTSubmits a message to an agent conversation.GETGets agent thread message status.POSTExchanges a single-use pairing token for a device credential. awork Local sends the token in a header, never in the URL.

Agent Thread Files⌄

GETReturns a file of the specified agent thread.GETReturns content from a file attached to the specified agent thread.

Agent Runtime⌄

GETLists the connectors visible to the requesting user in the current workspace.GETLists the predefined connector presets available to the workspace.POSTChanges only the item's official status after rollout and item authorization.PUTMakes a custom connector workspace-visible or private.PUTChanges only the item's tags after rollout and item authorization.GETGets the default agent options for a personal or custom agent.GETReturns the AI models available to agents.POSTDisables a model, vendor, or region and updates settings that use it.PUTSets a workspace preset to Auto or a selected active text model.POSTEnables an AI model region for the workspace.POSTEnables one AI model vendor for the workspace.POSTEnables one AI model for the workspace.GETReturns every AI tag in the workspace with the number of active agents, skills, and connectors that use it.PUTEdits a shared definition with contribution permission.DELETEDeletes a shared definition and removes all of its item assignments.POSTMoves every source assignment to the target, removes duplicate links, and deletes the source.POSTChanges only the item's official status after rollout and item authorization.PUTChanges only the item's tags after rollout and item authorization.

Projects⌄

GETReturns projects visible to the current user.POSTCreates a project.POSTApplies an operation to selected projects.GETReturns the project with the specified key.GETReturns the specified project.PUTUpdates the specified project.POSTChanges the specified project's type.POSTChanges the specified project's status.POSTDeletes the specified project.GETReturns members of the specified project.POSTRemoves a member from the specified project.POSTUpdates the specified project's key.POSTUpdates a project's status order.

Project Types⌄

GETReturns existing project types.POSTCreates a new project type.GETReturns available project type icons.GETReturns a project type by its ID.PUTUpdates project type.POSTDeletes project types.POSTArchives or unarchives the project type.

Project Statuses⌄

GETReturns statuses for the specified project.POSTCreates a status for the specified project.GETReturns project statuses in the workspace.GETReturns the specified project status.PUTUpdates the specified project status.POSTDeletes the specified project status.POSTSets the archived flag for a project status.

Project Roles⌄

GETReturns project roles in the workspace.POSTCreates a project role.GETReturns roles assigned to the specified user.GETReturns the specified project role.PUTUpdates the specified project role.POSTDeletes a project role and migrates members.GETReturns permissions for the specified project role.POSTUpdates a permission for a project role.

Project Members⌄

POSTAdds a member to the specified project.POSTUpdates a member of the specified project.

Project Comments⌄

GETReturns all comments of the project with the specified id.POSTCreates a new comment on the project with the specified id.DELETEDeletes all comments of the specified project.GETReturns the comment with the specified id of the project with the specified id.PUTUpdates the comment with the specified id on the project with the specified id.DELETEDeletes the comment with the specified id on the project with the specified id.POSTUpdates the reactions of the comment with the specified id on the project with the specified id.

Project Tags⌄

POSTRemoves a tag from all projects.GETReturns tags used by projects.POSTUpdates a tag for all projects.POSTAdds tags to the specified project.POSTRemoves tags from the specified project.GETReturns tags for the specified project.

Project Milestones⌄

GETReturns visible project milestones.POSTCreates a project milestone.GETReturns the specified project milestone.PUTUpdates the specified project milestone.DELETEDeletes the specified project milestone.GETReturns milestones for the specified project.

Project Activities⌄

GETReturns all activities of the project with the specified id.

Project Automations⌄

GETReturns all supported automation trigger and action types.GETReturns all automations of the specified project.POSTCreates a new automation for the specified project.GETReturns a specific automation from a project.PUTUpdates the automation with the specified id.DELETEDeletes the specified automation for a given project.GETGets the actions of a project automation.POSTCreates a new action for an automation.GETGets a specific action for a project automation.PUTUpdates a specifc action of a project automation.DELETEDeletes an action for a project automation.POSTUpdates the order of a given action of a project automation.POSTExecutes a manual automation for a task.

Time Bookings⌄

GETReturns a list of time bookings.POSTCreates a time booking for a project and user.PUTUpdates a given time booking.DELETEDeletes a time booking by id.GETReturns a list of time bookings.POSTCreates a time booking for a project and user.PUTUpdates a given time booking.DELETEDeletes a time booking by id.GETReturns time bookings for users.GETReturns time bookings for users.

Retainers⌄

GETReturns retainers for the specified project.POSTCreates a retainer for the specified project.GETReturns the specified project retainer.PUTUpdates the specified project retainer.DELETEDeletes a retainer from the specified project.

Autopilot⌄

GETReturns all available alerts for autopilots.GETReturns the autopilot with the specified id.GETReturns the autopilot of the project with the specified id.POSTCreates a new autopilot for the project with the specified id.PUTUpdates the autopilot of the project with the specified id.DELETEDeletes the autopilot of the project with the specified id.

Tasks⌄

POSTCreates a project or private task.POSTInvites a user by email and assigns them to a task.POSTReturns copy relationships for at most 1,000 submitted task IDs.POSTUpdates multiple tasks with the selected operation.POSTUpdates the base type for multiple tasks.POSTUpdates the task lists of tasks.POSTUpdates the statuses of tasks.POSTUpdates task hierarchy and subtask order.POSTConverts subtasks to a parent task.POSTUpdates the type of work for multiple tasks.POSTDeletes tasks and optionally related time entries.GETReturns the task for the key.POSTSets the priority flag for a task.GETReturns the specified task.PUTUpdates the task.POSTCreates a copy of the specified task.POSTDeletes the recurrence rule for a task.GETReturns the recurrence rule of a task.POSTAssigns a list of users to a task.POSTModifies planned efforts for the task assignments.POSTAdds or updates a recurrence rule for a task.POSTUpdates the order of a task within its list.

Task Statuses⌄

GETReturns task statuses for the specified project.POSTCreates a task status for the specified project.GETReturns the specified project task status.PUTUpdates a task status for the specified project.POSTDeletes the specified project task status.

Task Lists⌄

GETReturns task lists for the specified project.POSTCreates a task list in the specified project.GETReturns the specified task list.PUTUpdates the specified task list.POSTAdds tasks to the specified task list.POSTMoves a task list to another project.POSTCopies the specified task list.POSTDeletes the specified task list.POSTRemoves tasks from the specified task list.POSTArchives or restores the specified task list.GETReturns a task in the specified task list.POSTUpdates a task's order in a task list.POSTUpdates the order of the specified task list.

Project Tasks⌄

GETReturns project tasks for the current user.GETReturns tags for project tasks.GETReturns tasks for the specified project.GETReturns the specified project task.POSTMoves a task to another project.GETReturns types of work from the project workspace for the specified project.

Private Tasks⌄

GETReturns reassigned private tasks.GETReturns a reassigned private task.GETReturns private tasks for the current user.GETReturns the task statuses for private tasks for the specified user.GETReturns a private task for the current user.GETReturns private tasks reassigned by the user.GETReturns a private task reassigned by the user.GETReturns private tasks of the user.GETReturns the task statuses for private tasks for the specified user.GETReturns the private task of a user.

Assigned Tasks⌄

GETReturns tasks visible to the current user.GETReturns tasks assigned to the current user.GETReturns an assigned task for the current user.GETReturns tags for tasks visible to the user.GETReturns tasks the specified user is allowed to see.GETReturns tasks assigned to the specified user.GETReturns the assigned task of a specified user.GETReturns task tags the user is allowed to see.

Checklist Items⌄

GETReturns the checklist items for a private task.GETReturns a checklist item for a private task.GETReturns the checklist for a private task.GETReturns a checklist item from a private task.GETReturns checklist items for a project task.GETReturns a checklist item for a project task.GETReturns the checklist items for the task.POSTCreates a checklist item for a task.POSTConverts checklist items of the task to subtasks.GETReturns the checklist item for a task.PUTUpdates a checklist item for a task.DELETEDeletes a checklist item from a task.GETReturns the checklist items for a private task.GETReturns a checklist item for a private task.GETReturns the checklist for a private task.GETReturns a checklist item from a private task.

Task Comments⌄

GETReturns all comments of the task with the specified id.POSTCreates a new comment on the task with the specified id.DELETEDeletes all comments of the specified task.GETReturns the comment with the specified id of the task with the specified id.PUTUpdates the comment with the specified id on the task with the specified id.DELETEDeletes the comment with the specified id on the task with the specified id.POSTUpdates the reactions of the comment with the specified id on the task with the specified id.

Task Tags⌄

POSTRemoves a tag from private tasks.GETReturns tags for the user's private tasks.POSTUpdates a tag for private tasks.POSTRemoves a tag from project tasks.GETReturns task tags that are in use by tasks.POSTUpdates a tag globally for project tasks.POSTAdds a batch of tags to the task.POSTRemoves tags from the task.GETReturns the tags of the task.

Task Dependencies⌄

GETReturns task dependencies for a project.POSTCreates task dependency.DELETEDeletes a task dependency.GETReturns task dependencies for a specific task.

Task Schedules⌄

GETReturns a list of task schedules.POSTCreates a schedule for a task.POSTCreates task schedules from a task by id.GETReturns a task schedule by id.PUTUpdates a given task schedule.DELETEDeletes a task schedule by id.

Task Activities⌄

GETReturns all activities of the task with the specified id.

Type Of Work⌄

GETReturns types of work.POSTCreates a type of work.GETReturns possible icons for type of work.GETReturns the type of work.PUTChanges the properties of a type of work.POSTDeletes the type of work.POSTArchives or unarchives the type of work.

Time Tracking⌄

Time Entries⌄

GETReturns the last time entry of a specified user.GETReturns all time entries of the specified project.GETReturns all time entries of the specified task.GETReturns time entries in the workspace.POSTCreates a time entry.POSTUpdates multiple time entries using the operation.POSTDeletes the time entry for the ids.POSTSets the time entries for the ids to billable.POSTSets the time entries for the ids to billed.POSTSets the type of work of the specified timeentries.POSTSets the time entries for the ids to unbillable.POSTSets the time entries for the ids to unbilled.GETReturns simplified time entries.GETReturns the specified time entry.PUTUpdates the time entry.DELETEDeletes the time entry.POSTRemoves breaks from the specified time entry.GETReturns the last time entry of a specified user.

Time Tracking⌄

POSTPauses a running time tracking for a user.POSTResumes a paused time tracking for a user.POSTStarts a new time tracking for a user.POSTStops the currently running time tracking of the specified user.POSTPauses a running time tracking for a user.POSTResumes a paused time tracking for a user.POSTStarts a new time tracking for a user.POSTStops the currently running time tracking of the specified user.

Time Reports⌄

GETReturns time reports of a user.

Time Tracking Settings⌄

GETReturns the global timetracking settings.

Documents⌄

GETReturns all documents.POSTCreates a document.POSTRestores the specified document.GETReturns the specified document.PUTUpdates the specified document.DELETEDeletes the specified document.GETReturns the current document content.PUTUpdates the specified document content.POSTAccepts one UTF-8 Markdown file and returns its converted Doc content HTML.POSTAdds contributors to the specified document.PUTUpdates a document contributor's access.DELETEDeletes a contributor from the specified document.POSTDuplicates the specified document.POSTAdds teams to the specified document.PUTUpdates a document team's access.DELETEDeletes a team from the specified document.GETReturns documents in the specified document space.GETReturns trashed documents in a document space.GETReturns private documents for the current user.GETReturns trashed private documents.GETReturns documents shared with the current user.GETReturns documents in the specified project.GETReturns trashed documents in the specified project.

Document Spaces⌄

GETReturns all document spaces.POSTCreates a document space.GETReturns the specified document space.PUTUpdates the specified document space.DELETEDeletes the specified document space.POSTAdds contributors to the specified document space.PUTUpdates a document space contributor's access.DELETEDeletes a document space contributor.POSTAdds teams to the specified document space.PUTUpdates a document space team's access.DELETEDeletes a team from the specified document space.

Document Comments⌄

GETReturns all comments of the document with the specified id.POSTCreates a new comment on the document with the specified id.DELETEDeletes all comments of the specified document.GETReturns the comment with the specified id of the document with the specified id.PUTUpdates the comment with the specified id on the document with the specified id.DELETEDeletes the comment with the specified id on the document with the specified id.POSTUpdates the reactions of the comment with the specified id on the document with the specified id.POSTSets the resolved status of a comment.

Search⌄

GETPerforms a full-text search across workspace entities.

Filters⌄

GETReturns the current user's filters.GETReturns the current user's filters for the specified user type.POSTEvaluates a filter definition against the specified user type and returns the filtered results without saving the filter. This endpoint is designed for quick filters where the frontend builds a FilterDefinition dynamically and needs to evaluate it immediately without persisting it to the database. Supports standard paging, ordering, and additional query constraints from query parameters.POSTAdds explicit contributors to the specified filter.PUTUpdates the access level of an explicit filter contributor.DELETERemoves an explicit contributor from the specified filter.POSTAdds explicit team permissions to the specified filter.PUTUpdates the access level of an explicit team permission on the specified filter.DELETERemoves an explicit team permission from the specified filter.GETReturns the filters created by the current user.GETReturns the filters created by the current user for the specified user type.POSTCreates a persisted filter definition for the specified user type.POSTCreates a persisted filter from an OData query string. Convenience endpoint for external API consumers who want to create filters using familiar OData syntax.GETReturns a single filter by its identifier for the current user.PUTUpdates an existing filter definition.DELETEDeletes a filter.POSTCreates a copy of an existing filter.GETEvaluates a filter by applying it to the specified target user type and returning the filtered results. Supports standard paging, ordering, and additional query constraints from query parameters.GETReturns filters explicitly shared with the current user.GETReturns filters explicitly shared with the current user for the specified user type.

Companies⌄

GETReturns all companies.POSTCreates a company.GETReturns all company industries in use.GETReturns the specified company.PUTUpdates the specified company.GETReturns the company's contact information.POSTCreates company contact information.GETReturns specified company contact information.PUTUpdates company contact information.DELETEDeletes company contact information.POSTDeletes the specified company.

Company Tags⌄

POSTRemoves a tag from all companies.GETReturns company tags in use.POSTUpdates a tag for all companies.POSTAdds tags to the specified company.POSTRemoves tags from the specified company.GETReturns tags for the specified company.

Users⌄

GETReturns the current user and workspace.GETReturns users with their details.GETReturns user name and gender for the email.GETReturns the logged-in user and workspace.GETReturns the user.PUTUpdates the user.DELETEDeletes the user.POSTActivates the user.GETReturns the contact infos of the user.POSTCreates contact info for the user.GETReturns the contact info of the user.PUTUpdates the contact info of the user.DELETEDeletes the contact info of the user.POSTDeactivates the user.POSTArchives or unarchives the user.

User Capacities⌄

GETReturns the capacity of the specified user.PUTUpdates the capacity of the specified user.

User Tags⌄

POSTRemoves a tag from users.GETReturns tags that are in use.POSTUpdates a tag globally for users.POSTAdds a batch of tags to the user.POSTRemoves tags from the user.GETReturns the tags of the users.

Absences⌄

GETReturns all absences.POSTCreates an absence.GETReturns the specified absence.PUTUpdates the specified absence.DELETEDeletes the specified absence.

Absence Regions⌄

GETReturns all absence regions.POSTCreates an absence region.GETReturns supported absence region countries.GETReturns locations for the specified country.POSTSets the current user's absence region.PUTSets the current user's absence region.POSTSets users for an absence region.PUTSets users for an absence region.GETReturns the specified absence region.PUTUpdates the specified absence region.DELETEDeletes the specified absence region.

Workspace Absences⌄

GETReturns workspace absences.POSTCreates a new workspace absence.PUTUpdates a workspace absence.DELETEDeletes a workspace absence.

Dashboards⌄

GETReturns dashboards for the current user.

Files & Images⌄

Files⌄

GETReturns the latest content of the specified file and supports range requests.GETReturns the latest version of the specified file as PDF.

File Upload⌄

POSTCreates a file from an upload id. (agents)POSTCreates a file from an upload id. (documents)POSTGenerates a URL to upload a file to.POSTCreates a file from an upload id. (projects)POSTCreates a file from an upload id. (tasks)POSTCreates a file from an upload id. (tasktemplates)POSTCreates a file from an upload id. (workspaces)

Project Files⌄

GETReturns project files and files of tasks linked to the project.POSTCreates external file references for the specified project.GETReturns all files of the specified project.POSTUploads a file for the specified project.DELETEDeletes all files and versions for the specified project.POSTUploads a file from a public URL for the specified project.GETReturns the file with the specified id of the project with the specified id.PUTUpdates metadata for the specified file.DELETEDeletes the specified project file and its versions.POSTChanges file ownership within the same workspace after checking workspace file management access.POSTCopies the specified file to another project.GETReturns the latest content of the specified project file.GETReturns the specified project file as PDF.GETReturns a public URL for the specified file.GETReturns all versions of the specified project file.POSTUploads a new version of the specified project file.GETReturns the project file version with the specified id.GETReturns the content of the specified project file version.

Task Files⌄

POSTCreates external file references for the specified task.GETReturns all files of the specified task.POSTUploads a file for the specified task.DELETEDeletes all files and versions for the specified task.POSTUploads a file from a public URL for the specified task.GETReturns the file with the specified id of the task with the specified id.PUTUpdates metadata for the specified file.DELETEDeletes the specified task file and its versions.POSTChanges file ownership within the same workspace after checking workspace file management access.POSTCopies the specified file to another task.GETReturns the latest content of the specified task file.GETReturns the specified task file as PDF.GETReturns a public URL for the specified file.GETReturns all versions of the specified task file.POSTUploads a new version of the specified task file.GETReturns the task file version with the specified id.GETReturns the content of the specified task file version.

Company Files⌄

POSTCreates external file references for the specified company.POSTUploads a file for the specified company.DELETEDeletes all files and versions for the specified company.POSTUploads a file from a public URL for the specified company.GETReturns the file with the specified id of the company with the specified id.PUTUpdates metadata for the specified file.DELETEDeletes the specified company file and its versions.POSTChanges file ownership within the same workspace after checking workspace file management access.POSTCopies the specified file to another company.GETReturns the latest content of the specified company file.GETReturns the specified company file as PDF.GETReturns a public URL for the specified file.GETReturns all versions of the specified company file.POSTUploads a new version of the specified company file.GETReturns the company file version with the specified id.GETReturns the content of the specified company file version.

Document Files⌄

POSTCreates external file references for the specified document.GETReturns all files of the specified document.POSTUploads a file for the specified document.DELETEDeletes all files and versions for the specified document.POSTUploads a file from a public URL for the specified document.GETReturns the file with the specified id of the document with the specified id.PUTUpdates metadata for the specified file.DELETEDeletes the specified document file and its versions.POSTCopies the specified file to another document.GETReturns the latest content of the specified document file.GETReturns a public URL for the specified file.GETReturns all versions of the specified document file.POSTUploads a new version of the specified document file.GETReturns the document file version with the specified id.GETReturns the content of the specified document file version.

User Files⌄

POSTCreates external file references for the specified user.GETReturns all files of the specified user.POSTUploads a file for the specified user.DELETEDeletes all files and versions for the specified user.POSTUploads a file from a public URL for the specified user.GETReturns the file with the specified id of the user with the specified id.PUTUpdates metadata for the specified file.DELETEDeletes the specified user file and its versions.POSTChanges file ownership within the same workspace after checking workspace file management access.POSTCopies the specified file to another user.GETReturns the latest content of the specified user file.GETReturns the specified user file as PDF.GETReturns a public URL for the specified file.GETReturns all versions of the specified user file.POSTUploads a new version of the specified user file.GETReturns the user file version with the specified id.GETReturns the content of the specified user file version.

Workspace Files⌄

POSTCreates external file references for the specified workspace.GETReturns all files of the specified workspace.POSTUploads a file for the specified workspace.DELETEDeletes all files and versions for the specified workspace.POSTUploads a file from a public URL for the specified workspace.GETReturns the file with the specified id of the workspace with the specified id.PUTUpdates metadata for the specified file.DELETEDeletes the specified workspace file and its versions.POSTChanges file ownership within the same workspace after checking workspace file management access.POSTCopies the specified file to another workspace.GETReturns the latest content of the specified workspace file.GETReturns the specified workspace file as PDF.GETReturns a public URL for the specified file.GETReturns all versions of the specified workspace file.POSTUploads a new version of the specified workspace file.GETReturns the workspace file version with the specified id.GETReturns the content of the specified workspace file version.

Project Template Files⌄

POSTCreates external file references for the specified projecttemplate.GETReturns all files of the specified projecttemplate.POSTUploads a file for the specified projecttemplate.DELETEDeletes all files and versions for the specified projecttemplate.POSTUploads a file from a public URL for the specified projecttemplate.GETReturns the file with the specified id of the projecttemplate with the specified id.PUTUpdates metadata for the specified file.DELETEDeletes the specified projecttemplate file and its versions.POSTChanges file ownership within the same workspace after checking workspace file management access.POSTCopies the specified file to another projecttemplate.GETReturns the latest content of the specified projecttemplate file.GETReturns the specified projecttemplate file as PDF.GETReturns a public URL for the specified file.GETReturns all versions of the specified projecttemplate file.POSTUploads a new version of the specified projecttemplate file.GETReturns the projecttemplate file version with the specified id.GETReturns the content of the specified projecttemplate file version.

Task Template Files⌄

POSTCreates external file references for the specified tasktemplate.GETReturns all files of the specified tasktemplate.POSTUploads a file for the specified tasktemplate.DELETEDeletes all files and versions for the specified tasktemplate.POSTUploads a file from a public URL for the specified tasktemplate.GETReturns the file with the specified id of the tasktemplate with the specified id.PUTUpdates metadata for the specified file.DELETEDeletes the specified tasktemplate file and its versions.POSTChanges file ownership within the same workspace after checking workspace file management access.POSTCopies the specified file to another tasktemplate.GETReturns the latest content of the specified tasktemplate file.GETReturns the specified tasktemplate file as PDF.GETReturns a public URL for the specified file.GETReturns all versions of the specified tasktemplate file.POSTUploads a new version of the specified tasktemplate file.GETReturns the tasktemplate file version with the specified id.GETReturns the content of the specified tasktemplate file version.

Shared Files⌄

GETReturns the public profile image.GETReturns a shared file.

Temporary Files⌄

GETReturns all temporary files of the current user.POSTCreates a new temporary file.GETReturns the temporary file with the specified id.PUTUpdates the meta information of the temporary file with the specified id.GETReturns the content of the temporary file with the specified id.POSTSets the temporary file to a global or supported entity file.

Images⌄

GETReturns the image of the agent with the specified id.POSTUploads a new profile image.DELETEDeletes the profile image of the agent with the specified id.POSTSets a profile image from a previously uploaded file.GETReturns the image of the company with the specified id.POSTUploads a new profile image.DELETEDeletes the profile image of the company with the specified id.POSTSets a profile image from a previously uploaded file.GETReturns the image of the project with the specified id.POSTUploads a new profile image.DELETEDeletes the profile image of the project with the specified id.POSTSets a profile image from a previously uploaded file.GETReturns the image of the projecttemplate with the specified id.POSTUploads a new profile image.DELETEDeletes the profile image of the projecttemplate with the specified id.POSTSets a profile image from a previously uploaded file.GETReturns the image of the user with the specified id.POSTUploads a new profile image.DELETEDeletes the profile image of the user with the specified id.POSTSets a profile image from a previously uploaded file.GETReturns the image of the workspace with the specified id.POSTUploads a new profile image.DELETEDeletes the profile image of the workspace with the specified id.POSTSets a profile image from a previously uploaded file.

Custom Fields⌄

Custom Fields⌄

GETReturns all custom field definitions.POSTCreates a custom field definition.PUTUpdates the specified custom field definition.DELETEDeletes the specified custom field definition.POSTCreates an option for a custom field.PUTUpdates a custom field selection option.DELETEDeletes a custom field selection option.GETReturns custom fields for the specified project.PUTUpdates custom field order in a project.POSTLinks a custom field to the specified project.POSTSets custom field values for a project.POSTUnlinks a custom field from the specified project.GETReturns custom fields.PUTUpdates custom field order in a template.POSTLinks a custom field definition to the template.POSTSets the custom fields for a project template.POSTUnlinks a custom field from a template.POSTSets the custom fields for a task.POSTSets the custom fields for the task template.GETReturns custom fields linked to a workflow.PUTUpdates custom fields.POSTLinks a custom field definition to a workflow.POSTUnlinks a custom field from a workflow.

Workload & Planning⌄

Workload⌄

GETReturns the users' workloads per day.GETStreams minimal workloads using the workspace rollout mode.

Project Templates⌄

Project Templates⌄

GETReturns project templates.POSTCreates a new project template.GETReturns a specific project template.PUTUpdates project template.DELETEDeletes a project template.GETReturns project statuses of a project template.POSTAdds a project status to a project template.GETReturns the bundle associated with a template.GETReturns task statuses of the project template.POSTCreates a task status for the template.GETReturns the task status of the project template.PUTUpdates a task status for the template.DELETEDeletes the task status of the project template.POSTUpdates project status order in a template.

Task Bundles⌄

POSTAdds a task bundle to the specified project.GETReturns task bundles.POSTCreates a task bundle.POSTCreates a task bundle from a project.POSTCreates a task bundle from a task list.GETReturns available task bundle icons.GETReturns a task bundle by id.PUTUpdates a task bundle.DELETEDeletes a task bundle and its project template links.POSTCreates a copy of a task bundle.GETReturns task list templates for a task bundle.POSTCreates a task list template for a bundle.GETReturns a task list template.PUTUpdates a task list template.DELETEDeletes a task list template.POSTAdds task templates to a task list template.POSTRemoves task templates from a task list template.GETReturns task templates inside a task list template.GETReturns a task template from a list.POSTUpdates task template order in a list.POSTUpdates task template order in a list.GETReturns checklist items for a task template.POSTCreates a checklist item template.GETReturns a checklist item template.PUTUpdates a checklist item template.DELETEDeletes a checklist item template.POSTDeletes a task template recurrence rule.GETReturns recurrency details for a task template.POSTUpdates a task template recurrence rule.

Task Templates⌄

GETReturns task templates of the task bundle.POSTCreates a task template for the task bundle.GETReturns the task template of the task bundle.PUTUpdates the task template for the task bundle.DELETEDeletes the task template for the task bundle.POSTAssigns a list of users to task templates.GETReturns the task template.

Task Template Tags⌄

POSTRemoves a tag from task templates.GETReturns tags that are in use by task templates.POSTUpdates a tag globally for task templates.POSTAdds a batch of tags to the task template.POSTRemoves tags from the task template.GETReturns the tags of the task template.

Task Dependency Templates⌄

GETReturns dependency templates for a task bundle.POSTCreates a dependency template for a bundle.GETReturns a dependency template from a bundle.DELETEDeletes a dependency template from a bundle.GETReturns dependency templates for a task template.

Project Template Tags⌄

POSTRemoves a tag from project templates.GETReturns tags in use by project templates.POSTUpdates a tag globally for project templates.POSTAdds a batch of tags to the project template.POSTRemoves tags from the project template.GETReturns the tags of the project template.

Project Milestone Templates⌄

GETReturns milestone templates of the given template.POSTCreates milestone template for the template.GETReturns a milestone by id for the project template.PUTUpdates a milestone template for the template.DELETEDeletes a milestone for the project template.

Project Template Automations⌄

GETReturns all automations for a project template.POSTCreates a new automation for a given project template.GETReturns a specific automation for a projecttemplate.PUTUpdates the automation with the specified id for a given projecttemplate.DELETEDeletes the specified automation for a given projecttemplate.GETGets the actions of an automation of a project template.POSTCreates a new action for an automation of a project template.GETGets a specific action for an automation of a projecttemplate.PUTUpdates a specifc action of an automation of a project template.DELETEDeletes an action for an automation of a project template.POSTUpdates the order of a project template automation action.POSTReapplies the automation to all projects of this specific project template.

Workflows⌄

POSTLinks a workflow to the specified project.POSTUnlinks a workflow from the specified project.POSTUnlinks a workflow from a project template.GETReturns workflows.POSTCreates a new workflow.GETReturns a specified workflow.PUTUpdates a workflow.POSTCreates a copy of a workflow.POSTDeletes a workflow.GETReturns project statuses of the workflow.POSTCreates a project status in a workflow.GETReturns the project status of the workflow.PUTUpdates a project status for the workflow.POSTDeletes a project status from the workflow.POSTSets the archived status of a workflow.GETReturns task statuses of the workflow.POSTCreates a task status for the specified workflow.GETReturns the task status of the workflow.PUTUpdates a task status for the specified workflow.POSTDeletes the task status of the workflow.POSTUpdates project status order in a workflow.

Workflow Automations⌄

POSTCopies automations from one workflow to another.GETRetrieves automations of the specified workflow.POSTCreates a new automation for a workflow.GETRetrieves a specific automation of the specified workflow.PUTUpdates an automation of the specified workflow.DELETEDeletes a workflow automation by id.GETGets all actions of an automation of a workflow.POSTCreates a new action for an automation of a workflow.GETGets a specific action of an automation of a workflow.PUTUpdates an action of an automation of a workflow.DELETEDeletes an action from an automation of a workflow.POSTUpdates the order of an action within an automation of a workflow.

Login & Access⌄

Accounts⌄

PUTUpdates the account profile and starts email verification when required.POSTChecks a password or passwordless token for the requested account.DELETEClears gateway caches after checking the internal tools API key.

Invitations⌄

GETPrevents GET requests to the invitations route from throwing errors.POSTInvites a user to a workspace.POSTAccepts an invitation using its invitation code.

Permissions⌄

GETReturns permissions for the current user.GETReturns available workspace features.GETReturns available project features.

Roles⌄

GETReturns roles of the workspace.POSTCreates a workspace role.POSTMoves a user to another role.GETReturns all users in roles of the workspace.GETReturns the role.PUTUpdates the role.POSTAdds the user to the role.GETReturns deactivated menu items for the role.POSTUpdates deactivated menu items for a role.POSTDeletes the role.GETReturns permissions of the specified role.POSTUpdates permissions for a role.POSTArchives or unarchives the role.GETReturns users of the specified role.POSTActivates the user.POSTDeactivates the user.GETReturns the role for the name.

Teams⌄

GETReturns teams in the workspace.POSTCreates a team.GETReturns the team.PUTUpdates the team.DELETEDeletes the team.POSTAdds projects to the specified team.POSTAdds users to the specified team.POSTRemoves projects from the specified team.POSTRemoves users from the specified team.

Workspaces⌄

GETReturns all available workspace types.GETReturns the workspace with the specified id.PUTUpdates workspace settings and saves survey answers while setup is pending.

API Management⌄

Api Users⌄

GETReturns all API users.POSTCreates an API user.GETReturns the specified API user.PUTUpdates the specified API user.DELETEDeletes the specified API user.

Webhooks⌄

GETReturns all configured webhooks.POSTCreates a new webhook.GETReturns all available event types.GETReturns all available event types for Slack webhooks.GETReturns the webhook with the specified id.PUTUpdates the webhook with the specified id.DELETEDeletes the webhook with the specified id.GETReturns all logs of the webhook with the specified id.

Client Applications⌄

GETReturns the third-party OAuth client applications authorized by the current account.DELETERevokes the current account's authorizations and refresh tokens for all third-party OAuth client applications.DELETERevokes the current account's authorization and refresh tokens for one third-party OAuth client application.GETReturns all client applications.POSTRegisters a new client application.POSTDynamically registers a new OAuth 2.0 client according to RFC 7591.GETReturns the client application with the specified id.PUTUpdates the client application with the specified id.DELETEDeletes the specified client application.POSTGenerates an API key for the specified client application.POSTGenerates a new secret for the specified client application.

Agent Prompts⌄

GETLists prompts the caller can access.POSTCreates a private prompt owned by the caller.GETReads current prompt content and access.PUTUpdates prompt content without changing sharing.DELETEDeletes a prompt with Manage access.POSTCreates an independent private copy of a readable prompt.POSTChanges only the item's official status after rollout and item authorization.GETReads the prompt sharing configuration.PUTReplaces prompt sharing after checking Manage and contribution access.PUTChanges only the item's tags after rollout and item authorization.

Download OpenAPI ↗

API v1 Reference › Workload

Workload

Endpoints for workload.

GETReturns the users' workloads per day./users/workloadGETStreams minimal workloads using the workspace rollout mode./users/workload/stream

Search documentation