--- title: "Performs a full-text search across workspace entities." method: GET path: "/search" tags: ["search"] --- # Performs a full-text search across workspace entities. `GET /search` This endpoint enables powerful full-text search capabilities across multiple types. It returns a ranked list of matching entities based on relevance and respects user permissions. The search functionality includes: - Cross-entity search across various entity types in the workspace. - Relevance-based scoring and ranking of results. - Respecting user access permissions for all returned results. - Customizable result filtering by entity type and status. Any authenticated user. ## Query parameters - `searchTerm` string - `searchTypes` string - `top` integer - `includeClosedAndStuck` boolean ## Headers - `Authorization` string, required ## Response `200` OK - SearchResults - `totalCount` integer — The overall number of hits. - `maxScore` number, double — The highest overall search score. - `top` unknown[], nullable — The best search matches accross all types ordered descending by their score. - unknown - `commentHits` CommentSearchModelTypeSearchResult - `totalCount` integer — The count of search hits for this type. - `maxScore` number, double — The score of the best search hit for this type. - `hits` CommentSearchModelHit[], nullable — The results found by this search operation for this type. - `type` string, nullable — The name of the type for this search hit. - `score` number, double — The score of this search hit. - `entity` CommentSearchModel - `id` string, uuid — The id of this entity. - `workspaceId` string, uuid — The workspace id of this entity. - `userStats` UserAccessStatistic[], nullable — The current user's access stats for this entity. - `userId` string, uuid — The id of the user that accessed this entity. - `openCount` integer — How many times the user accessed this entity. - `lastOpened` integer, nullable — The unix time of when the entity was last accessed by the user. - `indexTime` string, date-time — The last time this entity has been indexed. - `message` string, nullable — The message of this comment. - `entityType` 'tasks' | 'projects' | 'documents' — The type of the entity that this comment is attached to. - `entityId` string, uuid — The id of the entity that this comment is attached to. - `project` ProjectEntity - `id` string, uuid — The id of this project. - `name` string, nullable — The name of the Project. Required. Max allowed length: 25000 characters. - `company` string, nullable — The company this project is for. - `isPrivate` boolean — Whether this is a private project only visible to members and the creator. - `isBillableByDefault` boolean, nullable — Whether project times should be billable by default. - `projectStatus` ProjectStatusEntity - `id` string, uuid — The id of this project status. - `name` string, nullable — The name of the project status. - `type` string, nullable — The general type of this project status. - `createdBy` string, uuid — The id of the user that created this project. - `teams` TeamEntity[], nullable — The teams this project belongs to. - `id` string, uuid — The id of this team. - `name` string, nullable — The name of the team. - `members` ProjectMemberEntity[], nullable — The members of this project. - `id` string, uuid — The id of this project member. - `userId` string, uuid — The id of the user that is member of this project. - `firstName` string, nullable — The first name of the user. - `lastName` string, nullable — The last name of the user. - `projectRoleName` string, nullable — The project role name of the project member. - `hasImage` boolean, nullable — Whether the user has an image. - `projectRoleId` string, uuid — The id of the project role. - `isExternal` boolean — Whether this project is external. - `task` BaseTaskEntity - `name` string, nullable — The name of the task. Max allowed length: 25000 characters. Required. - `id` string, uuid — The id of the parent task. - `userId` string, uuid, nullable — The user id this task belongs to in case this is a private task. - `createdBy` string, uuid — The id of the user that created this task. - `projectId` string, uuid, nullable — The id of the project this task is part of. - `project` ProjectEntity - `id` string, uuid — The id of this project. - `name` string, nullable — The name of the Project. Required. Max allowed length: 25000 characters. - `company` string, nullable — The company this project is for. - `isPrivate` boolean — Whether this is a private project only visible to members and the creator. - `isBillableByDefault` boolean, nullable — Whether project times should be billable by default. - `projectStatus` ProjectStatusEntity - … - `createdBy` string, uuid — The id of the user that created this project. - `teams` TeamEntity[], nullable — The teams this project belongs to. - … - `members` ProjectMemberEntity[], nullable — The members of this project. - … - `isExternal` boolean — Whether this project is external. - `parentId` string, uuid, nullable — The id of the parent task of this task, if this task is a subtask. - `parentTask` ParentTaskEntity - `name` string, nullable — The name of the task. Max allowed length: 25000 characters. Required. - `id` string, uuid — The id of the parent task. - `userId` string, uuid, nullable — The user id this task belongs to in case this is a private task. - `createdBy` string, uuid — The id of the user that created this task. - `assigneeIds` string[], nullable — The user ids this task is assigned to. - `assignees` TaskAssignmentEntity[], nullable — The assignees of the task. - `id` string, uuid — The assigned user's id. - `firstName` string, nullable — The assigned user's first name. - `lastName` string, nullable — The assigned user's last name. - `baseType` string, nullable — The base type of the task. - `taskStatus` TaskStatusEntity - `name` string, nullable — The name of the task status. - `type` string, nullable — The general type of this task status. - `icon` string, nullable — The icon of the task status. - `isExternal` boolean — Whether this task is external. - `isHiddenForConnectUsers` boolean - `document` DocumentEntity - `name` string, nullable — The name of the document. - `content` string, nullable — The content of the document. This is indexed for search and highlighting but not returned in search results. - `documentSpaceId` string, uuid, nullable — The id of the document space. - `documentSpace` DocumentSpaceEntity - `id` string, uuid - `isExternal` boolean - `name` string, nullable - `workspaceAccessLevel` string, nullable - `contributors` ContributorEntity[], nullable - … - `teams` EntityToTeamEntity[], nullable - … - `parentId` string, uuid, nullable — The id of the document's parent document. - `emoji` string, nullable — The emoji of the document. - `projectId` string, uuid, nullable — The id of the project this document references. - `project` ProjectEntity - `id` string, uuid — The id of this project. - `name` string, nullable — The name of the Project. Required. Max allowed length: 25000 characters. - `company` string, nullable — The company this project is for. - `isPrivate` boolean — Whether this is a private project only visible to members and the creator. - `isBillableByDefault` boolean, nullable — Whether project times should be billable by default. - `projectStatus` ProjectStatusEntity - … - `createdBy` string, uuid — The id of the user that created this project. - `teams` TeamEntity[], nullable — The teams this project belongs to. - … - `members` ProjectMemberEntity[], nullable — The members of this project. - … - `isExternal` boolean — Whether this project is external. - `isPrivate` boolean — Whether the document is private. - `isExternal` boolean — Whether the document belongs to an external project. - `isHiddenForConnectUsers` boolean — Whether the document is hidden for connect users. - `contributors` DocumentContributorEntity[], nullable — The contributors of this document. - `userId` string, uuid - `accessLevel` string, nullable - `documentId` string, uuid - `inheritedFromDocumentContributorId` string, uuid, nullable - `inheritedDocumentContributor` InheritedDocumentContributorEntity - … - `teams` DocumentToTeamEntity[], nullable — The teams this document is connected to. - `teamId` string, uuid - `accessLevel` string, nullable - `documentId` string, uuid - `inheritedFromDocumentToTeamId` string, uuid, nullable - `inheritedDocumentToTeam` InheritedDocumentToTeamEntity - … - `workspaceAccessLevel` string, nullable — Determines the level of access to this document granted to all workspace users. Can be either not set (no access), `read`, or `manage`. - `inheritedWorkspaceAccessFromDocumentId` string, uuid, nullable — The id of the document the workspace access level permission has been inherited from. - `inheritedWorkspaceAccessFromDocument` InheritedWorkspaceAccessFromDocumentEntity - `workspaceAccessLevel` string, nullable - `rootDocumentCreatedBy` string, uuid — The user id of the creator of the root document of this document's document tree. - `isExternal` boolean — Whether this comment is external. - `userId` string, uuid, nullable — The id of the user who created this comment. - `isHiddenForConnectUsers` boolean — Whether this comment is hidden for connect users. - `isResolved` boolean, nullable — Whether the comment has been resolved. Only available for comments on documents. - `highlights` object, nullable — The highlights of this search hit, by property. - `hasHits` boolean — Whether there are any hits at all, computed property. - `companyHits` CompanySearchModelTypeSearchResult - `totalCount` integer — The count of search hits for this type. - `maxScore` number, double — The score of the best search hit for this type. - `hits` CompanySearchModelHit[], nullable — The results found by this search operation for this type. - `type` string, nullable — The name of the type for this search hit. - `score` number, double — The score of this search hit. - `entity` CompanySearchModel - `id` string, uuid — The id of this entity. - `workspaceId` string, uuid — The workspace id of this entity. - `userStats` UserAccessStatistic[], nullable — The current user's access stats for this entity. - `userId` string, uuid — The id of the user that accessed this entity. - `openCount` integer — How many times the user accessed this entity. - `lastOpened` integer, nullable — The unix time of when the entity was last accessed by the user. - `indexTime` string, date-time — The last time this entity has been indexed. - `name` string, nullable — The company name. - `industry` string, nullable — The company's industry. Optional. - `tags` string[], nullable — The tags of the company. - `companyContactInfos` ContactInfoEntity[], nullable — The contact infos of this company. - `id` string, uuid — The id of this contact info. - `value` string, nullable — The value of the contact info. - `type` string, nullable — The type of the contact info. Possible values are: 'phone', 'email', 'address', 'custom'. - `subType` string, nullable — The subtype of the contact info, Possible values are: phone: [ 'central', 'other' ] email: [ 'central', 'invoice', 'other' ] address: [ 'central', 'invoice', 'other' ] url: [ 'primary', 'other'] - `isAddress` boolean — Flags whether this contact info is an address. If it's an address, the address fields are required. - `addressLine1` string, nullable — The first address line of the contact info. - `addressLine2` string, nullable — The second address line of the contact info. - `zipCode` string, nullable — The zipcode of the contact info. - `city` string, nullable — The city of the contact info. - `state` string, nullable — The state of the contact info. - `country` string, nullable — The 2 letter iso code of the country. - `hasImage` boolean, nullable — Whether the user has an image. - `highlights` object, nullable — The highlights of this search hit, by property. - `hasHits` boolean — Whether there are any hits at all, computed property. - `dashboardNotesHits` DashboardNoteSearchModelTypeSearchResult - `totalCount` integer — The count of search hits for this type. - `maxScore` number, double — The score of the best search hit for this type. - `hits` DashboardNoteSearchModelHit[], nullable — The results found by this search operation for this type. - `type` string, nullable — The name of the type for this search hit. - `score` number, double — The score of this search hit. - `entity` DashboardNoteSearchModel - `id` string, uuid — The id of this entity. - `workspaceId` string, uuid — The workspace id of this entity. - `userStats` UserAccessStatistic[], nullable — The current user's access stats for this entity. - `userId` string, uuid — The id of the user that accessed this entity. - `openCount` integer — How many times the user accessed this entity. - `lastOpened` integer, nullable — The unix time of when the entity was last accessed by the user. - `indexTime` string, date-time — The last time this entity has been indexed. - `name` string, nullable — The name of the dashboard widget note. - `note` string, nullable — The note of the dashboard widget note. - `userId` string, uuid — The id of the user the dashboard note belongs to. - `highlights` object, nullable — The highlights of this search hit, by property. - `hasHits` boolean — Whether there are any hits at all, computed property. - `projectHits` ProjectSearchModelTypeSearchResult - `totalCount` integer — The count of search hits for this type. - `maxScore` number, double — The score of the best search hit for this type. - `hits` ProjectSearchModelHit[], nullable — The results found by this search operation for this type. - `type` string, nullable — The name of the type for this search hit. - `score` number, double — The score of this search hit. - `entity` ProjectSearchModel - `id` string, uuid — The id of this entity. - `workspaceId` string, uuid — The workspace id of this entity. - `userStats` UserAccessStatistic[], nullable — The current user's access stats for this entity. - `userId` string, uuid — The id of the user that accessed this entity. - `openCount` integer — How many times the user accessed this entity. - `lastOpened` integer, nullable — The unix time of when the entity was last accessed by the user. - `indexTime` string, date-time — The last time this entity has been indexed. - `name` string, nullable — The name of the Project. Required. Max allowed length: 25000 characters. - `projectKey` string, nullable — The unique project key within the workspace (e.g., "NIKE"). Maximum 32 characters, uppercase letters, numbers, and dashes only. - `description` string, nullable — The description of the project. Max allowed length: 25000 characters. - `projectTypeId` string, uuid, nullable — The id of the project type of this project. - `projectStatusId` string, uuid — The id of the project status. - `isPrivate` boolean — Whether this is a private project only visible to members and the creator. - `isOpen` boolean — Whether this project is not closed. - `isBillableByDefault` boolean, nullable — Whether project times should be billable by default. - `tags` string[], nullable — The tags of this project. - `plannedDuration` integer, nullable — The total planned time of the project, in seconds. The time is calculated as te sum of the planned duration by all project tasks. - `dueDate` string, date-time, nullable — The due date of the project. - `startDate` string, date-time, nullable — The start date of the project. - `company` CompanySearchModel - `id` string, uuid — The id of this entity. - `workspaceId` string, uuid — The workspace id of this entity. - `userStats` UserAccessStatistic[], nullable — The current user's access stats for this entity. - `userId` string, uuid — The id of the user that accessed this entity. - `openCount` integer — How many times the user accessed this entity. - `lastOpened` integer, nullable — The unix time of when the entity was last accessed by the user. - `indexTime` string, date-time — The last time this entity has been indexed. - `name` string, nullable — The company name. - `industry` string, nullable — The company's industry. Optional. - `tags` string[], nullable — The tags of the company. - `companyContactInfos` ContactInfoEntity[], nullable — The contact infos of this company. - `id` string, uuid — The id of this contact info. - `value` string, nullable — The value of the contact info. - `type` string, nullable — The type of the contact info. Possible values are: 'phone', 'email', 'address', 'custom'. - `subType` string, nullable — The subtype of the contact info, Possible values are: phone: [ 'central', 'other' ] email: [ 'central', 'invoice', 'other' ] address: [ 'central', 'invoice', 'other' ] url: [ 'primary', 'other'] - `isAddress` boolean — Flags whether this contact info is an address. If it's an address, the address fields are required. - `addressLine1` string, nullable — The first address line of the contact info. - `addressLine2` string, nullable — The second address line of the contact info. - `zipCode` string, nullable — The zipcode of the contact info. - `city` string, nullable — The city of the contact info. - `state` string, nullable — The state of the contact info. - `country` string, nullable — The 2 letter iso code of the country. - `hasImage` boolean, nullable — Whether the user has an image. - `projectType` ProjectTypeEntity - `id` string, uuid — The id of the type. - `name` string, nullable — The name of the project type. - `icon` string, nullable — The identifier of the project type icon. - `projectStatus` ProjectStatusEntity - `id` string, uuid — The id of this project status. - `name` string, nullable — The name of the project status. - `type` string, nullable — The general type of this project status. - `members` ProjectMemberEntity[], nullable — The members of this project. - `id` string, uuid — The id of this project member. - `userId` string, uuid — The id of the user that is member of this project. - `firstName` string, nullable — The first name of the user. - `lastName` string, nullable — The last name of the user. - `projectRoleName` string, nullable — The project role name of the project member. - `hasImage` boolean, nullable — Whether the user has an image. - `projectRoleId` string, uuid — The id of the project role. - `hasImage` boolean, nullable — Whether the project has an image. - `createdBy` string, uuid — The id of the user that created this project. - `teams` TeamEntity[], nullable — The teams this project belongs to. - `id` string, uuid — The id of this team. - `name` string, nullable — The name of the team. - `isExternal` boolean — Whether this project is external. - `highlights` object, nullable — The highlights of this search hit, by property. - `hasHits` boolean — Whether there are any hits at all, computed property. - `taskHits` TaskSearchModelTypeSearchResult - `totalCount` integer — The count of search hits for this type. - `maxScore` number, double — The score of the best search hit for this type. - `hits` TaskSearchModelHit[], nullable — The results found by this search operation for this type. - `type` string, nullable — The name of the type for this search hit. - `score` number, double — The score of this search hit. - `entity` TaskSearchModel - `id` string, uuid — The id of this entity. - `workspaceId` string, uuid — The workspace id of this entity. - `userStats` UserAccessStatistic[], nullable — The current user's access stats for this entity. - `userId` string, uuid — The id of the user that accessed this entity. - `openCount` integer — How many times the user accessed this entity. - `lastOpened` integer, nullable — The unix time of when the entity was last accessed by the user. - `indexTime` string, date-time — The last time this entity has been indexed. - `name` string, nullable — The name of the task. Max allowed length: 25000 characters. Required. - `taskIdentifier` string, nullable — The full task identifier combining project key and task number (e.g., "NIKE-42"). - `description` string, nullable — The description of the task. Max allowed length: 25000 characters. - `baseType` string, nullable — The base type of the task. - `assignees` TaskAssignmentEntity[], nullable — The assignees of the task. - `id` string, uuid — The assigned user's id. - `firstName` string, nullable — The assigned user's first name. - `lastName` string, nullable — The assigned user's last name. - `tags` string[], nullable — The tags of this task. - `lists` string[], nullable — The task lists this task is in. - `isPrio` boolean, nullable — Whether this task is marked as priority. - `isOpen` boolean — Whether this task is open. - `plannedDuration` integer, nullable — The expected planned workload of the task, in seconds. - `startOn` string, date-time, nullable — The expected start date and time of the task. - `dueOn` string, date-time, nullable — The expected due date and time of the task. - `taskStatus` TaskStatusEntity - `name` string, nullable — The name of the task status. - `type` string, nullable — The general type of this task status. - `icon` string, nullable — The icon of the task status. - `typeOfWork` TypeOfWorkEntity - `name` string, nullable — The name of the type of work. - `projectId` string, uuid, nullable — The id of the project this task is part of. - `project` ProjectEntity - `id` string, uuid — The id of this project. - `name` string, nullable — The name of the Project. Required. Max allowed length: 25000 characters. - `company` string, nullable — The company this project is for. - `isPrivate` boolean — Whether this is a private project only visible to members and the creator. - `isBillableByDefault` boolean, nullable — Whether project times should be billable by default. - `projectStatus` ProjectStatusEntity - `id` string, uuid — The id of this project status. - `name` string, nullable — The name of the project status. - `type` string, nullable — The general type of this project status. - `createdBy` string, uuid — The id of the user that created this project. - `teams` TeamEntity[], nullable — The teams this project belongs to. - `id` string, uuid — The id of this team. - `name` string, nullable — The name of the team. - `members` ProjectMemberEntity[], nullable — The members of this project. - `id` string, uuid — The id of this project member. - `userId` string, uuid — The id of the user that is member of this project. - `firstName` string, nullable — The first name of the user. - `lastName` string, nullable — The last name of the user. - `projectRoleName` string, nullable — The project role name of the project member. - `hasImage` boolean, nullable — Whether the user has an image. - `projectRoleId` string, uuid — The id of the project role. - `isExternal` boolean — Whether this project is external. - `parentId` string, uuid, nullable — The id of the parent task of this task, if this task is a subtask. - `parentTask` ParentTaskEntity - `name` string, nullable — The name of the task. Max allowed length: 25000 characters. Required. - `id` string, uuid — The id of the parent task. - `userId` string, uuid, nullable — The user id this task belongs to in case this is a private task. - `createdBy` string, uuid — The id of the user that created this task. - `assigneeIds` string[], nullable — The user ids this task is assigned to. - `correlationId` string, uuid — The correlation id of this task. - `subtaskOrder` number, double, nullable — The order of this subtask in the parent task, if this task is a subtask. - `userId` string, uuid, nullable — The user id this task belongs to in case this is a private task. - `createdBy` string, uuid — The id of the user that created this task. - `isExternal` boolean — Whether this task is external. - `isHiddenForConnectUsers` boolean — Whether this task should be hidden for connected users. - `highlights` object, nullable — The highlights of this search hit, by property. - `hasHits` boolean — Whether there are any hits at all, computed property. - `timeEntriesHits` TimeEntrySearchModelTypeSearchResult - `totalCount` integer — The count of search hits for this type. - `maxScore` number, double — The score of the best search hit for this type. - `hits` TimeEntrySearchModelHit[], nullable — The results found by this search operation for this type. - `type` string, nullable — The name of the type for this search hit. - `score` number, double — The score of this search hit. - `entity` TimeEntrySearchModel - `id` string, uuid — The id of this entity. - `workspaceId` string, uuid — The workspace id of this entity. - `userStats` UserAccessStatistic[], nullable — The current user's access stats for this entity. - `userId` string, uuid — The id of the user that accessed this entity. - `openCount` integer — How many times the user accessed this entity. - `lastOpened` integer, nullable — The unix time of when the entity was last accessed by the user. - `indexTime` string, date-time — The last time this entity has been indexed. - `note` string, nullable — The note of the time tracking. - `taskId` string, uuid, nullable — The id of the task this time entry belongs to. - `projectId` string, uuid, nullable — The id of the project this time entry belongs to. - `project` ProjectEntity - `id` string, uuid — The id of this project. - `name` string, nullable — The name of the Project. Required. Max allowed length: 25000 characters. - `company` string, nullable — The company this project is for. - `isPrivate` boolean — Whether this is a private project only visible to members and the creator. - `isBillableByDefault` boolean, nullable — Whether project times should be billable by default. - `projectStatus` ProjectStatusEntity - `id` string, uuid — The id of this project status. - `name` string, nullable — The name of the project status. - `type` string, nullable — The general type of this project status. - `createdBy` string, uuid — The id of the user that created this project. - `teams` TeamEntity[], nullable — The teams this project belongs to. - `id` string, uuid — The id of this team. - `name` string, nullable — The name of the team. - `members` ProjectMemberEntity[], nullable — The members of this project. - `id` string, uuid — The id of this project member. - `userId` string, uuid — The id of the user that is member of this project. - `firstName` string, nullable — The first name of the user. - `lastName` string, nullable — The last name of the user. - `projectRoleName` string, nullable — The project role name of the project member. - `hasImage` boolean, nullable — Whether the user has an image. - `projectRoleId` string, uuid — The id of the project role. - `isExternal` boolean — Whether this project is external. - `userId` string, uuid, nullable — The id of the user this time entry belongs to. - `startDateUtc` string, date-time, nullable — The date and time (in UTC) when the time tracking was started. - `startTimeUtc` string, nullable — The time (in UTC) when the time tracking was started. - `timezone` string, nullable — The original timezone of the time tracking. The format of the timezone is the IANA standard. - `duration` integer, nullable — The duration of the time tracking in seconds. Required when the time tracking has already been completed and EndTime has not been set. - `breakDuration` integer, nullable — The duration of the break in seconds. Cannot be set via API. - `isExternal` boolean — Whether this time entry is external. - `isBilled` boolean — Whether this time entry is billed. - `highlights` object, nullable — The highlights of this search hit, by property. - `hasHits` boolean — Whether there are any hits at all, computed property. - `timeReportsHits` TimeReportSearchModelTypeSearchResult - `totalCount` integer — The count of search hits for this type. - `maxScore` number, double — The score of the best search hit for this type. - `hits` TimeReportSearchModelHit[], nullable — The results found by this search operation for this type. - `type` string, nullable — The name of the type for this search hit. - `score` number, double — The score of this search hit. - `entity` TimeReportSearchModel - `id` string, uuid — The id of this entity. - `workspaceId` string, uuid — The workspace id of this entity. - `userStats` UserAccessStatistic[], nullable — The current user's access stats for this entity. - `userId` string, uuid — The id of the user that accessed this entity. - `openCount` integer — How many times the user accessed this entity. - `lastOpened` integer, nullable — The unix time of when the entity was last accessed by the user. - `indexTime` string, date-time — The last time this entity has been indexed. - `name` string, nullable — The name of the time report. - `shared` boolean — Whether the time report is shared with other users. - `userId` string, uuid — The id of the user that created the time report. - `highlights` object, nullable — The highlights of this search hit, by property. - `hasHits` boolean — Whether there are any hits at all, computed property. - `userHits` UserSearchModelTypeSearchResult - `totalCount` integer — The count of search hits for this type. - `maxScore` number, double — The score of the best search hit for this type. - `hits` UserSearchModelHit[], nullable — The results found by this search operation for this type. - `type` string, nullable — The name of the type for this search hit. - `score` number, double — The score of this search hit. - `entity` UserSearchModel - `id` string, uuid — The id of this entity. - `workspaceId` string, uuid — The workspace id of this entity. - `userStats` UserAccessStatistic[], nullable — The current user's access stats for this entity. - `userId` string, uuid — The id of the user that accessed this entity. - `openCount` integer — How many times the user accessed this entity. - `lastOpened` integer, nullable — The unix time of when the entity was last accessed by the user. - `indexTime` string, date-time — The last time this entity has been indexed. - `firstName` string, nullable — The user's first name. - `lastName` string, nullable — The user's last name. - `title` string, nullable — The user's title. - `position` string, nullable — The user's position. - `language` string, nullable — The user's language. - `gender` string, nullable — The user's gender. - `tags` string[], nullable — The tags of this user. - `teams` TeamModel[], nullable — The teams of this user. - `id` string, uuid — The id of the team. - `name` string, nullable — The name of the team. - `icon` string, nullable — The icon which is assigned to the team. - `color` string, nullable — The color of the team. - `userContactInfos` ContactInfoEntity[], nullable — The contact infos of this user. - `id` string, uuid — The id of this contact info. - `value` string, nullable — The value of the contact info. - `type` string, nullable — The type of the contact info. Possible values are: 'phone', 'email', 'address', 'custom'. - `subType` string, nullable — The subtype of the contact info, Possible values are: phone: [ 'central', 'other' ] email: [ 'central', 'invoice', 'other' ] address: [ 'central', 'invoice', 'other' ] url: [ 'primary', 'other'] - `isAddress` boolean — Flags whether this contact info is an address. If it's an address, the address fields are required. - `addressLine1` string, nullable — The first address line of the contact info. - `addressLine2` string, nullable — The second address line of the contact info. - `zipCode` string, nullable — The zipcode of the contact info. - `city` string, nullable — The city of the contact info. - `state` string, nullable — The state of the contact info. - `country` string, nullable — The 2 letter iso code of the country. - `hasImage` boolean, nullable - `isDeactivated` boolean, nullable - `highlights` object, nullable — The highlights of this search hit, by property. - `hasHits` boolean — Whether there are any hits at all, computed property. - `taskListHits` TaskListSearchModelTypeSearchResult - `totalCount` integer — The count of search hits for this type. - `maxScore` number, double — The score of the best search hit for this type. - `hits` TaskListSearchModelHit[], nullable — The results found by this search operation for this type. - `type` string, nullable — The name of the type for this search hit. - `score` number, double — The score of this search hit. - `entity` TaskListSearchModel - `id` string, uuid — The id of this entity. - `workspaceId` string, uuid — The workspace id of this entity. - `userStats` UserAccessStatistic[], nullable — The current user's access stats for this entity. - `userId` string, uuid — The id of the user that accessed this entity. - `openCount` integer — How many times the user accessed this entity. - `lastOpened` integer, nullable — The unix time of when the entity was last accessed by the user. - `indexTime` string, date-time — The last time this entity has been indexed. - `name` string, nullable — The name of the task list. - `project` ProjectEntity - `id` string, uuid — The id of this project. - `name` string, nullable — The name of the Project. Required. Max allowed length: 25000 characters. - `company` string, nullable — The company this project is for. - `isPrivate` boolean — Whether this is a private project only visible to members and the creator. - `isBillableByDefault` boolean, nullable — Whether project times should be billable by default. - `projectStatus` ProjectStatusEntity - `id` string, uuid — The id of this project status. - `name` string, nullable — The name of the project status. - `type` string, nullable — The general type of this project status. - `createdBy` string, uuid — The id of the user that created this project. - `teams` TeamEntity[], nullable — The teams this project belongs to. - `id` string, uuid — The id of this team. - `name` string, nullable — The name of the team. - `members` ProjectMemberEntity[], nullable — The members of this project. - `id` string, uuid — The id of this project member. - `userId` string, uuid — The id of the user that is member of this project. - `firstName` string, nullable — The first name of the user. - `lastName` string, nullable — The last name of the user. - `projectRoleName` string, nullable — The project role name of the project member. - `hasImage` boolean, nullable — Whether the user has an image. - `projectRoleId` string, uuid — The id of the project role. - `isExternal` boolean — Whether this project is external. - `isExternal` boolean — Whether this task list is external. - `highlights` object, nullable — The highlights of this search hit, by property. - `hasHits` boolean — Whether there are any hits at all, computed property. - `fileHits` FileSearchModelTypeSearchResult - `totalCount` integer — The count of search hits for this type. - `maxScore` number, double — The score of the best search hit for this type. - `hits` FileSearchModelHit[], nullable — The results found by this search operation for this type. - `type` string, nullable — The name of the type for this search hit. - `score` number, double — The score of this search hit. - `entity` FileSearchModel - `id` string, uuid — The id of this entity. - `workspaceId` string, uuid — The workspace id of this entity. - `userStats` UserAccessStatistic[], nullable — The current user's access stats for this entity. - `userId` string, uuid — The id of the user that accessed this entity. - `openCount` integer — How many times the user accessed this entity. - `lastOpened` integer, nullable — The unix time of when the entity was last accessed by the user. - `indexTime` string, date-time — The last time this entity has been indexed. - `name` string, nullable — The name of the file. - `createdBy` string, uuid — The id of the user that has created the file. - `entityType` string, nullable — The type of the entity that this file is attached to. - `entityId` string, uuid — The id of the entity that this file is attached to. - `project` ProjectEntity - `id` string, uuid — The id of this project. - `name` string, nullable — The name of the Project. Required. Max allowed length: 25000 characters. - `company` string, nullable — The company this project is for. - `isPrivate` boolean — Whether this is a private project only visible to members and the creator. - `isBillableByDefault` boolean, nullable — Whether project times should be billable by default. - `projectStatus` ProjectStatusEntity - `id` string, uuid — The id of this project status. - `name` string, nullable — The name of the project status. - `type` string, nullable — The general type of this project status. - `createdBy` string, uuid — The id of the user that created this project. - `teams` TeamEntity[], nullable — The teams this project belongs to. - `id` string, uuid — The id of this team. - `name` string, nullable — The name of the team. - `members` ProjectMemberEntity[], nullable — The members of this project. - `id` string, uuid — The id of this project member. - `userId` string, uuid — The id of the user that is member of this project. - `firstName` string, nullable — The first name of the user. - `lastName` string, nullable — The last name of the user. - `projectRoleName` string, nullable — The project role name of the project member. - `hasImage` boolean, nullable — Whether the user has an image. - `projectRoleId` string, uuid — The id of the project role. - `isExternal` boolean — Whether this project is external. - `task` BaseTaskEntity - `name` string, nullable — The name of the task. Max allowed length: 25000 characters. Required. - `id` string, uuid — The id of the parent task. - `userId` string, uuid, nullable — The user id this task belongs to in case this is a private task. - `createdBy` string, uuid — The id of the user that created this task. - `projectId` string, uuid, nullable — The id of the project this task is part of. - `project` ProjectEntity - `id` string, uuid — The id of this project. - `name` string, nullable — The name of the Project. Required. Max allowed length: 25000 characters. - `company` string, nullable — The company this project is for. - `isPrivate` boolean — Whether this is a private project only visible to members and the creator. - `isBillableByDefault` boolean, nullable — Whether project times should be billable by default. - `projectStatus` ProjectStatusEntity - … - `createdBy` string, uuid — The id of the user that created this project. - `teams` TeamEntity[], nullable — The teams this project belongs to. - … - `members` ProjectMemberEntity[], nullable — The members of this project. - … - `isExternal` boolean — Whether this project is external. - `parentId` string, uuid, nullable — The id of the parent task of this task, if this task is a subtask. - `parentTask` ParentTaskEntity - `name` string, nullable — The name of the task. Max allowed length: 25000 characters. Required. - `id` string, uuid — The id of the parent task. - `userId` string, uuid, nullable — The user id this task belongs to in case this is a private task. - `createdBy` string, uuid — The id of the user that created this task. - `assigneeIds` string[], nullable — The user ids this task is assigned to. - `assignees` TaskAssignmentEntity[], nullable — The assignees of the task. - `id` string, uuid — The assigned user's id. - `firstName` string, nullable — The assigned user's first name. - `lastName` string, nullable — The assigned user's last name. - `baseType` string, nullable — The base type of the task. - `taskStatus` TaskStatusEntity - `name` string, nullable — The name of the task status. - `type` string, nullable — The general type of this task status. - `icon` string, nullable — The icon of the task status. - `isExternal` boolean — Whether this task is external. - `isHiddenForConnectUsers` boolean - `isExternal` boolean — Whether this file is external. - `isHiddenForConnectUsers` boolean — Whether this comment is hidden for connect users. - `highlights` object, nullable — The highlights of this search hit, by property. - `hasHits` boolean — Whether there are any hits at all, computed property. - `documentHits` DocumentSearchModelTypeSearchResult - `totalCount` integer — The count of search hits for this type. - `maxScore` number, double — The score of the best search hit for this type. - `hits` DocumentSearchModelHit[], nullable — The results found by this search operation for this type. - `type` string, nullable — The name of the type for this search hit. - `score` number, double — The score of this search hit. - `entity` DocumentSearchModel - `id` string, uuid — The id of this entity. - `workspaceId` string, uuid — The workspace id of this entity. - `userStats` UserAccessStatistic[], nullable — The current user's access stats for this entity. - `userId` string, uuid — The id of the user that accessed this entity. - `openCount` integer — How many times the user accessed this entity. - `lastOpened` integer, nullable — The unix time of when the entity was last accessed by the user. - `indexTime` string, date-time — The last time this entity has been indexed. - `name` string, nullable — The name of the document. - `content` string, nullable — The content of the document. This is indexed for search and highlighting but not returned in search results. - `documentSpaceId` string, uuid, nullable — The id of the document space. - `documentSpace` DocumentSpaceEntity - `id` string, uuid - `isExternal` boolean - `name` string, nullable - `workspaceAccessLevel` string, nullable - `contributors` ContributorEntity[], nullable - `userId` string, uuid - `accessLevel` string, nullable - `teams` EntityToTeamEntity[], nullable - `teamId` string, uuid - `accessLevel` string, nullable - `parentId` string, uuid, nullable — The id of the document's parent document. - `emoji` string, nullable — The emoji of the document. - `projectId` string, uuid, nullable — The id of the project this document references. - `project` ProjectEntity - `id` string, uuid — The id of this project. - `name` string, nullable — The name of the Project. Required. Max allowed length: 25000 characters. - `company` string, nullable — The company this project is for. - `isPrivate` boolean — Whether this is a private project only visible to members and the creator. - `isBillableByDefault` boolean, nullable — Whether project times should be billable by default. - `projectStatus` ProjectStatusEntity - `id` string, uuid — The id of this project status. - `name` string, nullable — The name of the project status. - `type` string, nullable — The general type of this project status. - `createdBy` string, uuid — The id of the user that created this project. - `teams` TeamEntity[], nullable — The teams this project belongs to. - `id` string, uuid — The id of this team. - `name` string, nullable — The name of the team. - `members` ProjectMemberEntity[], nullable — The members of this project. - `id` string, uuid — The id of this project member. - `userId` string, uuid — The id of the user that is member of this project. - `firstName` string, nullable — The first name of the user. - `lastName` string, nullable — The last name of the user. - `projectRoleName` string, nullable — The project role name of the project member. - `hasImage` boolean, nullable — Whether the user has an image. - `projectRoleId` string, uuid — The id of the project role. - `isExternal` boolean — Whether this project is external. - `isPrivate` boolean — Whether the document is private. - `isExternal` boolean — Whether the document belongs to an external project. - `isHiddenForConnectUsers` boolean — Whether the document is hidden for connect users. - `contributors` DocumentContributorEntity[], nullable — The contributors of this document. - `userId` string, uuid - `accessLevel` string, nullable - `documentId` string, uuid - `inheritedFromDocumentContributorId` string, uuid, nullable - `inheritedDocumentContributor` InheritedDocumentContributorEntity - `documentId` string, uuid - `accessLevel` string, nullable - `teams` DocumentToTeamEntity[], nullable — The teams this document is connected to. - `teamId` string, uuid - `accessLevel` string, nullable - `documentId` string, uuid - `inheritedFromDocumentToTeamId` string, uuid, nullable - `inheritedDocumentToTeam` InheritedDocumentToTeamEntity - `documentId` string, uuid - `accessLevel` string, nullable - `workspaceAccessLevel` string, nullable — Determines the level of access to this document granted to all workspace users. Can be either not set (no access), `read`, or `manage`. - `inheritedWorkspaceAccessFromDocumentId` string, uuid, nullable — The id of the document the workspace access level permission has been inherited from. - `inheritedWorkspaceAccessFromDocument` InheritedWorkspaceAccessFromDocumentEntity - `workspaceAccessLevel` string, nullable - `rootDocumentCreatedBy` string, uuid - `highlights` object, nullable — The highlights of this search hit, by property. - `hasHits` boolean — Whether there are any hits at all, computed property. ## Other responses - `400` — Bad Request - `401` — Unauthorized --- [API](https://skmtc.net/awork-io/apis/api-v1-reference.md) · [All operations](https://skmtc.net/awork-io/apis/api-v1-reference/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/awork-io/api-v1-reference/versions/f784a53f60df/schema)