Search items in the installation.

The search endpoint will return a list of items that match the given query.

Query Params

Name
updatedAfter
Type
string
Description
filter by items updated after the given date.
Default
5 years ago
Name
searchTerm
Type
string
Description
term to search for.
Name
orderBy
Type
string
Description
sets the result ordering.
Default
date
Allowed values
- relevance
- date
Name
cursor
Type
string
Description
cursor used for pagination.Using limit to control the number of items. If any other filter is modified during the cursor iteration the response will fallback to the first page.
Name
projectId
Type
integer
Description
filter by project id
Name
limit
Type
integer
Description
number of items to show when providing the cursor.
Default
50
Name
includeTentativeProjects
Type
boolean
Description
filter by include archived projects.
Default
false
Name
includeCompletedItems
Type
boolean
Description
include completed items in the response. This will target task, tasklist and milestone objects.
Default
false
Name
includeArchivedProjects
Type
boolean
Description
filter by include archived projects.
Default
false
Name
includeArchivedMessages
Type
boolean
Description
filter by include archived messages.
Default
false
Name
extendedSearch
Type
boolean
Description
extended search look for items updated more than 5 years ago.
Default
false
Name
types
Type
array[string]
Description
filter by types.
Default
all
Format
Comma separated values
Allowed values
- all
- projects
- tasks
- tasklists
- milestones
- notebooks
- messages
- links
- files
- comments
- taskcomments
- milestonecomments
- filecomments
- linkcomments
- notebookcomments
- users
- teams
- calendarevents
- companies
- timelogs
Name
include
Type
array[string]
Description
sideload additional data.
Format
Comma separated values
Allowed values
- projects
- tasks
- tasklists
- milestones
- notebooks
- messages
- links
- files
- fileversions
- comments
- users
- teams
- calendarevents
- companies
- timelogs
Name
fields[users]
Type
array[string]
Description
Format
Comma separated values
Allowed values
- id
- firstName
- lastName
- title
- email
- companyId
- company
- isAdmin
- isClientUser
- isServiceAccount
- type
- deleted
- avatarUrl
- lengthOfDay
- workingHoursId
- workingHour
- userRate
- userCost
- canAddProjects
Name
fields[timelogs]
Type
array[string]
Description
Format
Comma separated values
Allowed values
- id
- dateCreated
- minutes
- description
- timeLogged
- billable
- deleted
- dateDeleted
- hasStartTime
- dateEdited
- deskTicketId
- userId
- taskId
- projectId
- loggedByUserId
- deletedByUserId
- editedByUserId
- taskIdPreMove
- projectBillingInvoiceId
Name
fields[teams]
Type
array[string]
Description
Format
Comma separated values
Allowed values
- id
- name
- teamLogo
- teamLogoIcon
- teamLogoColor
Name
fields[tasks]
Type
array[string]
Description
Format
Comma separated values
Allowed values
- id
- name
- dateUpdated
- parentTaskId
- isPrivate
- status
- tasklistId
- startDate
- dueDate
Name
fields[tasklists]
Type
array[string]
Description
Format
Comma separated values
Allowed values
- id
- name
- projectId
- milestoneId
Name
fields[projects]
Type
array[string]
Description
Format
Comma separated values
Allowed values
- id
- name
- type
- status
- company
- companyId
- categoryId
- startPage
- logoIcon
- logoColor
- updatedAt
- isStarred
- allowNotifyAnyone
- notifyTaskAssignee
- isBillable
- timelogRequiresTask
Name
fields[notebooks]
Type
array[string]
Description
Format
Comma separated values
Allowed values
- id
- name
- description
- contents
- type
- isPrivate
- locked
- lockdownId
- secureContent
- projectId
- createdByUserID
- updatedByUserID
- deletedByUserID
- dateUpdated
- dateCreated
- dateDeleted
- deleted
- categoryId
- notebookVersionID
- notebookVersionCreatedDateTime
- notebookVersionUpdatedDateTime
- latestVersionNo
- commentsCount
- readCommentsCount
- contentHTML
- privacy
- commentFollowers
- changeFollowers
- projectNotifyCommentIncludeCreator
- tagIds
Name
fields[milestones]
Type
array[string]
Description
Format
Comma separated values
Allowed values
- id
- name
- description
- deadline
- completed
- projectId
- createdOn
- lastChangedOn
- creatorUserId
- reminder
- private
- lockdownId
- status
- completedOn
- completerId
- percentageComplete
Name
fields[messages]
Type
array[string]
Description
Format
Comma separated values
Allowed values
- id
- messageId
- title
Name
fields[links]
Type
array[string]
Description
Format
Comma separated values
Allowed values
- id
- title
- description
- code
- width
- height
- isPrivate
- provider
- projectId
- createdAt
- forceNewWindow
- deleted
- deletedAt
- updatedAt
- categoryId
- createdBy
- deletedBy
- updatedBy
Name
fields[fileversions]
Type
array[string]
Description
Format
Comma separated values
Allowed values
- fileVersionId
- fileId
- versionNo
- name
- originalName
- size
- uploadedBy
- uploadedAt
- description
- status
- projectId
- reactions
- commentsCount
- commentsCountRead
- displayName
Name
fields[files]
Type
array[string]
Description
Format
Comma separated values
Allowed values
- isPrivate
- latestFileVersionNo
- versionId
- status
- description
- lockdownId
- tagIds
- changeFollowers
- commentFollowers
- originalName
- displayName
- isLocked
- lockedByUserId
- lockedDate
- size
- uploadedDate
- uploadedByUserID
- updatedAt
- deletedAt
- deletedBy
- fileSource
- projectId
- numLikes
- reactions
- versions
- downloadURL
- previewURL
- thumbURL
- relatedItems
- commentsCount
- commentsCountRead
- categoryId
Name
fields[companies]
Type
array[string]
Description
Format
Comma separated values
Allowed values
- id
- name
- logoUploadedToServer
- logoImage
Name
fields[comments]
Type
array[string]
Description
Format
Comma separated values
Allowed values
- id
- objectType
- objectId
- title
Name
fields[calendarsEvents]
Type
array[string]
Description
Format
Comma separated values
Allowed values
- id
- iCalUID
- status
- htmlLink
- createdAt
- updatedAt
- summary
- description
- color
- createdBy
- organizer
- start
- end
- allDay
- attendees
- location
- transparency
- visibility
- recurrence
- reminders
- videoCallLink

Query Params

Responses

Examples

200 OK