Documentation

Global

Type Definitions

Object

# AbsenceCreateModel

Properties:
Name Type Description
userId String The id of the user that created the absence.
startOn String The start time of the absence.
endOn String The end time of the absence.

View Source endpoints/Absences.js, line 44

AbsenceCreateModel

# AbsenceUpdateModel

View Source endpoints/Absences.js, line 62

Object

# ActionCreateModel

Properties:
Name Type Attributes Description
type String The type of the action.
order Number <optional>
 The order of the action.
values Array.<ActionValue> All action values.

View Source endpoints/ProjectActions.js, line 53

Object

# ActionCreateModel

Properties:
Name Type Attributes Description
type String The type of the action.
order Number <optional>
 The order of the action.
values Array.<ActionValue> All action values.

View Source endpoints/ProjectTemplateActions.js, line 53

ActionCreateModel

# ActionUpdateModel

View Source endpoints/ProjectActions.js, line 71

ActionCreateModel

# ActionUpdateModel

View Source endpoints/ProjectTemplateActions.js, line 71

Object

# ActionValue

Properties:
Name Type Description
name String The name of the action value.
value Object The value of the action value.

View Source endpoints/ProjectActions.js, line 47

Object

# ActionValue

Properties:
Name Type Description
name String The name of the action value.
value Object The value of the action value.

View Source endpoints/ProjectTemplateActions.js, line 47

Object

# ActionValue

Properties:
Name Type Description
name String The name of the action value.
value String The value of the action value.

View Source model/Action.js, line 76

'work' | 'home' | 'other'

# AddressSubType

View Source endpoints/UserContactInfos.js, line 54

'central' | 'invoice' | 'other'

# AddressSubType

View Source model/CompanyContactInfo.js, line 63

'work' | 'home' | 'other'

# AddressSubType

View Source model/UserContactInfo.js, line 63

Object

# AddTaskModel

Properties:
Name Type Description
taskId String The task id added to the list.
order Number The order of the task in the list.

View Source endpoints/TaskLists.js, line 129

Object

# AlertObject

Properties:
Name Type Description
id String The id of the alert.
alert String The alert indicartor.
enabled Boolean Whether the alert is enabled.
channel String The channel of the alert.

View Source endpoints/Autopilots.js, line 42

Object

# AlertObject

Properties:
Name Type Description
id String The id of the alert.
alert String The alert indicartor.
enabled Boolean Whether the alert is enabled.
channel String The channel of the alert.

View Source model/Autopilot.js, line 44

Object

# ApiUsersCreateModel

Properties:
Name Type Description
name String The name of the API user.
roleId String The role the user should be in. If no role is specified, the user will become an admin.
clientId String The client id this API user belongs to.

View Source endpoints/ApiUsers.js, line 21

Object

# ApiUsersUpdateModel

Properties:
Name Type Description
name String The name of the API user.
roleId String The role the user should be in. If no role is specified, the user will become an admin.

View Source endpoints/ApiUsers.js, line 39

Object

# Assignee

Properties:
Name Type Description
id String uuid
firstName String nullable
lastName String nullable
hasImage Boolean
key String nullable
tags Array.<AssigneeTagsObject> The Tags of the user.
teams Array.<{id: String}> The ids of the team the user is associated to. / /** The list assigned users of this task, or empty if not user was assigned.

View Source model/Task.js, line 180

Object

# AssigneeObject

Properties:
Name Type Description
id String uuid
firstName String nullable
lastName String nullable
hasImage Boolean
key String nullable

View Source model/TimeEntry.js, line 709

Object

# AssigneeTagsObject

Properties:
Name Type Description
id String
name String nullable
color Color nullable
entityId String

View Source model/Task.js, line 172

Object

# AssignUserByEmailModel

Properties:
Name Type Description
taskId String The id of the task.
email String The emial of the new user.
firstName String The first name of the user to be invited.
lastName String The last name of the user to be invited.
gender String The gender of the user to be invited.
roleId String The id of the role to which the new user should be added.

View Source endpoints/Tasks.js, line 103

Object

# AutomationCreateModel

Properties:
Name Type Description
type String The type of the trigger.
values Array.<{name: String, value: {description: String}}>

View Source endpoints/ProjectAutomations.js, line 46

Object

# AutomationCreateModel

Properties:
Name Type Description
type String The type of the trigger.
values Array.<{name: String, value: {description: String}}>

View Source endpoints/ProjectTemplateAutomations.js, line 46

Object

# AutomationUpdateModel

Properties:
Name Type Description
enabled Boolean Whether the automation is enabled.
trigger Object

View Source endpoints/ProjectAutomations.js, line 63

Object

# AutomationUpdateModel

Properties:
Name Type Description
enabled Boolean Whether the automation is enabled.
trigger Object

View Source endpoints/ProjectTemplateAutomations.js, line 63

Object

# AutopilotCreateModel

Properties:
Name Type Description
type String The type of the autopilot.
alerts Array.<AlertObject> The alerts of the autopilot.

View Source endpoints/Autopilots.js, line 50

Object

# AutopilotUpdateModel

Properties:
Name Type Description
type String The type of the autopilot.
alerts Array.<AlertObject> The alerts of the autopilot.
enabled Boolean Whether the autopilot is enabled.

View Source endpoints/Autopilots.js, line 67

Object

# AworkAuth

Properties:
Name Type Description
type 'oauth' | 'api' the type of awork auth
accessToken String the access token
refreshToken String the refresh token

View Source oauth/OAuthServer.js, line 18

Object

# BatchAssignUsersModel

Properties:
Name Type Description
removeOldAssignments Boolean Whether to keep existing assignment or replace them. Default = true
userIds Array List of user ids to assign to the tasks.
taskIds Array List of task ids to assign the users to.

View Source endpoints/Tasks.js, line 262

Object

# ChangeBaseTypesModel

Properties:
Name Type Description
baseType 'private' | 'projecttask' The type the tasks should be migrated to.
entityId 'projecttask' | 'private' The id of the entity.
taskIds Array.<String> The list of task ids.

View Source endpoints/Tasks.js, line 184

Object

# ChangeProjectModel

Properties:
Name Type Description
projectId String The id of the project the task is assigned to.
taskStatusId String The id of the new status the task is assigned to.

View Source endpoints/ProjectTasks.js, line 60

Object

# ChangeTaskPriorityModel

Properties:
Name Type Description
taskId String The id of the task.
isPrio Boolean Priority flag of the task.

View Source endpoints/Tasks.js, line 200

Object

# ChangeWorkTypesModel

Properties:
Name Type Attributes Description
typeOfWorkId String The id of the task type.
changeTimeEntries Boolean <optional>
 Whether the related time entries should be moved to the same type of work.
The Array.<String> list of task ids.

View Source endpoints/Tasks.js, line 167

Object

# ClientCreateModel

The client application is required for the OAuth flow.
Properties:
Name Type Description
clientId String The client application's identifier.
displayName String The client application's display name.
redirectUris Array.<String> The redirect URIs.

View Source endpoints/ClientApplications.js, line 44

Object

# ClientUpdateModel

The model to update a client application.
Properties:
Name Type Description
displayName String The client application's display name.
redirectUris Array.<String> The redirect URIs.

View Source endpoints/ClientApplications.js, line 62

'red' | 'coral' | 'yellow' | 'green' | 'teal' | 'arctic' | 'blue' | 'azure' | 'purple' | 'violet'

# Color

Colors supported by awork.

View Source globalTypedef.js, line 17

'red' | 'coral' | 'yellow' | 'green' | 'teal' | 'arctic' | 'blue' | 'azure' | 'purple' | 'violet'

# Color

Colors supported by awork.

View Source index.js, line 59

Object

# CommentCreateModel

Properties:
Name Type Attributes Description
message String The message of the comment.
userId String <optional>
 The id of the user who created the comment.
previews Array.<String> The preview URLs to show a preview for.

View Source endpoints/EntityComments.js, line 49

CommentCreateModel

# CommentUpdateModel

View Source endpoints/EntityComments.js, line 75

Object

# CompaniesCreateModel

Properties:
Name Type Attributes Description
name String The company name.
description String <optional>
 The company description.
industry String <optional>
 The company´s industry.

View Source endpoints/Companies.js, line 46

CompaniesCreateModel

# CompaniesUpdateModel

View Source endpoints/Companies.js, line 64

Object

# CompanyObject

Properties:
Name Type Description
id String uuid
name String nullable
hasImage Boolean
description String nullable

View Source model/TimeEntry.js, line 842

Object

# CompanyTags

Properties:
Name Type Description
id String uuid
name String nullable
color Color nullable
entityId String uuid
createdOn String date-time
createdBy String uuid
updatedOn String date-time
updatedBy String uuid

View Source model/Company.js, line 122

Object

# DeleteCompanyOptions

Properties:
Name Type Description
moveToCompany String Moves all related objects to this company. Related projects and tasks (including their time entries) will be connected to this company. Have to set if 'DeleteOperation' contains 'move'.
deleteOperation 'move' | 'delete-all-without-timeentries' Defines the operation to delete a company. Possible operations are 'move': Move related objects to another company. 'delete-only-company': Delete only the company. Related objects loose the company information. 'delete-all-without-timeentries': Delete all related objects apart from time entries. 'delete-all': Delete all.

View Source endpoints/Companies.js, line 80

Object

# DeleteProjectOptions

Properties:
Name Type Attributes Description
deleteTimeTrackings Boolean <optional>
 Set to true to delete also the related time trackings. If it is set to false the related time trackings are still there, but the project and task reference will be cleared. That will also happen if no request body is present.

View Source endpoints/Projects.js, line 107

Object

# DownloadOptions

Properties:
Name Type Attributes Description
width Number <optional>
 Set width to resize.
height Number <optional>
 Set height to resize.
crop Boolean <optional>
 Whether to crop the image when resizing it.

View Source endpoints/EntityFiles.js, line 160

Object

# DownloadOptions

Properties:
Name Type Attributes Description
width Number <optional>
 Set width to resize.
height Number <optional>
 Set height to resize.
crop Boolean <optional>
 Whether to crop the image when resizing it.

View Source endpoints/EntityImages.js, line 29

'work' | 'private' | 'other'

# EmailSubType

View Source endpoints/UserContactInfos.js, line 50

'central' | 'invoice' | 'other'

# EmailSubType

View Source model/CompanyContactInfo.js, line 59

'work' | 'private' | 'other'

# EmailSubType

View Source model/UserContactInfo.js, line 59

Object

# EntityFileUpdateModel

Properties:
Name Type Attributes Description
name String <optional>
 The user-specified name of the file.
description String <optional>
 The description of the file.

View Source endpoints/EntityFiles.js, line 85

Object

# ExternalFileForm

Properties:
Name Type Attributes Description
name String The name of the file.
description String <optional>
 The description of the file.
externalProvider String The external provider for the file. Like 'google' or 'onedrive'.
externalFileUrl String The url of the external provider.
mimeType String <optional>
 The mime type of the external file.

View Source endpoints/EntityFiles.js, line 121

Object

# Failed

Properties:
Name Type Description
code String nullable
description String nullable
link String nullable
stackTrace String nullable
space String nullable
details Array.<String> nullable
validationErrors Array.<{property: String, message: String}> nullable

View Source model/Automation.js, line 129

Object

# FileByUrlModel

Properties:
Name Type Attributes Description
url String The public URL to the file.
name String The name of the file.
description String <optional>
 The description of the file.

View Source endpoints/EntityFiles.js, line 142

Object

# FileDownloadOptions

Properties:
Name Type Attributes Description
width Number <optional>
 Set width to resize.
height Number <optional>
 Set height to resize.
crop Boolean <optional>
 Whether to crop the image when resizing it.
inline Boolean <optional>
 If inline is false, content-disposition header is attachment.

View Source endpoints/Files.js, line 19

Object

# FileMetaData

Properties:
Name Type Attributes Description
name String <optional>
 The user-specified name of the file.
filename String <optional>
 The name of the file.

View Source endpoints/EntityFiles.js, line 58

Object

# FileMetaData

Properties:
Name Type Attributes Description
name String <optional>
 The user-specified name of the file.
filename String <optional>
 The name of the file.

View Source endpoints/EntityImages.js, line 46

Object

# FileMetaData

Properties:
Name Type Attributes Description
name String <optional>
 The user-specified name of the file.
filename String <optional>
 The name of the file.

View Source endpoints/FileVersions.js, line 50

Object

# FileMetaData

Properties:
Name Type Attributes Description
name String <optional>
 The user-specified name of the temporary file.
filename String <optional>
 The name of the temporary file.

View Source endpoints/TemporaryFiles.js, line 45

Object

# FilterQuery

View Source globalTypedef.js, line 1

Object

# FilterQuery

View Source index.js, line 44

'attach_money' | 'poll' | 'golf_course' | 'all_inclusive' | 'portrait' | 'timeline' | 'transform' | 'description' | 'folder' | 'computer' | 'web' | 'phone_iphone' | 'cloud' | 'local_movies' | 'shopping_cart' | 'brush' | 'image' | 'camera_alt' | 'movie_creation' | 'public' | 'whatshot' | 'extension' | 'explore' | 'lock' | 'settings' | 'stars' | 'store' | 'school' | 'local_bar' | 'question_answer' | 'favorite' | 'work' | 'flight_takeoff' | 'map' | 'local_dining'

# Icon

Possible awork icons.

View Source globalTypedef.js, line 13

'attach_money' | 'poll' | 'golf_course' | 'all_inclusive' | 'portrait' | 'timeline' | 'transform' | 'description' | 'folder' | 'computer' | 'web' | 'phone_iphone' | 'cloud' | 'local_movies' | 'shopping_cart' | 'brush' | 'image' | 'camera_alt' | 'movie_creation' | 'public' | 'whatshot' | 'extension' | 'explore' | 'lock' | 'settings' | 'stars' | 'store' | 'school' | 'local_bar' | 'question_answer' | 'favorite' | 'work' | 'flight_takeoff' | 'map' | 'local_dining'

# Icon

Possible awork icons.

View Source index.js, line 55

Object

# LinkedEntity

The model to change the entity information of the file.
Properties:
Name Type Description
entityId String The id of the entity the file should be linked to.
entityType String The type of the linked entity.

View Source endpoints/EntityFiles.js, line 188

Object

# LinkedEntity

The model to change the entity information of the file.
Properties:
Name Type Description
entityId String The id of the entity the file should be linked to.
entityType String The type of the linked entity.

View Source endpoints/TemporaryFiles.js, line 102

Object

# ListOptions

Properties:
Name Type Attributes Description
page Number <optional>
 The current page number
pageSize Number <optional>
 How many items should be returned on each page. Maximum of 1000.
filterBy FilterQuery | String <optional>
 Filter String or FilterQuery

View Source globalTypedef.js, line 6

Object

# ListOptions

Properties:
Name Type Attributes Description
page Number <optional>
 The current page number
pageSize Number <optional>
 How many items should be returned on each page. Maximum of 1000.
filterBy FilterQuery | String <optional>
 Filter String or FilterQuery

View Source index.js, line 48

Object

# ListsObject

Properties:
Name Type Description
name String The name of the list.
order Number The order of the list.
id String The id of the task list.
isArchived Boolean Whether the task list has been archived.
createdOn String The date this task list was created.
createdBy String The id of the user who created this task list.
updatedOn String The date this task list was last modified.
updatedBy String The id of the user who last modified this task list.
orderOfTask Number The order of the task in the list.

View Source model/Task.js, line 232

Object

# LocationObject

Properties:
Name Type Description
longitude Number The logitude value of the geo-location.
latitude Number The latitude value of the geo-location.

View Source endpoints/TimeEntries.js, line 41

Object

# LocationObject

Properties:
Name Type Description
longitude Number The logitude value of the geo-location.
latitude Number The latitude value of the geo-location.

View Source endpoints/TimeTrackings.js, line 24

Object

# MemberProperties

Properties:
Name Type Description
id String uuid
userId String uuid
firstName String nullable
lastName String nullable
hasImage Boolean nullable
projectRoleId String uuid
projectRoleName String nullable
isResponsible Boolean uuid
isDeactivated Boolean uuid
projectId String uuid

View Source model/Project.js, line 330

Object

# MentionsUsersObject

Properties:
Name Type Description
id String uuid
fistName String nullable
lastName String nullable
hasImage Boolean
key String nullable

View Source model/Comment.js, line 212

'skype' | 'whatsapp' | 'other'

# MessengerSubType

View Source endpoints/UserContactInfos.js, line 62

'skype' | 'whatsapp' | 'other'

# MessengerSubType

View Source model/UserContactInfo.js, line 71

'work' | 'mobile' | 'home' | 'work Fax' | 'fax' | 'other'

# PhoneSubType

View Source endpoints/UserContactInfos.js, line 46

'central' | 'other'

# PhoneSubType

View Source model/CompanyContactInfo.js, line 55

'work' | 'mobile' | 'home' | 'work Fax' | 'fax' | 'other'

# PhoneSubType

View Source model/UserContactInfo.js, line 55

Object

# ProjectCreateModel

Properties:
Name Type Attributes Description
name String The name of the Project
description String <optional>
 The project description.
startDate String <optional>
 The start date of the project.
dueDate String <optional>
 The due date of the project.
companyId String <optional>
 The id of the company.
timeBudget Number <optional>
 The time budget the project has in seconds.
isBillableByDefault Boolean <optional>
 Whether project times should be billable by default.
projectTypeId String <optional>
 The id of the project type of this project.
projectStatusId String <optional>
 The id of the project status.
projectTemplateId String <optional>
 The id of the template which is used to create the project.

View Source endpoints/Projects.js, line 58

Object

# ProjectMemberCreateModel

The model to add the project member.
Properties:
Name Type Description
userId String The id of the member. Required.
projectRoleId String The id of the project role for this member. Required.
isResponsible Boolean Whether the user should be marked as responsible. Required.

View Source endpoints/ProjectMembers.js, line 46

Object

# ProjectMemberUpdateModel

The model to update the project member.
Properties:
Name Type Description
projectRoleId String The id of the project role for this member. Required.
isResponsible Boolean Whether the user should be marked as responsible. Required.

View Source endpoints/ProjectMembers.js, line 69

Object

# ProjectMilestoneCreateModel

Properties:
Name Type Description
name String The name of the milestone.
color String The color of the milestone.
dueDate String The date the milestone is due.
projectId String The id of the project the milestone is related to.

View Source endpoints/ProjectMilestones.js, line 32

Object

# ProjectMilestoneUpdateModel

Properties:
Name Type Description
name String The name of the milestone.
color String The color of the milestone.
dueDate String The date the milestone is due.

View Source endpoints/ProjectMilestones.js, line 52

Object

# ProjectObject

Properties:
Name Type Description
id String uuid
name String nullable
key String The unique key of the project
projectStatus Object
company Object The Tags of the company.
hasImage Object Whether the project has an image.

View Source model/Task.js, line 207

Object

# ProjectObject

Properties:
Name Type Description
id String uuid
name String nullable
key String nullable
projectStatus Object
company Object
projectType Object
tags Array.<{id: String, name: String, color: Color, entityId: String}>
teams Array.<{id: String}>

View Source model/TimeEntry.js, line 725

Object

# ProjectRoleCreateModel

The model used to create a project role.
Properties:
Name Type Attributes Description
name String The name of the project role. Required.
isDefault Boolean <optional>
 Whether to use this role as default when adding new project members.
defaultProjectRoleId String <optional>
 The id of the new default project role. Required if the updated project role is the current default role.

View Source endpoints/ProjectRoles.js, line 45

ProjectRoleCreateModel

# ProjectRoleUpdateModel

View Source endpoints/ProjectRoles.js, line 63

Object

# ProjectStatusCreateModel

Properties:
Name Type Description
name String The name of the project status. Required.
type 'progress' | 'not-started' | 'closed' | 'stuck' Specifies the general type of this project status. Required.

View Source endpoints/ProjectProjectStatuses.js, line 22

Object

# ProjectStatusCreateModel

Properties:
Name Type Description
name String The name of the project status. Required.
type 'progress' | 'not-started' | 'closed' | 'stuck' Specifies the general type of this project status. Required.

View Source endpoints/ProjectTemplateProjectStatuses.js, line 22

Object

# projectStatusObject

Properties:
Name Type Description
id String The project statuses of the template.
name String The name of the project status.
type String The general type of this project status.
order Integer int36
createdOn String The date this entity was created.
createdBy String The id of the user who created this entity.
updatedOn String The date this entity was last modified.
projectTemplateId String The project template of the status.
projectId String The id of the project the status belongs to.
updatedBy String The id of the user who last modified this entity.

View Source model/ProjectTemplate.js, line 95

Object

# ProjectStatusObject

Properties:
Name Type Description
id String uuid
name String nullable
description String nullable
type String nullable
isArchived Boolean

View Source model/TimeEntry.js, line 826

Object

# ProjectStatusOrder

Properties:
Name Type Description
projectStatusId String The id of the project status.
order Integer The order value which determines the position of the project status in the flow of the project type. Only accepts 0 and positive values. For independent statuses without successor and predecessor this value is set to null.

View Source endpoints/ProjectTemplates.js, line 93

Object

# ProjectTagsObject

Properties:
Name Type Description
id String uuid
name String nullable
color Color nullable
entityId String uuid

View Source model/TimeEntry.js, line 868

Object

# ProjectTeamPair

Properties:
Name Type Description
projectId String The id of the project.
teamId String The id of the team.

View Source endpoints/Teams.js, line 121

Object

# ProjectTemplateCreateModel

Properties:
Name Type Description
description String Description of the project template.
name String Name of the project template.
isBillableByDefault Boolean
defaultTaskListIdForEmails String uuid

View Source endpoints/ProjectTemplates.js, line 49

ProjectTemplateCreateModel

# ProjectTemplateUpdateModel

View Source endpoints/ProjectTemplates.js, line 68

Object

# ProjectTypeCreateModel

The model to change the project type.
Properties:
Name Type Attributes Description
name String <optional>
 The names of the project type.
description String <optional>
 A short description of the project type.
icon Icon <optional>
 The identifier of the project type icon.

View Source endpoints/ProjectTypes.js, line 49

TaskTypeObject

# ProjectTypeObject

View Source model/TimeEntry.js, line 857

ProjectTypeCreateModel

# ProjectTypeUpdateModel

View Source endpoints/ProjectTypes.js, line 67

Object

# ProjectUpdateModel

Properties:
Name Type Attributes Description
name String <optional>
 The name of the Project
description String <optional>
 The project description.
startDate String <optional>
 The start date of the project.
dueDate String <optional>
 The due date of the project.
companyId String <optional>
 The id of the company.
timeBudget Number <optional>
 The time budget the project has in seconds.
isBillableByDefault Boolean <optional>
 Whether project times should be billable by default.

View Source endpoints/Projects.js, line 83

Object

# ReactionsObject

Properties:
Name Type Description
userIds Array.<String> All users ids that reacted with the emoji.
emoji String The moji used as a reaction.

View Source model/Comment.js, line 237

Object

# ReactionsUpdateModel

Properties:
Name Type Description
emoji String The reaction as emoji.
operation String The operation as add or remove.

View Source endpoints/EntityComments.js, line 100

Object

# Recurrency

Properties:
Name Type Attributes Description
recurrencyRule String
recurrencyInterval Number <optional>
relativeDueOn Number <optional>
 The relative due date and time of the task created from this recurrence rule, in seconds, from the moment of creating the task by a recurrence rule.
recurrencyStartOn String DateTime when recurring task creation will start, considering the set Recurrency Rule and Recurrency Interval.

View Source endpoints/TaskTemplates.js, line 19

Object

# SetTypeOfWorkModel

Properties:
Name Type Attributes Description
ids Array.<String> <optional>
 The ids of the time entries, for which the type of work should be set.
typeOfWorkId String The type of work id, to which the time entries should be set to.

View Source endpoints/TimeEntries.js, line 148

Object

# ShowArchived

Properties:
Name Type Description
showArchived Boolean Include archived project types in the results. Optional. False by default.

View Source endpoints/ProjectTypes.js, line 33

'facebook' | 'twitter' | 'xing' | 'linkedIn' | 'instagram' | 'pinterest' | 'other'

# SocialSubType

View Source endpoints/UserContactInfos.js, line 66

'facebook' | 'twitter' | 'xing' | 'linkedIn' | 'instagram' | 'pinterest' | 'other'

# SocialSubType

View Source model/UserContactInfo.js, line 75

Object

# StatusChangeModel

Properties:
Name Type Attributes Description
taskId String The id of the task.
statusId String The id of the task status.
order Number <optional>
 The order of the status int the new task status. The task is appended to the end if the Order is not set

View Source endpoints/Tasks.js, line 139

Object

# SubTaskCreateModel

Properties:
Name Type Description
isDone Boolean Whether the check list item is done.
name String The name of the check list item.
order Number The order of the check list item.

View Source endpoints/SubTasks.js, line 48

Object

# SubTaskTemplateCreateModel

Properties:
Name Type Description
name String The name of the subtask template.
order Number The order of the subtask template.

View Source endpoints/TaskTemplateSubTaskTemplates.js, line 44

SubTaskTemplateCreateModel

# SubTaskTemplateUpdateModel

View Source endpoints/TaskTemplateSubTaskTemplates.js, line 61

SubTaskCreateModel

# SubTaskUpdateModel

View Source endpoints/SubTasks.js, line 66

Object

# TagObject

Properties:
Name Type Description
id String uuid
name String nullable
color Color nullable
entityId String uuid
createdOn String date-time
createdBy String uuid
updatedOn String date-time
updatedBy String uuid

View Source model/Project.js, line 287

Object

# TagObject

Properties:
Name Type Description
id String uuid
name String nullable
color Color nullable
entityId String uuid

View Source model/TimeReport.js, line 238

Object

# TagsListObject

Properties:
Name Type Description
id String uuid
name String nullable
color Color nullable
entityId String uuid
createdOn String date-time
createdBy String uuid
updatedOn String date-time
updatedBy String uuid

View Source model/Task.js, line 261

Object

# TagsModel

Properties:
Name Type Attributes Description
name String maxLength: 40
color Color <optional>
 nullable

View Source endpoints/EntityTags.js, line 45

Object

# TaskBundleAddToProjectModel

Properties:
Name Type Description
taskBundleId String The id of the task bundle to add to the entity.
projectTemplateId String The id of the project template to get the task bundle from.
defaultTaskListIdForEmails String nullable

View Source endpoints/Projects.js, line 124

Object

# TaskBundleCreateModel

Properties:
Name Type Description
name String The name of the task bundle. Required if its not related to a task bundle.
description String The description of the task bundle.
icon Icon The icon of the task bundle.
projectTemplateId String The project template id of the task bundle, only necessary for the creation of an empty bundle for a project template.

View Source endpoints/TaskBundles.js, line 105

Object

# TaskBundleModel

Properties:
Name Type Attributes Description
name String The name of the task bundle. Required if its not related to a task bundle.
description String The description of the task bundle.
icon Icon <optional>
 The icon of the task bundle.
projectTemplateId String The project template id of the task bundle, only necessary for the creation of an empty bundle for a project template.

View Source endpoints/TaskBundles.js, line 45

Object

# TaskCreateModel

Properties:
Name Type Attributes Description
name String The name of the task.
description String <optional>
 The description of the task.
isPrio Boolean <optional>
 Whether this task is marked as priority.
startOn String <optional>
 The expected start date and time of the task.
dueOn String <optional>
 The expected due date and time of the task.
laneOrder Integer <optional>
 The lane order defines the vertical position in the gant planner.
plannedDuration Integer <optional>
 The expected planned workload of the task, in seconds.
remainingDuration Integer <optional>
 The expected remaining duration from the original planned effort of the task, in seconds.
typeOfWorkId String The id of the type of work for this task.
taskStatusId String The id of the status for this task.
order Number <optional>
 The order of the task in a task status column.
entityId String <optional>
 The id of the entity the task is related to.
baseType 'private' | 'projecttask' <optional>
 The base type of the task.
lists Array.<TaskListsObject> <optional>
 The list where the new task should be added to.

View Source endpoints/Tasks.js, line 35

Object

# TaskDependencyCreateModel

Properties:
Name Type Description
predecessorId String The Id of the predecessor. One task can have multiple predecessor.
successorId String The Id of the successor. One task can have one successor.

View Source endpoints/TaskDependencies.js, line 19

Object

# TaskDependencyTemplateModel

Properties:
Name Type Description
prodecessorTemplateId String The id of the predecessor task template.
successorTemplateId String The id of the successor task template.

View Source model/TaskTemplate.js, line 198

Object

# TaskListArchiveModel

Properties:
Name Type Attributes Description
isArchived Boolean Flags the entity as archived.
taskOperation 'task-to-done' | 'task-remove' | 'task-move' | 'task-delete' <optional>
 The operation for tasks which are not yet done. The operation is required if you set a list to archived. Can be: task-to-done: Set tasks to 'Done' or the first status of type 'done'. task-remove: Remove tasks from this task list. task-move: Move tasks to another list. task-delete: Deletes the non done tasks.
taskListId String <optional>
 Only necessary if TaskOperation is set to 'task-move'. The id of the task list where all non done tasks should moved to.
deleteTimeTrackings Boolean <optional>
 Only necessary if TaskOperation is set to 'task-delete'. Set to true to delete also the related time trackings of all non done tasks.

View Source endpoints/TaskLists.js, line 109

Object

# TaskListCreateModel

Properties:
Name Type Description
name String The name of the task list.
order Number The order of the task list.

View Source endpoints/TaskLists.js, line 56

Object

# TaskLists

Properties:
Name Type Description
id String The id of the task list template.
name String The name of the task list template.
orderOfTask Number The order of the task template in the task list template.
order Number The order of the task list template, unique within the task bundle.

View Source model/TaskBundle.js, line 94

Object

# TaskListsObject

Properties:
Name Type Description
id String The id of the list, the task should be assigned to.
order Number The order of the task in the list.

View Source endpoints/Tasks.js, line 29

Object

# TaskListTemplateCreateModel

Properties:
Name Type Description
name String The name of the list.
order Number The order of the list.

View Source endpoints/TaskBundleTaskListTemplates.js, line 46

TaskListTemplateCreateModel

# TaskListTemplateUpdateModel

View Source endpoints/TaskBundleTaskListTemplates.js, line 63

Object

# TasksDeleteModel

Properties:
Name Type Description
taskIds Array.<String> List of tasks to be deleted.
deleteTimeTrackings Boolean Set to true to delete also the related time trackings. If it is set to false the related time trackings are still there, but the project and task reference will be cleared. That will also happen if no request body is present.

View Source endpoints/Tasks.js, line 123

Object

# TaskStatus

Properties:
Name Type Description
id String uuid
name String nullable
type String uuid
order Number nullable
isPrivate Boolean
icon Icon nullable
projectId String uuid
projectTypeId String uuid
createdOn String date-time
createdBy String uuid
updatedOn String date-time
updatedBy String uuid

View Source model/Task.js, line 124

Object

# TaskStatusCreateModel

Properties:
Name Type Attributes Description
name String The name of the task status.
type 'todo' | 'progress' | 'review' | 'stuck' | 'done' Specifies the general type of this task status.
order Number <optional>
 The order of the task status. If it is null, the task status will be appended after the last task status.
icon Icon <optional>
 The icon of the task status.

View Source endpoints/ProjectTaskStatuses.js, line 38

Object

# TaskStatusCreateModel

Properties:
Name Type Attributes Description
name String The name of the task status.
type 'todo' | 'progress' | 'review' | 'stuck' | 'done' Specifies the general type of this task status.
order Number <optional>
 The order of the task status. If it is null, the task status will be appended after the last task status.
icon Icon <optional>
 The icon of the task status.

View Source endpoints/ProjectTemplateTaskStatuses.js, line 38

Object

# TaskStatusObject

Properties:
Name Type Description
id String uuid
name String nullable
description String nullable
isArchived Boolean

View Source model/TimeEntry.js, line 658

TaskStatusCreateModel

# TaskStatusUpdateModel

View Source endpoints/ProjectTaskStatuses.js, line 68

TaskStatusCreateModel

# TaskStatusUpdateModel

View Source endpoints/ProjectTemplateTaskStatuses.js, line 57

Object

# TaskTagsObject

Properties:
Name Type Description
id String uuid
createdOn String date-time
createdBy String uuid
updatedOn String date-time
updatedBy String uuid
name String nullable

View Source model/TimeEntry.js, line 772

Object

# TaskTemplateCreateModel

Properties:
Name Type Description
name String The name of the task created from this template.
description String The description of the task created from this template.#
isPrio Boolean Whether the task created from this template will be marked as priority.
plannedDuration Number The expected planned workload of the task created from this template, in seconds.
relativeStartOn Number The relative start date and time of the task created from this template, in seconds, from the moment of creating the task.
relaticeDueOn Number The relative due date and time of the task created from this template, in seconds, from the moment of creating the task.
typeOfWorkId String The id of the type of work of this task.
assignedUserId String The id of the assigned user of this task.
assignedRoleId String The id of the assigned role of this task.

View Source endpoints/TaskBundleTaskTemplates.js, line 44

Object

# TaskTemplatesToAdd

Properties:
Name Type Description
taskTemplateId String The id of the task template.
order Number The order of the task template, unique within the task list template.

View Source endpoints/TaskBundleTaskListTemplatesTaskTemplates.js, line 57

Object

# TaskTemplateTaskListTemplateModel

Properties:
Name Type Description
id String The id of the task list template.
name String The name of the task list template.
orderOfTask Number The order of the task template in the task list template.
order Number The order of the task list template, unique within the task bundle.

View Source model/TaskTemplate.js, line 182

TaskTemplateCreateModel

# TaskTemplateUpdateModel

View Source endpoints/TaskBundleTaskTemplates.js, line 68

Object

# TaskTypeObject

Properties:
Name Type Description
id String uuid
name String nullable
icon Icon nullable
isArchived Boolean

View Source model/TimeEntry.js, line 687

Object

# TaskUpdateModel

Properties:
Name Type Attributes Description
name String The name of the task.
description String <optional>
 The description of the task.
isPrio Boolean <optional>
 Whether this task is marked as priority.
startOn String <optional>
 The expected start date and time of the task.
dueOn String <optional>
 The expected due date and time of the task.
laneOrder Integer <optional>
 The lane order defines the vertical position in the gant planner.
plannedDuration Integer <optional>
 The expected planned workload of the task, in seconds.
remainingDuration Integer <optional>
 The expected remaining duration from the original planned effort of the task, in seconds.

View Source endpoints/Tasks.js, line 64

Object

# TaskViewCreateModel

Properties:
Name Type Description
filter String The filter query that is applied to the tasks results. The syntax follows the normal filter conventions that can be used on GET routes
filterSettings String The filter settings to display.
name String The name of the task view.
isShared Boolean If the task view is shared or not.

View Source endpoints/MeTaskViews.js, line 24

TaskViewCreateModel

# TaskViewUpdateModel

View Source endpoints/MeTaskViews.js, line 43

Object

# TeamCreateModel

Properties:
Name Type Attributes Description
name String The team name.
icon Icon <optional>
 The team icon. Optional.
color Color <optional>
 The team color. Optional.

View Source endpoints/Teams.js, line 51

Object

# TeamOptions

Properties:
Name Type Description
includeUserIds Boolean If the user ids should be included.
includeProjectIds Boolean If the project ids should be included.

View Source endpoints/Teams.js, line 22

Object

# TeamsObject

Properties:
Name Type Description
id String The Id of the team.
name String The name of the team.
icon Icon The icon which is assigned to the team.
color Color The color of the team.

View Source model/ExtendedUser.js, line 32

TeamCreateModel

# TeamUpdateModel

View Source endpoints/Teams.js, line 69

Object

# TemporaryFilesUpdateModel

Properties:
Name Type Attributes Description
name String <optional>
 The user-specified name of the file.
description String <optional>
 The description of the file.

View Source endpoints/TemporaryFiles.js, line 73

Object

# TimeEntryCreateModel

Properties:
Name Type Attributes Description
isBillable Boolean <optional>
 Whether the time tracking is billable or not.
isBilled Boolean <optional>
 Whether the time tracking is billed or not.
taskId String <optional>
 The id of the task.
projectId String <optional>
 The id of the project.
note String <optional>
 The note of the time tracking.
location LocationObject <optional>
 The location.
startDateUtc String The date (in UTC) when the time tracking was started.
startTimeUtc Object <optional>
endTimeUtc Object <optional>
startDateLocal String The date (in Local) when the time tracking was started.
startTimeLocal Object <optional>
endTimeLocal Object <optional>
timezone String The original timezone of the time tracking. The format of the timezone is the IANA standard.
duration Integer <optional>
 The duration of the time tracking in seconds. Required when the time tracking has already been completed and EndTime has not been set.
typeOfWorkId String The id of the type of work.
userId String The id of the user.

View Source endpoints/TimeEntries.js, line 47

TimeEntryCreateModel

# TimeEntryUpdateModel

View Source endpoints/TimeEntries.js, line 78

Object

# TimeTrackingStartModel

Properties:
Name Type Attributes Description
isBillable Boolean <optional>
 Whether the time tracking is billable or not.
isBilled Boolean <optional>
 Whether the time tracking is billed or not.
taskId String <optional>
 The id of the task.
projectId String <optional>
 The id of the project.
note String <optional>
 The note of the time tracking.
location LocationObject <optional>
 The latitude and longitude of the geo-location.
typeOfWorkId String The id of the type of work of the time tracking.
timezone String The original timezone of the time tracking. The format of the timezone is the IANA standard.

View Source endpoints/TimeTrackings.js, line 30

Object

# Trigger

Properties:
Name Type Description
type String The type of the trigger.
values Array.<TriggerValue> The values of the trigger.

View Source model/Automation.js, line 75

Object

# TriggerValue

Properties:
Name Type Description
name String The name of the trigger value.
value String The value of the trigger value.

View Source model/Automation.js, line 69

Object

# TypeofWork

Properties:
Name Type Description
id String uuid
name String nullable
icon Icon nullable
isArchived Boolean

View Source model/Task.js, line 156

Object

# TypeOfWorkCreateModel

Properties:
Name Type Description
name String The name of the type of work.
description String A short description of the type of work.
icon Icon The icon ass with this type of work.

View Source endpoints/TypesOfWork.js, line 43

TypeOfWorkCreateModel

# TypeOfWorkUpdateModel

View Source endpoints/TypesOfWork.js, line 61

AssignUsersModel

# UnassignUsersModel

View Source endpoints/Tasks.js, line 99

Object

# UpdateTagsModel

Properties:
Name Type Description
oldTagName String The old name of the tag.
newTag TagsModel The new name of the tag.

View Source endpoints/EntityTags.js, line 62

'work' | 'private' | 'gitHub' | 'other'

# UrlSubType

View Source endpoints/UserContactInfos.js, line 58

'primary' | 'other'

# UrlSubType

View Source model/CompanyContactInfo.js, line 67

'work' | 'private' | 'gitHub' | 'other'

# UrlSubType

View Source model/UserContactInfo.js, line 67

Object

# UserContactInfoCreateModel

Properties:
Name Type Description
label String The label of the contact info. Only necessary if type 'custom' is used.
value String The value of the contact info.
type 'phone' | 'email' | 'adress' | 'messenger' | 'social' | 'urls' The type of the contact info.
subtype PhoneSubType | EmailSubType | AddressSubType | MessengerSubType | SocialSubType | UrlSubType The subtype of the contact info.
addressLine1 String The first Address line of the address.
addressLine2 String The second address line of the contact info.
zipCode String The Zipcode of the contact info.
city String The city of the contact info.
state String The state of the contact info.
country String The 2 letter iso code of the country.
isAdress Boolean Flags whether this contactinfo is an address or not. If its an address, the address fields are required.

View Source endpoints/UserContactInfos.js, line 70

UserContactInfoCreateModel

# UserContactInfoUpdateModel

View Source endpoints/UserContactInfos.js, line 96

Object

# UserCreateModel

Properties:
Name Type Attributes Description
firstName String <optional>
 The firstname of the user.
lastName String <optional>
 The lastname of the user.
birthDate String <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.
capacityPerWeek Integer <optional>
 The capacity of the user per week in seconds.
accountId String <optional>
 The account id of the user.

View Source endpoints/Users.js, line 52

Object

# UserTagsObject

Properties:
Name Type Description
id String uuid
createdOn String date-time
createdBy String uuid
updatedOn String date-time
updatedBy String uuid
name String nullable

View Source model/TimeEntry.js, line 598

Object

# UserTagsObject

Properties:
Name Type Description
id String uuid
name String nullable
color Color nullable
entityId String uuid
createdOn String date-time
createdBy String uuid
updatedOn String date-time
updatedBy String uuid

View Source model/User.js, line 206

Object

# UserTeamPair

Properties:
Name Type Description
userId String The id of the user.
teamId String The id of the team.

View Source endpoints/Teams.js, line 94

Object

# UserUpdateModel

Properties:
Name Type Attributes Description
firstName String <optional>
 The firstname of the user.
lastName String <optional>
 The lastname of the user.
birthDate String <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.
capacityPerWeek Integer <optional>
 The capacity of the user per week in seconds.

View Source endpoints/Users.js, line 76

Object

# WebhookCreateModel

Properties:
Name Type Attributes Description
name String The name of this webhook event. Required.
uri String The URI to call. Required.
language String <optional>
 The language of the web hook message that will be sent to the receiver. Not required for custom web hooks.
events String The event(s) that trigger the web hook. A comma-separated list of events, for example 'user_added,user_deleted'. Required.
isArchived Boolean Whether the web hook is currently active. Required.
authenticationType String The authentication type to use when calling the URI. Can be 'none', 'header'. Required.
authentication String <optional>
 The authentication value to use when calling the URI. Should be 'key=value'. In case of header, this should be 'headername=headervalue'. Only required when the AuthenticationType is anything other than 'none'.

View Source endpoints/Webhooks.js, line 41

Object

# WidgetObject

Properties:
Name Type Attributes Description
id String The id of the widget.
type String <optional>
 The type of the widget.
name String <optional>
 The name of the widget.
entityId String <optional>
 The id of the entity that the widget is referencing.
column Integer The column of the widget within the dashboard.
order Integer The order of the widget within the column.
settings String <optional>
 The settings of the widget.
value String <optional>
 The value of a widget.

View Source model/Dashboard.js, line 37