Creates a new API user. (API Explorer) | awork API

API v1 ReferenceProjects
- GETReturns all projects.
- POSTCreates a new project.
- POSTCreates the preconfigured project in the language of the user.
- GETReturns the project with the specified id.
- PUTUpdates the project with the specified id.
- POSTAdds a project member to the project with the specified id.
- POSTChanges the project type of the project with the specified id.
- POSTChanges the status of the project with the specified id.
- POSTDeletes the project with the specified id.
- GETReturns the project members of the project with the specified id.
- POSTRemoves a project member from the project with the specified id.
- POSTUpdates the role of a project member of the project with the specified id.
- POSTUpdates the order of a project status.
API v1 ReferenceProject Types
- GETReturns all existing project types.
- POSTCreates a new project type.
- GETGets all possible icons for project types.
- GETReturns the project type with the specified id.
- PUTUpdates the project type with the specified id.
- POSTDeletes the project type with the specified id.
- POSTArchives or unarchives the project type with the specified id.
API v1 ReferenceProject Statuses
- POSTCreates a new project status for a project.
- GETReturns all project statuses.
- GETReturns the project status with the specified id.
- PUTUpdates the project status with the specified id.
- POSTDeletes the project status with the specified id.
- POSTArchives or unarchives the project status with the specified id.
- POSTCreates a new project status.
API v1 ReferenceProject Roles
- GETReturns all project roles.
- POSTCreates a new project role.
- GETReturns all project roles of a user.
- GETReturns the project role with the specified id.
- PUTUpdates the project role with the specified id.
- POSTDeletes the project role with the specified id.
- GETReturns all permissions of the project role with the specified id.
- POSTCreates, updates or deletes a permission of a project role with the specified id.
API v1 ReferenceProject Comments
- GETReturns all comments of the project with the specified id.
- POSTCreates a new comment on the project with the specified id.
- DELDeletes 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.
- DELDeletes 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.
API v1 ReferenceProject Tags
- POSTRemoves tag from all entities.
- GETReturns all tags that are currently in use for the given project type.
- POSTAdds a batch of new tags to the project with the specified id.
- POSTRemoves tags from the project with the specified id.
- GETReturns the tags of the project with the specified id.
- POSTUpdates a tag to the project with the specified id.
API v1 ReferenceProject Milestones
- GETReturns all project milestones the user is allowed to see.
- POSTCreates a new project milestone.
- GETReturns the specified project milestone.
- PUTUpdates the project milestone with the specified id.
- DELDeletes the project milestone with the specified id.
- GETReturns all project milestones of the specified project.
API v1 ReferenceProject Automations
- GETReturns all automations for a project.
- POSTCreates a new automation for the specified project.
- GETReturns a specific automation from a project.
- PUTUpdates the automation with the specified id.
- DELDeletes the specified automation for a given project.
API v1 ReferenceProject Actions
- GETGets the actions of an automation.
- POSTCreates a new action for an automation.
- GETGets a specific action for an automation.
- PUTUpdates a specifc action of an automation.
- DELDeletes an action for an automation.
- POSTUpdates the order of a given action.
API v1 ReferenceProject Time Bookings
- GETReturns a list of project time bookings.
- POSTCreates a new project time booking for a given project and user.
- PUTUpdates a given project time booking.
- DELDeletes a project time booking by id.
- GETReturns the project time bookings in a specified time range for a list of users.
API v1 ReferenceAutopilot
- 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.
- DELDeletes the autopilot of the project with the specified id.
API v1 ReferenceTasks
- POSTCreates a new task.
- POSTAssigns a new user to a tasks by email invitation.
- POSTChanges the base type for a batch of tasks.
- POSTChanges the lists of tasks.
- POSTChanges statuses of tasks.
- POSTChanges the parent task and the order of subtasks.
- POSTConvert subtasks to a parent task.
- POSTChanges the type of work for a batch of tasks.
- POSTDeletes several tasks.
- POSTSet the priority of the task with the specified id.
- GETReturns the task with the specified id.
- PUTUpdates the task with the specified id.
- POSTCreates a copy of the specified task.
- POSTDeletes a recurrency rule for an existing task.
- GETGets the recurrency rule for the specified task.
- POSTAssigns a list of users to a given task
- POSTModifies a list of planned efforts of a given task.
- POSTTo add or update a recurrency rule for an existing task.
- POSTUpdates the order of the task with the specified id.
API v1 ReferenceTask Lists
- GETReturns all task lists of the project with the specified id.
- POSTCreates a new task list.
- GETReturns the task list with the specified id.
- PUTUpdates the task list with the specified id.
- POSTAdds the tasks to the task list with the specified id.
- POSTChanges the project of the task list with the specified id.
- POSTCreates a copy of the task list.
- POSTDeletes the task list with the specified id.
- POSTRemoves the tasks from the task list with the specified id.
- POSTArchives or unarchives the task list with the specified id.
- GETReturns the task with the specified id in the specified task list.
- POSTUpdates the order of a task in a task list.
- POSTUpdates the order of a task list.
API v1 ReferenceTask Views
- GETReturns all task views that the user subscribed to.
- POSTCreates a new task view and directly subscribes the user to it.
- POSTSubscribes the current user to a shared task view.
- POSTTerminates a subscription of a user to a shared task view.
- GETReturns a single task view from a user.
- PUTUpdates an existing task view.
- DELDeletes an existing task view that is specified by an id.
- GETReturns all the tasks of a task view.
- GETReturns all task views that are shared within the workspace.
- GETReturns a single task view that is shared within the workspace.
API v1 ReferenceProject Tasks
- GETReturns all project tasks that the current user can see.
- GETReturns all tags of the project tasks.
- POSTCreates new task statuses for the specified project.
- GETReturns all project tasks of the project with the specified id.
- GETReturns the project task with the specified id.
- POSTChanges the project of the task with the specified id.
- GETReturns all task statuses of the project with the specified id.
- POSTCreates a new task status for the specified project.
- GETReturns the task status of the project with the specified id.
- PUTUpdates a task status for the specified project.
- POSTDeletes the task status with the specified id.
- GETReturns the type of work for the project with the specified id. .
- GETReturns all task statuses of the project template with the specified id.
- POSTCreates a new task status for the specified project template.
- GETReturns the task status of the project template with the specified id.
- PUTUpdates a task status for the specified project template.
- DELDeletes the task status of the project template with the specified id.
API v1 ReferencePrivate Tasks
- GETReturns all private tasks that a user created and assigned to someone else.
- GETReturns a private tasks that a user created and assigned to someone else.
- GETReturns all private tasks of the user with the specified id.
- GETReturns all tags of the private tasks.
- GETReturns the task statuses for private tasks.
- GETReturns the private task with the specified id.
API v1 ReferenceAssigned Tasks
- GETReturns all tasks the user is allowed to see.
- GETReturns all tasks assigned to the user.
- GETReturns the assigned task with the specified id.
- GETReturns all tags the user is allowed to see. You can filter the tags by task model query constraints.
API v1 ReferenceChecklist Items
- GETReturns the checklist items for a private task with the specified id.
- GETReturns a checklist item for a private task with the specified id.
- GETReturns the checklist for a private task with the specified id.
- GETReturns the checklist items for a project task with the specified id.
- GETReturns a checklist item for a project task with the specified id.
- GETReturns the checklist items for a task with the specified id.
- POSTCreates a checklist item for a task with the specified id.
- POSTConvert all checklist items of the specified task to subtasks.
- GETReturns the checklist item for a task with the specified id.
- PUTUpdates a checklist item for a task with the specified id.
- DELDeletes a checklist item for a task with the specified id.
API v1 ReferenceTask Comments
- GETReturns all comments of the task with the specified id.
- POSTCreates a new comment on the task with the specified id.
- DELDeletes 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.
- DELDeletes 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.
API v1 ReferenceTask Tags
- POSTRemoves tag from all entities.
- GETReturns all tags that are currently in use.
- POSTAdds a batch of new tags to the entity with the specified id.
- POSTRemoves tags from the entity with the specified id.
- GETReturns the tags of the entity with the specified id.
- POSTUpdates a tag to the entity with the specified id.
API v1 ReferenceTask Dependencies
- GETReturns all task dependencies for a specific project.
- POSTCreates a new task dependency.
- DELDeletes a task dependency.
- GETReturns all task dependencies for a specific task.
API v1 ReferenceTask Schedules
- GETReturns a list of task schedules.
- POSTCreates a new task schedule for a given task and a given user.
- POSTCreates task schedules from a task by id.
- GETReturns a task schedule by id.
- PUTUpdates a given task schedule.
- DELDeletes a task schedule by id.
API v1 ReferenceTasks Batch
- POSTEdits multiple tasks using the specified operation.
API v1 ReferenceType of Work
- GETGets all types of work.
- POSTCreates a new type of work.
- GETGets all possible icons for type of work.
- GETGets the type of work with the specified id.
- PUTChanges the properties of an existing type of work.
- POSTDeletes the type of work with the specified id.
- POSTArchives or unarchives the type of work with the specified id.
API v1 ReferenceTime Entries
- GETReturns the last time entry of a specified user.
- GETReturns all time entries of a specified project.
- GETReturns all time entries of a specified task.
- GETReturns all time entries.
- POSTCreates a new time entry.
- POSTEdits multiple time entries using the specified operation.
- POSTDeletes the time entry with the specified ids.
- POSTSets the time entries with the specified ids to to billable.
- POSTSets the time entries with the specified ids to billed.
- POSTSets the type of work of the specified timeentries.
- POSTSets the time entries with the specified ids to to unbillable.
- POSTSets the time entries with the specified ids to unbilled.
- GETRetrieves all time entries with a simplified model based on the grouping parameter.
- GETGet a time entry by id.
- PUTUpdates the time entry with the specified id.
- DELDeletes the time entry with the specified id.
- POSTHandles removing all finished breaks from a time entry.
API v1 ReferenceTime 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.
API v1 ReferenceCompanies
- GETReturns all companies.
- POSTCreates a new company.
- GETReturns all company industries that are currently in use.
- GETReturns the company with the specified id.
- PUTUpdates the company with the specified id.
- GETReturns the contact infos of the company with the specified id.
- POSTCreates a new contact info for the company with the specified id.
- GETReturns the specified contact info of the company with the specified id.
- PUTUpdates the contact info for the company with the specified id.
- DELDeletes the contact info of the company with the specified id.
- POSTDeletes the company with the specified id.
API v1 ReferenceCompany Tags
- POSTRemoves tag from all entities.
- GETReturns all tags that are currently in use.
- POSTAdds a batch of new tags to the company with the specified id.
- POSTRemoves tags from the company with the specified id.
- GETReturns the tags of the companies with the specified id.
- POSTUpdates a tag to the company with the specified id.
API v1 ReferenceUsers
- GETReturns the currently logged-in user and workspace.
- GETReturns all users.
- GETReturns the user with the specified id.
- PUTUpdates the user with the specified id.
- DELDeletes the user with the specified id.
- POSTActivates the user with the specified id.
- GETReturns the contact infos of the user with the specified id.
- POSTCreates a new contact info for the user with the specified id.
- GETReturns the contact info of the user with the specified id.
- PUTUpdates the contact info of the user with the specified id.
- DELDeletes the contact info of the user with the specified id.
- POSTDeactivates the user with the specified id.
- POSTArchives or unarchives the user with the specified id.
API v1 ReferenceUser Capacity
- GETReturns the capacity of the specified user.
- PUTUpdates the capacity of the specified user.
API v1 ReferenceUser Tags
- POSTRemoves tag from all entities.
- GETReturns all tags that are currently in use.
- POSTAdds a batch of new tags to the user with the specified id.
- POSTRemoves tags from the user with the specified id.
- GETReturns the tags of the users with the specified id.
- POSTUpdates a tag to the user with the specified id.
API v1 ReferenceAbsences
- GETReturns all absences.
- POSTCreates a new absence.
- GETReturns the absence with the specified id.
- PUTUpdates the absence with the specified id.
- DELDeletes the absence with the specified id.
API v1 ReferenceAbsence Regions
- GETGets all the absence regions.
- POSTCreates a new absence region.
- GETList of supported countries for absence regions.
- GETList of locations for a country.
- PUTAssign/remove current user to/from an absence region.
- PUTAssign/remove users to an absence region.
- GETGet an absence region by id.
- PUTUpdates an absence region.
- DELDeletes an absence region.
API v1 ReferenceWorkspace Absences
- GETGets all workspace absences.
- POSTCreates a new workspace absence.
- PUTUpdates a workspace absence.
- DELDeletes a workspace absence.
API v1 ReferenceDashboards
- GETReturns the dashboards of the current user.
API v1 ReferenceFiles
- GETReturns the content of the file with the specified id.
- GETReturns the content of the file with the specified id as pdf.
API v1 ReferenceFile Upload
- POSTGenerates a URL to upload a file to.
- POSTCreates a file from an upload id.
API v1 ReferenceProject Files
- GETReturns all files of the project with the specified id.
- POSTEndpoint to batch create external files without uploading.
- POSTCreates a new project file for the project with the specified id..
- DELDeletes the files of the specified project.
- POSTUploads a new file by providing an url.
- GETReturns the file with the specified id of the project with the specified id.
- PUTUpdates the metadata of the project file with the specified id.
- DELDeletes the project file with the specified id.
- POSTChanges the project this file belongs to.
- POSTCopies the file to a new project.
- GETReturns the content of the project file with the specified id.
- GETReturns the content of the file with the specified id as pdf. type or conversion not possible.
- GETReturns a url to share the file.
- GETReturns all file versions of the specified project file.
- POSTUploads a new version of the project file with the specified id.
- GETReturns the project file version with the specified id.
- GETReturns the content of the project file version with the specified id.
API v1 ReferenceTask Files
- POSTEndpoint to batch create external files without uploading.
- GETReturns all files of the task with the specified id.
- POSTCreates a new task file for the task with the specified id..
- DELDeletes the files of the specified task.
- POSTUploads a new file by providing an url.
- GETReturns the file with the specified id of the task with the specified id.
- PUTUpdates the metadata of the task file with the specified id.
- DELDeletes the task file with the specified id.
- POSTChanges the task this file belongs to.
- POSTCopies the file to a new task.
- GETReturns the content of the task file with the specified id.
- GETReturns the content of the file with the specified id as pdf. type or conversion not possible.
- GETReturns a url to share the file.
- GETReturns all file versions of the specified task file.
- POSTUploads a new version of the task file with the specified id.
- GETReturns the task file version with the specified id.
- GETReturns the content of the task file version with the specified id.
API v1 ReferenceCompany Files
- POSTEndpoint to batch create external files without uploading.
- GETReturns all files of the company with the specified id.
- POSTCreates a new company file for the company with the specified id..
- DELDeletes the files of the specified company.
- POSTUploads a new file by providing an url.
- GETReturns the file with the specified id of the company with the specified id.
- PUTUpdates the metadata of the company file with the specified id.
- DELDeletes the company file with the specified id.
- POSTChanges the company this file belongs to.
- POSTCopies the file to a new company.
- GETReturns the content of the company file with the specified id.
- GETReturns the content of the file with the specified id as pdf. type or conversion not possible.
- GETReturns a url to share the file.
- GETReturns all file versions of the specified company file.
- POSTUploads a new version of the company file with the specified id.
- GETReturns the company file version with the specified id.
- GETReturns the content of the company file version with the specified id.
API v1 ReferenceComment Files
- POSTEndpoint to batch create external files without uploading.
- GETReturns all files of the comment with the specified id.
- POSTCreates a new comment file for the comment with the specified id..
- DELDeletes the files of the specified comment.
- POSTUploads a new file by providing an url.
- GETReturns the file with the specified id of the comment with the specified id.
- PUTUpdates the metadata of the comment file with the specified id.
- DELDeletes the comment file with the specified id.
- POSTChanges the comment this file belongs to.
- POSTCopies the file to a new comment.
- GETReturns the content of the comment file with the specified id.
- GETReturns the content of the file with the specified id as pdf. type or conversion not possible.
- GETReturns a url to share the file.
- GETReturns all file versions of the specified comment file.
- POSTUploads a new version of the comment file with the specified id.
- GETReturns the comment file version with the specified id.
- GETReturns the content of the comment file version with the specified id.
API v1 ReferenceUser Files
- POSTEndpoint to batch create external files without uploading.
- GETReturns all files of the user with the specified id.
- POSTCreates a new user file for the user with the specified id..
- DELDeletes the files of the specified user.
- POSTUploads a new file by providing an url.
- GETReturns the file with the specified id of the user with the specified id.
- PUTUpdates the metadata of the user file with the specified id.
- DELDeletes the user file with the specified id.
- POSTChanges the user this file belongs to.
- POSTCopies the file to a new user.
- GETReturns the content of the user file with the specified id.
- GETReturns the content of the file with the specified id as pdf. type or conversion not possible.
- GETReturns a url to share the file.
- GETReturns all file versions of the specified user file.
- POSTUploads a new version of the user file with the specified id.
- GETReturns the user file version with the specified id.
- GETReturns the content of the user file version with the specified id.
API v1 ReferenceWorkspace Files
- POSTEndpoint to batch create external files without uploading.
- GETReturns all files of the workspace with the specified id.
- POSTCreates a new workspace file for the workspace with the specified id..
- DELDeletes the files of the specified workspace.
- POSTUploads a new file by providing an url.
- GETReturns the file with the specified id of the workspace with the specified id.
- PUTUpdates the metadata of the workspace file with the specified id.
- DELDeletes the workspace file with the specified id.
- POSTChanges the workspace this file belongs to.
- POSTCopies the file to a new workspace.
- GETReturns the content of the workspace file with the specified id.
- GETReturns the content of the file with the specified id as pdf. type or conversion not possible.
- GETReturns a url to share the file.
- GETReturns all file versions of the specified workspace file.
- POSTUploads a new version of the workspace file with the specified id.
- GETReturns the workspace file version with the specified id.
- GETReturns the content of the workspace file version with the specified id.
API v1 ReferenceProject Template Files
- POSTEndpoint to batch create external files without uploading.
- GETReturns all files of the projecttemplate with the specified id.
- POSTCreates a new projecttemplate file for the projecttemplate with the specified id..
- DELDeletes the files of the specified projecttemplate.
- POSTUploads a new file by providing an url.
- GETReturns the file with the specified id of the projecttemplate with the specified id.
- PUTUpdates the metadata of the projecttemplate file with the specified id.
- DELDeletes the projecttemplate file with the specified id.
- POSTChanges the projecttemplate this file belongs to.
- POSTCopies the file to a new projecttemplate.
- GETReturns the content of the projecttemplate file with the specified id.
- GETReturns the content of the file with the specified id as pdf. type or conversion not possible.
- GETReturns a url to share the file.
- GETReturns all file versions of the specified projecttemplate file.
- POSTUploads a new version of the projecttemplate file with the specified id.
- GETReturns the projecttemplate file version with the specified id.
- GETReturns the content of the projecttemplate file version with the specified id.
API v1 ReferenceTask Template Files
- POSTEndpoint to batch create external files without uploading.
- GETReturns all files of the tasktemplate with the specified id.
- POSTCreates a new tasktemplate file for the tasktemplate with the specified id..
- DELDeletes the files of the specified tasktemplate.
- POSTUploads a new file by providing an url.
- GETReturns the file with the specified id of the tasktemplate with the specified id.
- PUTUpdates the metadata of the tasktemplate file with the specified id.
- DELDeletes the tasktemplate file with the specified id.
- POSTChanges the tasktemplate this file belongs to.
- POSTCopies the file to a new tasktemplate.
- GETReturns the content of the tasktemplate file with the specified id.
- GETReturns the content of the file with the specified id as pdf. type or conversion not possible.
- GETReturns a url to share the file.
- GETReturns all file versions of the specified tasktemplate file.
- POSTUploads a new version of the tasktemplate file with the specified id.
- GETReturns the tasktemplate file version with the specified id.
- GETReturns the content of the tasktemplate file version with the specified id.
API v1 ReferenceShared Files
- GETReturns the public profile image.
- GETReturns the shared file.
API v1 ReferenceTemporary 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 entity file.
API v1 ReferenceImages
- GETReturns the image of the company with the specified id.
- POSTUploads a new profile image.
- DELDeletes the profile image of the company with the specified id.
- GETReturns the image of the contactperson with the specified id.
- DELDeletes the profile image of the contactperson with the specified id.
- GETReturns the image of the project with the specified id.
- DELDeletes the profile image of the project with the specified id.
- GETReturns the image of the projecttemplate with the specified id.
- DELDeletes the profile image of the projecttemplate with the specified id.
- GETReturns the image of the user with the specified id.
- DELDeletes the profile image of the user with the specified id.
- GETReturns the image of the workspace with the specified id.
- DELDeletes the profile image of the workspace with the specified id.
API v1 ReferenceCustom Fields
- GETReturns all custom field definitions.
- POSTCreates a new custom field definition.
- PUTUpdates an existing custom field definition with the specified id.
- DELDeletes the custom field definition with the specified id.
- POSTCreates a custom field selection option for an existing custom field definition.
- PUTUpdates a custom field selection option for an existing custom field definition.
- DELDeletes a custom field selection option for an existing custom field definition.
- GETReturns all custom field definitions for a project.
- PUTUpdates the order of a custom field definition for a project.
- POSTLinks a custom field definition to a project.
- POSTUnlinks a custom field definition from a project.
- GETReturns all custom field definitions for a project template.
- PUTUpdates the order of a custom field definition for a project template.
- POSTLinks a custom field definition to a project template.
- POSTUnlinks a custom field definition from a projectTemplate.
- POSTSets the custom fields for a task.
- POSTSets the custom fields for a task template.
API v1 ReferenceWorkload
- GETReturns the users' workloads per day.
API v1 ReferenceProject Templates
- GETReturns all existing project templates.
- POSTCreates a new project template.
- GETReturns the project template with the specified id.
- PUTUpdates the project template with the specified id.
- DELDeletes the project template with the specified id.
- GETReturns the task bundle id which is linked to the template.
- POSTUpdates the order of a project status.
API v1 ReferenceTask Bundles
- POSTAdds the task bundle to the entity with the specified id.
- GETReturns all global task bundles.
- POSTCreates a new task bundle.
- POSTCreates a new task bundle from the specified project.
- POSTCreates a new task bundle from the specified task list. Turns the tasks, task list and TaskToTaskLists into templates.
- GETReturns all possible icons for a task bundle.
- GETReturns the task bundle with the specified id.
- PUTUpdates the task bundle with the specified id.
- DELDeletes the task bundle with the specified id.
- POSTCreates a new task bundle with the information of the specified task bundle.
- GETReturns all task list templates of the task bundle with the specified id.
- POSTCreates a new task list template for the task bundle with the specified id.
- GETReturns the task list template of the task bundle with the specified id.
- PUTUpdates the task list template for the task bundle with the specified id.
- DELDeletes the task list template for the task bundle with the specified id.
- POSTAdds the task templates to the task list template with the specified id.
- POSTRemoves the task templates from the task list template with the specified id.
- GETReturns the task templates in the specified task list template.
- GETReturns the task template with the specified id in the specified task list template.
- POSTUpdates the order of a task template in a task list template.
- POSTUpdates the order of a task list template in a task bundle.
- GETReturns the checklist item templates for a task template with the specified id.
- POSTCreates a checklist item template for a task template with the specified id.
- GETReturns the checklist item template for a task template with the specified id.
- PUTUpdates a checklist item template for a task template with the specified id.
- DELDeletes a checklist item template for a task template with the specified id.
- GETReturns the existing recurrency rule for one task template.
API v1 ReferenceTask Templates
- GETReturns all task templates of the task bundle with the specified id.
- POSTCreates a new task template for the task bundle with the specified id.
- GETReturns the task template of the task bundle with the specified id.
- PUTUpdates the task template for the task bundle with the specified id.
- DELDeletes the task template for the task bundle with the specified id.
- POSTAssigns a list of users to task templates.
- GETReturns the task template with the specified id.
API v1 ReferenceTask Dependency Templates
- GETReturns all task dependency templates for a given task bundle.
- POSTCreates a task dependency template for two task templates of the given task bundle.
- GETReturns a task dependency template by id for a given task bundle.
- DELDeletes the task dependency template from the task bundle.
- GETReturns the task dependency templates for a given task template.
API v1 ReferenceProject Template Tags
- POSTRemoves tag from all entities.
- GETReturns all tags that are currently in use for the given projecttemplate type.
- POSTAdds a batch of new tags to the projecttemplate with the specified id.
- POSTRemoves tags from the projecttemplate with the specified id.
- GETReturns the tags of the projecttemplate with the specified id.
- POSTUpdates a tag to the projecttemplate with the specified id.
API v1 ReferenceProject Milestone Templates
- GETReturns all milestone templates of the given project template.
- POSTCreates a new milestone template for the given project template.
- GETReturns a milestone by id for the given project template.
- PUTUpdates a milestone template for the given project template.
- DELDeletes a milestone for the given project template.
API v1 ReferenceProject Template Automations
- GETReturns all automations for a projecttemplate.
- POSTCreates a new automation for a given projecttemplate.
- GETReturns a specific automation for a projecttemplate.
- PUTUpdates the automation with the specified id for a given projecttemplate.
- DELDeletes the specified automation for a given projecttemplate.
- POSTReapplies the automation to all projects of this specific project template.
API v1 ReferenceProject Template Actions
- GETGets the actions of an automation of a project template.
- POSTCreates a new action for an automation of a projecttemplate.
- GETGets a specific action for an automation of a projecttemplate.
- PUTUpdates a specifc action of an automation of a projecttemplate.
- DELDeletes an action for an automation of a projecttemplate.
- POSTUpdates the order of a given action.
API v1 ReferenceAccounts
- PUTUpdates the account with the specified id.
API v1 ReferenceInvitations
- POSTInvites a user to the workspace.
- POSTAccepts the invitation with the invitation code.
API v1 ReferencePermissions
- GETReturns the permissions of the currently logged-in user.
- GETReturns all available features.
- GETReturns all available project features.
API v1 ReferenceRoles
- GETReturns all roles of the workspace.
- POSTCreates a new role.
- POSTMoves a user from their current role to another role.
- GETReturns the role with the specified id.
- PUTUpdates the role with the specified id.
- POSTAdds the user to the Role with the specified id.
- GETReturns all deactivated menu items for the role with the specified id.
- POSTCreates, updates the deactivated menu items for the role with the specified id.
- POSTDeletes the role with the specified id.
- GETReturns all permissions of the role with the specified id.
- POSTCreates, updates or deletes a permission of the role with the specified id.
- POSTArchives or unarchives the role with the specified id.
- GETReturns all users of the role with the specified id.
- POSTActivates the user with the specified id.
- POSTDeactivates the user with the specified id.
- GETReturns the role with the specified name.
API v1 ReferenceTeams
- GETReturns all teams.
- POSTCreates a new team.
- GETReturns the team with the specified id.
- PUTUpdates the team with the specified id.
- DELDeletes the team with the specified id.
- POSTAdds projects to a team.
- POSTAdds users to a team.
- POSTRemoves projects from a team.
- POSTRemoves users from a team.
API v1 ReferenceWorkspaces
- GETReturns all available workspace types.
- GETReturns the workspace with the specified id.
- PUTUpdates the workspace with the specified id.
API v1 ReferenceAPI Users
- GETReturns all API users.
- POSTCreates a new API user.
- GETReturns the API user with the specified id.
- PUTUpdates the API user with the specified id.
- DELDeletes the API user with the specified id.
API v1 ReferenceWebhooks
- 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.
- DELDeletes the webhook with the specified id.
- GETReturns all logs of the webhook with the specified id.
API v1 ReferenceClient Applications
- GETReturns all client applications.
- POSTRegisters a new client application.
- GETReturns the client application with the specified id.
- PUTUpdates the client application with the specified id.
- DELDeletes the specified client application.
- POSTGenerates an API key for the specified client application.
- POSTGenerates a new secret for the specified client application.
API v2 ReferenceTime 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.
API v2 ReferenceTime Entries
- GETReturns the last time entry of a specified user.
- GETReturns all time entries of a specified project.
- GETReturns all time entries of a specified task.
- GETReturns all time entries.
- POSTCreates a new time entry.
- GETRetrieves all time entries with a simplified model based on the grouping parameter.
- GETGet a time entry by id.
- PUTUpdates the time entry with the specified id.
- POSTHandles removing all finished breaks from a time entry.

POSThttps://api.awork.com/api/v1/apiusers

Body Parameters

namestringRequired>=1 character
roleIdUUID or null
clientIdstring or null

Request

$ curl -X POST https://api.awork.com/api/v1/apiusers \
>      -H "Authorization: Bearer " \
>      -H "Content-Type: application/json" \
>      -d '{
>   "name": "awork Connector",
>   "roleId": "123e4567-e89b-12d3-a456-426614174000",
>   "clientId": "awork-connector"
> }'

Response

$	curl -X POST https://api.awork.com/api/v1/apiusers \
>	-H "Authorization: Bearer " \
>	-H "Content-Type: application/json" \
>	-d '{
>	"name": "awork Connector",
>	"roleId": "123e4567-e89b-12d3-a456-426614174000",
>	"clientId": "awork-connector"
>	}'