latestOpenAPI 3.1.02026-08-186974431.1 MB

84917af8da36

absenceRegions11

absences5

accounts1

apiUsers5

assignedTasks8

autopilot6

checklistItems16

clientApplications11

companies11

companyFiles15

companyTags6

customFields23

dashboards1

documentComments8

documentFiles15

documents22

documentSpaces11

files2

fileUpload2

filters20

images4

invitations2

permissions3

privateTasks10

projectActivities1

projectAutomations13

projectComments7

projectFiles17

projectMembers2

projectMilestones6

projectMilestoneTemplates5

projectRoles8

projects13

projectStatuses7

projectTags6

projectTasks6

projectTemplateAutomations12

projectTemplateFiles16

projectTemplates14

projectTemplateTags6

projectTypes7

retainers5

roles17

search1

sharedFiles2

taskActivities1

taskBundles29

taskComments7

taskDependencies4

taskDependencyTemplates5

taskFiles16

taskLists13

tasks21

taskSchedules6

taskStatuses5

taskTags9

taskTemplateFiles16

taskTemplates7

taskTemplateTags6

teams9

temporaryFiles6

timeBookings10

timeEntries18

timeReports1

timeTracking8

timeTrackingSettings1

typeOfWork7

userCapacities2

userFiles16

users15

userTags6

webhooks8

workflowAutomations12

workflows21

workload1

workspaceAbsences4

workspaceFiles16

workspaces2

documents

Creates a new document. Optional content must be UTF-8 HTML for the awork rich-text editor; Markdown is not supported.

When content is provided, it must be UTF-8 HTML formatted for the awork rich-text editor. Markdown is not supported.

<Check title="Required Permissions" icon="key">Any authenticated user.</Check>

post/documents

Headers

Authorizationstring required

Bearer authentication

Response

idstring uuid

The id of the entity.

createdOnstring date-time

The date this entity was created.

createdBystring uuid

The id of the user who created this entity.

updatedOnstring date-time

The date this entity was last modified.

updatedBystring uuid

The id of the user who last modified this entity.

namestring nullable

The name of the document.

currentDocumentVersionIdstring uuid nullable

The id of the current document version.

documentSpaceIdstring uuid nullable

The id of the document space.

parentIdstring uuid nullable

The id of the document's parent document.

projectIdstring uuid nullable

The id of the project this document references.

taskIdstring uuid nullable

The id of the task this document references.

emojistring nullable

The emoji of the document.

isPrivateboolean

Whether the document is private.

ordernumber double nullable

The order of the document in either the list of private docs, the referenced document space or in the referenced project.

isExternalboolean

Whether the document belongs to an external project.

isHiddenForConnectUsersboolean

Whether the document is hidden for connect users.

workspaceAccessLevelstring nullable

Determines the level of access to this document granted to all workspace users. Can be either not set (no access), read, or manage.

inheritedWorkspaceAccessFromDocumentIdstring uuid nullable

The id of the document the workspace access level permission has been inherited from.

movedToTrashOnstring date-time nullable

The date the document has been moved to the trash

movedToTrashBystring uuid nullable

The id of the user that moved the document to the trash.

rootDocumentCreatedBystring uuid

The user id of the creator of the root document of this document's document tree.