Search...
/
Support
Developer Forum
Login
Overview
Introduction
Getting Started
Authentication
Error Handling
Pagination
Filtering
Ordering
Rate Limits
Permissions
Webhooks
Changelog
Support
API Reference
Projects Overview
Projects
GET
Returns all projects.
POST
Creates a new project.
GET
Returns the project with the specified id.
PUT
Updates the project with the specified id.
POST
Changes the status of the project with the specified id.
POST
Changes the project type of the project with the specified id.
POST
Deletes the project with the specified id.
GET
Returns the project members of the project with the specified id.
POST
Adds a project member to the project with the specified id.
POST
Updates the role of a project member of the project with the specified id.
POST
Removes a project member from the project with the specified id.
POST
Creates the preconfigured project in the language of the user.
POST
Updates the order of a project status.
Project Types
GET
Returns the project type with the specified id.
PUT
Updates the project type with the specified id.
GET
Returns all existing project types.
POST
Creates a new project type.
GET
Gets all possible icons for project types.
POST
Deletes the project type with the specified id.
POST
Archives or unarchives the project type with the specified id.
Project Statuses
POST
Creates a new project status.
POST
Creates a new project status for a project.
GET
Returns the project status with the specified id.
PUT
Updates the project status with the specified id.
GET
Returns all project statuses.
POST
Archives or unarchives the project status with the specified id.
POST
Deletes the project status with the specified id.
Project Roles
GET
Returns all project roles.
POST
Creates a new project role.
GET
Returns the project role with the specified id.
PUT
Updates the project role with the specified id.
POST
Deletes the project role with the specified id.
GET
Returns all permissions of the project role with the specified id.
POST
Creates, updates or deletes a permission of a project role with the specified id.
Project Comments
POST
Updates the reactions of the comment with the specified id on the project with the specified id.
GET
Returns the comment with the specified id of the project with the specified id.
PUT
Updates the comment with the specified id on the project with the specified id.
DEL
Deletes the comment with the specified id on the project with the specified id.
GET
Returns all comments of the project with the specified id.
POST
Creates a new comment on the project with the specified id.
DEL
Deletes all comments of the specified project.
Project Tags
GET
Returns the tags of the project with the specified id.
GET
Returns all tags that are currently in use for the given project type.
POST
Removes tag from all entities.
POST
Removes tags from the project with the specified id.
POST
Updates a tag to the project with the specified id.
POST
Adds a batch of new tags to the project with the specified id.
Project Milestones
GET
Returns all project milestones of the specified project.
GET
Returns the specified project milestone.
GET
Returns all project milestones the user is allowed to see.
POST
Creates a new project milestone.
PUT
Updates the project milestone with the specified id.
DEL
Deletes the project milestone with the specified id.
Project Automations
GET
Returns all automations for a project.
POST
Creates a new automation for the specified project.
GET
Returns a specific automation from a project.
PUT
Updates the automation with the specified id.
DEL
Deletes the specified automation for a given project.
Project Actions
GET
Gets the actions of an automation.
POST
Creates a new action for an automation.
GET
Gets a specific action for an automation.
PUT
Updates a specifc action of an automation.
DEL
Deletes an action for an automation.
POST
Updates the order of a given action.
Project Time Bookings
PUT
Updates a given project time booking.
DEL
Deletes a project time booking by id.
GET
Returns the project time bookings in a specified time range for a list of users.
GET
Returns a list of project time bookings.
POST
Creates a new project time booking for a given project and user.
Autopilot
GET
Returns the autopilot of the project with the specified id.
POST
Creates a new autopilot for the project with the specified id.
PUT
Updates the autopilot of the project with the specified id.
DEL
Deletes the autopilot of the project with the specified id.
GET
Returns the autopilot with the specified id.
GET
Returns all available alerts for autopilots.
Tasks Overview
Tasks
GET
Returns the task with the specified id.
PUT
Updates the task with the specified id.
POST
Creates a new task.
POST
Creates a copy of the specified task.
POST
Changes the parent task and the order of subtasks.
POST
Changes the lists of tasks.
POST
Convert subtasks to a parent task.
POST
Assigns a list of users to a given task
POST
Assigns a new user to a tasks by email invitation.
POST
Modifies a list of planned efforts of a given task.
POST
Deletes several tasks.
POST
Changes statuses of tasks.
POST
Updates the order of the task with the specified id.
POST
Changes the type of work for a batch of tasks.
POST
Changes the base type for a batch of tasks.
POST
Set the priority of the task with the specified id.
GET
Gets the recurrency rule for the specified task.
Task Lists
POST
Changes the project of the task list with the specified id.
POST
Creates a copy of the task list.
GET
Returns all task lists of the project with the specified id.
POST
Creates a new task list.
GET
Returns the task list with the specified id.
PUT
Updates the task list with the specified id.
POST
Deletes the task list with the specified id.
POST
Updates the order of a task list.
POST
Archives or unarchives the task list with the specified id.
POST
Adds the tasks to the task list with the specified id.
POST
Removes the tasks from the task list with the specified id.
GET
Returns the task with the specified id in the specified task list.
POST
Updates the order of a task in a task list.
Task Views
GET
Returns a single task view that is shared within the workspace.
GET
Returns all task views that are shared within the workspace.
POST
Subscribes the current user to a shared task view.
POST
Terminates a subscription of a user to a shared task view.
GET
Returns a single task view from a user.
PUT
Updates an existing task view.
DEL
Deletes an existing task view that is specified by an id.
GET
Returns all task views that the user subscribed to.
POST
Creates a new task view and directly subscribes the user to it.
GET
Returns all the tasks of a task view.
Project Tasks
GET
Returns all project tasks of the project with the specified id.
GET
Returns the project task with the specified id.
GET
Returns all project tasks that the current user can see.
GET
Returns all tags of the project tasks.
POST
Changes the project of the task with the specified id.
GET
Returns the type of work for the project with the specified id. .
POST
Creates new task statuses for the specified project.
GET
Returns all task statuses of the project with the specified id.
POST
Creates a new task status for the specified project.
GET
Returns the task status of the project with the specified id.
PUT
Updates a task status for the specified project.
POST
Deletes the task status with the specified id.
GET
Returns all task statuses of the project template with the specified id.
POST
Creates a new task status for the specified project template.
GET
Returns the task status of the project template with the specified id.
PUT
Updates a task status for the specified project template.
DEL
Deletes the task status of the project template with the specified id.
Private Tasks
GET
Returns all tags of the private tasks.
GET
Returns all private tasks of the user with the specified id.
GET
Returns the private task with the specified id.
GET
Returns all private tasks that a user created and assigned to someone else.
GET
Returns a private tasks that a user created and assigned to someone else.
GET
Returns the task statuses for private tasks.
Assigned Tasks
GET
Returns all tags the user is allowed to see. You can filter the tags by task model query constraints.
GET
Returns the assigned task with the specified id.
GET
Returns all tasks assigned to the user.
GET
Returns all tasks the user is allowed to see.
Checklist Items
POST
Convert all checklist items of the specified task to subtasks.
GET
Returns the checklist items for a task with the specified id.
POST
Creates a checklist item for a task with the specified id.
GET
Returns the checklist item for a task with the specified id.
PUT
Updates a checklist item for a task with the specified id.
DEL
Deletes a checklist item for a task with the specified id.
GET
Returns the checklist items for a project task with the specified id.
GET
Returns a checklist item for a project task with the specified id.
GET
Returns the checklist for a private task with the specified id.
GET
Returns a checklist item for a private task with the specified id.
GET
Returns the checklist items for a private task with the specified id.
Task Comments
POST
Updates the reactions of the comment with the specified id on the task with the specified id.
GET
Returns the comment with the specified id of the task with the specified id.
PUT
Updates the comment with the specified id on the task with the specified id.
DEL
Deletes the comment with the specified id on the task with the specified id.
GET
Returns all comments of the task with the specified id.
POST
Creates a new comment on the task with the specified id.
DEL
Deletes all comments of the specified task.
Task Tags
GET
Returns all tags that are currently in use.
GET
Returns the tags of the entity with the specified id.
POST
Adds a batch of new tags to the entity with the specified id.
POST
Updates a tag to the entity with the specified id.
POST
Removes tags from the entity with the specified id.
POST
Removes tag from all entities.
Task Dependencies
GET
Returns all task dependencies for a specific project.
GET
Returns all task dependencies for a specific task.
POST
Creates a new task dependency.
DEL
Deletes a task dependency.
Task Schedules
GET
Returns a list of task schedules.
POST
Creates a new task schedule for a given task and a given user.
GET
Returns a task schedule by id.
PUT
Updates a given task schedule.
DEL
Deletes a task schedule by id.
POST
Creates task schedules from a task by id.
Tasks Batch
POST
Edits multiple tasks using the specified operation.
Type of Work
GET
Gets the type of work with the specified id.
PUT
Changes the properties of an existing type of work.
GET
Gets all types of work.
POST
Creates a new type of work.
GET
Gets all possible icons for type of work.
POST
Deletes the type of work with the specified id.
POST
Archives or unarchives the type of work with the specified id.
Time Tracking Overview
Time Entries
GET
Returns all time entries.
POST
Creates a new time entry.
POST
Edits multiple time entries using the specified operation.
GET
Returns the time entries with the specified id.
PUT
Updates the time entry with the specified id.
DEL
Deletes the time entry with the specified id.
GET
Returns all time entries with a simplified model.
POST
Removes all finished breaks of the time entry.
POST
Deletes the time entry with the specified ids.
POST
Sets the time entries with the specified ids to billed.
POST
Sets the time entries with the specified ids to unbilled.
POST
Sets the time entries with the specified ids to to unbillable.
POST
Sets the time entries with the specified ids to to billable.
POST
Sets the type of work of the specified timeentries.
GET
Returns the last time entry of a specified user.
Time Tracking
POST
Pauses a running time tracking for a user.
POST
Starts a new time tracking for a user.
POST
Stops the currently running time tracking of the specified user.
POST
Resumes a paused time tracking for a user.
Time Reports
GET
Returns all time reports of a user.
POST
Creates a new time report.
GET
Returns time reports of the specified id.
PUT
Updates a time report.
DEL
Deletes a time report.
Project Time Entries
GET
Gets the summed up tracked time duration for all projects and tasks.
GET
Gets the summed up tracked time duration for specified projects and tasks.
GET
Returns all time entities of a specified project.
Task Time Entries
GET
Gets the summed up tracked time duration for specified projects and tasks.
GET
Gets the summed up tracked time duration for all projects and tasks.
GET
Returns all time entities of a specified task.
Companies Overview
Companies
POST
Deletes the company with the specified id.
GET
Returns all companies.
POST
Creates a new company.
GET
Returns the company with the specified id.
PUT
Updates the company with the specified id.
GET
Returns the contact infos of the company with the specified id.
POST
Creates a new contact info for the company with the specified id.
GET
Returns the specified contact info of the company with the specified id.
PUT
Updates the contact info for the company with the specified id.
DEL
Deletes the contact info of the company with the specified id.
GET
Returns all company industries that are currently in use.
Company Tags
GET
Returns all tags that are currently in use.
GET
Returns the tags of the companies with the specified id.
POST
Adds a batch of new tags to the company with the specified id.
POST
Updates a tag to the company with the specified id.
POST
Removes tags from the company with the specified id.
POST
Removes tag from all entities.
Users Overview
Users
GET
Returns the currently logged-in user and workspace.
GET
Returns all users.
GET
Returns the user with the specified id.
PUT
Updates the user with the specified id.
DEL
Deletes the user with the specified id.
POST
Deactivates the user with the specified id.
POST
Activates the user with the specified id.
POST
Archives or unarchives the user with the specified id.
GET
Returns the contact infos of the user with the specified id.
POST
Creates a new contact info for the user with the specified id.
GET
Returns the contact info of the user with the specified id.
PUT
Updates the contact info of the user with the specified id.
DEL
Deletes the contact info of the user with the specified id.
User Capacity
GET
Returns the capacity of the specified user.
PUT
Updates the capacity of the specified user.
User Tags
GET
Returns all tags that are currently in use.
GET
Returns the tags of the users with the specified id.
POST
Adds a batch of new tags to the user with the specified id.
POST
Updates a tag to the user with the specified id.
POST
Removes tags from the user with the specified id.
POST
Removes tag from all entities.
Absences
GET
Returns all absences.
POST
Creates a new absence.
GET
Returns the absence with the specified id.
PUT
Updates the absence with the specified id.
DEL
Deletes the absence with the specified id.
Dashboards
GET
Returns the dashboards of the current user.
Files & Images Overview
Files
GET
Returns the content of the file with the specified id.
GET
Returns the content of the file with the specified id as pdf.
Project Files
GET
Returns the file with the specified id of the project with the specified id.
PUT
Updates the metadata of the project file with the specified id.
DEL
Deletes the project file with the specified id.
GET
Returns all files of the project with the specified id.
POST
Creates a new project file for the project with the specified id..
DEL
Deletes the files of the specified project.
POST
Endpoint to batch create external files without uploading.
POST
Uploads a new file by providing an url.
GET
Returns the content of the project file with the specified id.
GET
Returns the content of the file with the specified id as pdf. type or conversion not possible.
GET
Returns all file versions of the specified project file.
POST
Uploads a new version of the project file with the specified id.
GET
Returns the project file version with the specified id.
GET
Returns the content of the project file version with the specified id.
POST
Copys the file to a new project.
GET
Returns a url to share the file.
POST
Changes the project this file belongs to.
Task Files
GET
Returns the file with the specified id of the task with the specified id.
PUT
Updates the metadata of the task file with the specified id.
DEL
Deletes the task file with the specified id.
GET
Returns all files of the task with the specified id.
POST
Creates a new task file for the task with the specified id..
DEL
Deletes the files of the specified task.
POST
Endpoint to batch create external files without uploading.
POST
Uploads a new file by providing an url.
GET
Returns the content of the task file with the specified id.
GET
Returns the content of the file with the specified id as pdf. type or conversion not possible.
GET
Returns all file versions of the specified task file.
POST
Uploads a new version of the task file with the specified id.
GET
Returns the task file version with the specified id.
GET
Returns the content of the task file version with the specified id.
POST
Copys the file to a new task.
GET
Returns all files of the project with the specified id.
GET
Returns a url to share the file.
POST
Changes the task this file belongs to.
Company Files
GET
Returns the file with the specified id of the company with the specified id.
PUT
Updates the metadata of the company file with the specified id.
DEL
Deletes the company file with the specified id.
GET
Returns all files of the company with the specified id.
POST
Creates a new company file for the company with the specified id..
DEL
Deletes the files of the specified company.
POST
Endpoint to batch create external files without uploading.
POST
Uploads a new file by providing an url.
GET
Returns the content of the company file with the specified id.
GET
Returns the content of the file with the specified id as pdf. type or conversion not possible.
GET
Returns all file versions of the specified company file.
POST
Uploads a new version of the company file with the specified id.
GET
Returns the company file version with the specified id.
GET
Returns the content of the company file version with the specified id.
POST
Copys the file to a new company.
GET
Returns all files of the project with the specified id.
GET
Returns a url to share the file.
POST
Changes the company this file belongs to.
Comment Files
GET
Returns the file with the specified id of the comment with the specified id.
PUT
Updates the metadata of the comment file with the specified id.
DEL
Deletes the comment file with the specified id.
GET
Returns all files of the comment with the specified id.
POST
Creates a new comment file for the comment with the specified id..
DEL
Deletes the files of the specified comment.
POST
Endpoint to batch create external files without uploading.
POST
Uploads a new file by providing an url.
GET
Returns the content of the comment file with the specified id.
GET
Returns the content of the file with the specified id as pdf. type or conversion not possible.
GET
Returns all file versions of the specified comment file.
POST
Uploads a new version of the comment file with the specified id.
GET
Returns the comment file version with the specified id.
GET
Returns the content of the comment file version with the specified id.
POST
Copys the file to a new comment.
GET
Returns all files of the project with the specified id.
GET
Returns a url to share the file.
POST
Changes the comment this file belongs to.
User Files
GET
Returns all files of the user with the specified id.
POST
Creates a new user file for the user with the specified id..
DEL
Deletes the files of the specified user.
GET
Returns the file with the specified id of the user with the specified id.
PUT
Updates the metadata of the user file with the specified id.
DEL
Deletes the user file with the specified id.
POST
Endpoint to batch create external files without uploading.
POST
Uploads a new file by providing an url.
GET
Returns the content of the user file with the specified id.
GET
Returns the content of the file with the specified id as pdf. type or conversion not possible.
GET
Returns all file versions of the specified user file.
POST
Uploads a new version of the user file with the specified id.
GET
Returns the user file version with the specified id.
GET
Returns the content of the user file version with the specified id.
POST
Copys the file to a new user.
GET
Returns all files of the project with the specified id.
GET
Returns a url to share the file.
POST
Changes the user this file belongs to.
Workspace Files
GET
Returns all files of the workspace with the specified id.
POST
Creates a new workspace file for the workspace with the specified id..
DEL
Deletes the files of the specified workspace.
GET
Returns the file with the specified id of the workspace with the specified id.
PUT
Updates the metadata of the workspace file with the specified id.
DEL
Deletes the workspace file with the specified id.
POST
Endpoint to batch create external files without uploading.
POST
Uploads a new file by providing an url.
GET
Returns the content of the workspace file with the specified id.
GET
Returns the content of the file with the specified id as pdf. type or conversion not possible.
GET
Returns all file versions of the specified workspace file.
POST
Uploads a new version of the workspace file with the specified id.
GET
Returns the workspace file version with the specified id.
GET
Returns the content of the workspace file version with the specified id.
POST
Copys the file to a new workspace.
GET
Returns all files of the project with the specified id.
GET
Returns a url to share the file.
POST
Changes the workspace this file belongs to.
Project Template Files
GET
Returns the file with the specified id of the projecttemplate with the specified id.
PUT
Updates the metadata of the projecttemplate file with the specified id.
DEL
Deletes the projecttemplate file with the specified id.
GET
Returns all files of the projecttemplate with the specified id.
POST
Creates a new projecttemplate file for the projecttemplate with the specified id..
DEL
Deletes the files of the specified projecttemplate.
POST
Endpoint to batch create external files without uploading.
POST
Uploads a new file by providing an url.
GET
Returns the content of the projecttemplate file with the specified id.
GET
Returns the content of the file with the specified id as pdf. type or conversion not possible.
GET
Returns all file versions of the specified projecttemplate file.
POST
Uploads a new version of the projecttemplate file with the specified id.
GET
Returns the projecttemplate file version with the specified id.
GET
Returns the content of the projecttemplate file version with the specified id.
POST
Copys the file to a new projecttemplate.
GET
Returns all files of the project with the specified id.
GET
Returns a url to share the file.
POST
Changes the projecttemplate this file belongs to.
Task Template Files
GET
Returns the file with the specified id of the tasktemplate with the specified id.
PUT
Updates the metadata of the tasktemplate file with the specified id.
DEL
Deletes the tasktemplate file with the specified id.
GET
Returns all files of the tasktemplate with the specified id.
POST
Creates a new tasktemplate file for the tasktemplate with the specified id..
DEL
Deletes the files of the specified tasktemplate.
POST
Endpoint to batch create external files without uploading.
POST
Uploads a new file by providing an url.
GET
Returns the content of the tasktemplate file with the specified id.
GET
Returns the content of the file with the specified id as pdf. type or conversion not possible.
GET
Returns all file versions of the specified tasktemplate file.
POST
Uploads a new version of the tasktemplate file with the specified id.
GET
Returns the tasktemplate file version with the specified id.
GET
Returns the content of the tasktemplate file version with the specified id.
POST
Copys the file to a new tasktemplate.
GET
Returns all files of the project with the specified id.
GET
Returns a url to share the file.
POST
Changes the tasktemplate this file belongs to.
Shared Files
GET
Returns the public profile image.
GET
Returns the shared file.
Temporary Files
GET
Returns all temporary files of the current user.
POST
Creates a new temporary file.
GET
Returns the temporary file with the specified id.
PUT
Updates the meta information of the temporary file with the specified id.
GET
Returns the content of the temporary file with the specified id.
POST
Sets the temporary file to a global or entity file.
Images
GET
Returns the image of the company with the specified id.
POST
Uploads a new profile image.
DEL
Deletes the profile image of the company with the specified id.
GET
Returns the image of the user with the specified id.
DEL
Deletes the profile image of the user with the specified id.
GET
Returns the image of the workspace with the specified id.
DEL
Deletes the profile image of the workspace with the specified id.
GET
Returns the image of the contactperson with the specified id.
DEL
Deletes the profile image of the contactperson with the specified id.
GET
Returns the image of the project with the specified id.
DEL
Deletes the profile image of the project with the specified id.
GET
Returns the image of the projecttemplate with the specified id.
DEL
Deletes the profile image of the projecttemplate with the specified id.
Custom Fields Overview
Custom Fields
GET
Returns all custom field definitions.
POST
Creates a new custom field definition.
PUT
Updates a custom field selection option for an existing custom field definition.
DEL
Deletes a custom field selection option for an existing custom field definition.
PUT
Updates an existing custom field definition with the specified id.
DEL
Deletes the custom field definition with the specified id.
POST
Sets the custom fields for a task template.
POST
Unlinks a custom field definition from a projectTemplate.
PUT
Updates the order of a custom field definition for a project template.
POST
Links a custom field definition to a project.
POST
Links a custom field definition to a project template.
POST
Creates a custom field selection option for an existing custom field definition.
POST
Unlinks a custom field definition from a project.
GET
Returns all custom field definitions for a project template.
POST
Sets the custom fields for a task.
GET
Returns all custom field definitions for a project.
PUT
Updates the order of a custom field definition for a project.
Workload & Planning Overview
Workload
GET
Returns the users' workloads per day.
Project Templates Overview
Project Templates
GET
Returns the project template with the specified id.
PUT
Updates the project template with the specified id.
DEL
Deletes the project template with the specified id.
GET
Returns all existing project templates.
POST
Creates a new project template.
POST
Updates the order of a project status.
GET
Returns the task bundle id which is linked to the template.
Task Bundles
POST
Creates a new task bundle with the information of the specified task bundle.
GET
Returns the existing recurrency rule for one task template.
GET
Returns all global task bundles.
POST
Creates a new task bundle.
GET
Returns the task bundle with the specified id.
PUT
Updates the task bundle with the specified id.
DEL
Deletes the task bundle with the specified id.
GET
Returns all possible icons for a task bundle.
GET
Returns all task list templates of the task bundle with the specified id.
POST
Creates a new task list template for the task bundle with the specified id.
GET
Returns the task list template of the task bundle with the specified id.
PUT
Updates the task list template for the task bundle with the specified id.
DEL
Deletes the task list template for the task bundle with the specified id.
POST
Updates the order of a task list template in a task bundle.
POST
Adds the task templates to the task list template with the specified id.
POST
Removes the task templates from the task list template with the specified id.
GET
Returns the task template with the specified id in the specified task list template.
GET
Returns the task templates in the specified task list template.
POST
Updates the order of a task template in a task list template.
GET
Returns the checklist item templates for a task template with the specified id.
POST
Creates a checklist item template for a task template with the specified id.
GET
Returns the checklist item template for a task template with the specified id.
PUT
Updates a checklist item template for a task template with the specified id.
DEL
Deletes a checklist item template for a task template with the specified id.
POST
Creates a new task bundle from the specified project.
POST
Creates a new task bundle from the specified task list. Turns the tasks, task list and TaskToTaskLists into templates.
POST
Adds the task bundle to the entity with the specified id.
Task Templates
GET
Returns all task templates of the task bundle with the specified id.
POST
Creates a new task template for the task bundle with the specified id.
GET
Returns the task template of the task bundle with the specified id.
PUT
Updates the task template for the task bundle with the specified id.
DEL
Deletes the task template for the task bundle with the specified id.
GET
Returns the task template with the specified id.
POST
Assigns a list of users to task templates.
Task Dependency Templates
GET
Returns all task dependency templates for a given task bundle.
POST
Creates a task dependency template for two task templates of the given task bundle.
GET
Returns a task dependency template by id for a given task bundle.
DEL
Deletes the task dependency template from the task bundle.
GET
Returns the task dependency templates for a given task template.
Project Template Tags
GET
Returns the tags of the projecttemplate with the specified id.
GET
Returns all tags that are currently in use for the given projecttemplate type.
POST
Removes tag from all entities.
POST
Removes tags from the projecttemplate with the specified id.
POST
Updates a tag to the projecttemplate with the specified id.
POST
Adds a batch of new tags to the projecttemplate with the specified id.
Project Milestone Templates
GET
Returns all milestone templates of the given project template.
POST
Creates a new milestone template for the given project template.
GET
Returns a milestone by id for the given project template.
PUT
Updates a milestone template for the given project template.
DEL
Deletes a milestone for the given project template.
Project Template Automations
GET
Returns all automations for a projecttemplate.
POST
Creates a new automation for a given projecttemplate.
GET
Returns a specific automation for a projecttemplate.
PUT
Updates the automation with the specified id for a given projecttemplate.
DEL
Deletes the specified automation for a given projecttemplate.
POST
Reapplies the automation to all projects of this specific project template.
Project Template Actions
GET
Gets the actions of an automation of a project template.
POST
Creates a new action for an automation of a projecttemplate.
GET
Gets a specific action for an automation of a projecttemplate.
PUT
Updates a specifc action of an automation of a projecttemplate.
DEL
Deletes an action for an automation of a projecttemplate.
POST
Updates the order of a given action.
Login & Access Overview
Accounts
PUT
Updates the account with the specified id.
Invitations
POST
Invites a user to the workspace.
POST
Accepts the invitation with the invitation code.
Permissions
GET
Returns the permissions of the currently logged-in user.
GET
Returns all available features.
GET
Returns all available project features.
Roles
GET
Returns all users of the role with the specified id.
POST
Activates the user with the specified id.
POST
Deactivates the user with the specified id.
GET
Returns all permissions of the role with the specified id.
POST
Creates, updates or deletes a permission of the role with the specified id.
GET
Returns all deactivated menu items for the role with the specified id.
POST
Creates, updates the deactivated menu items for the role with the specified id.
GET
Returns all roles of the workspace.
POST
Creates a new role.
GET
Returns the role with the specified id.
PUT
Updates the role with the specified id.
GET
Returns the role with the specified name.
POST
Deletes the role with the specified id.
POST
Archives or unarchives the role with the specified id.
POST
Adds the user to the Role with the specified id.
POST
Moves a user from their current role to another role.
Teams
GET
Returns all teams.
POST
Creates a new team.
GET
Returns the team with the specified id.
PUT
Updates the team with the specified id.
DEL
Deletes the team with the specified id.
POST
Adds users to a team.
POST
Removes users from a team.
POST
Adds projects to a team.
POST
Removes projects from a team.
Workspaces
GET
Returns the workspace with the specified id.
PUT
Updates the workspace with the specified id.
GET
Returns all available workspace types.
API Management Overview
API Users
POST
Creates a new API user.
PUT
Updates the API user with the specified id.
DEL
Deletes the API user with the specified id.
Webhooks
GET
Returns all configured webhooks.
POST
Creates a new webhook.
GET
Returns the webhook with the specified id.
PUT
Updates the webhook with the specified id.
DEL
Deletes the webhook with the specified id.
GET
Returns all available event types.
GET
Returns all available event types for Slack webhooks.
GET
Returns all logs of the webhook with the specified id.
Client Applications
GET
Returns all client applications.
POST
Registers a new client application.
GET
Returns the client application with the specified id.
PUT
Updates the client application with the specified id.
DEL
Deletes the specified client application.
POST
Generates a new secret for the specified client application.
POST
Generates an API key for the specified client application.
Support
Developer Forum
Login
API Reference
Users
Updates the user with the specified id.
PUT
https://
api.awork.com
/
api
/
v1
/
users
/
:userId
Updates the user with the specified id.
Required Permissions:
The user must be an admin or the creator or have
user-master-data:write
permissions.
Path parameters
userId
string
Required
The id of the user.
Request
This endpoint expects an object.
firstName
string
Optional
The firstname of the user.
lastName
string
Optional
The lastname of the user.
birthDate
datetime
Optional
The birthdate of the user.
gender
string
Optional
The gender of the user.
title
string
Optional
The title of the user.
position
string
Optional
The position of the user.
language
string
Optional
The language preference of the user in ISO 639-1 format.
Response
This endpoint returns an object
firstName
string
Optional
The firstname of the user.
lastName
string
Optional
The lastname of the user.
birthDate
datetime
Optional
The birthdate of the user.
gender
string
Optional
The gender of the user.
title
string
Optional
The title of the user.
position
string
Optional
The position of the user.
language
string
Optional
The language preference of the user in ISO 639-1 format.
id
string
Optional
The id of the user.
status
object
Optional
The status of the user.
Show 2 properties
createdOn
datetime
Optional
The date this user was created.
createdBy
string
Optional
The id of the user who created this user.
updatedOn
datetime
Optional
The date when this user was last updated.
updatedBy
string
Optional
The id of the user who updated the entity.
isArchived
boolean
Optional
Whether this user is archived. Archived users are automatically inactive and only exist for reference purposes.
isDeactivated
boolean
Optional
Whether the user has been deactivated.
deactivatedOn
datetime
Optional
The date the user was deactivated.
hasImage
boolean
Optional
Whether the user has uploaded a profile image.
shouldMigrateToConnect
boolean
Optional
Whether the user should be migrated to Connect.
userContactInfos
list of objects
Optional
The contact information assigned to this user.
Show 17 properties
resourceVersion
long
Optional
The version of the entity, updated on every modification, to the ticks in UTC. Not identical to UpdatedOn.
tags
list of objects
Optional
The tags of this user.
Show 3 properties
teams
list of objects
Optional
The teams the user is associated to.
Show 4 properties
isExternal
boolean
Optional
True if this entity is coming from an external workspace (awork Connect).
Built with