v1

latestOpenAPI 3.0.02026-08-061478520.6 KB
[v3] Projects

Search in projects tree

Search in projects tree

post/v3/projects/search

Headers

Acceptstring
Example:application/json
Content-Typestring
Example:application/json

Request body

searchTextstring

Phrase to search for. At least one of searchText or userIds is required.

userIdsinteger[]

User IDs directly assigned to returned projects. At least one of searchText or userIds is required.

status'all' | 'active' required

Filter tasks by status

context'invoice' | 'time_tracking' | 'reports' | 'edit_settings' | 'create_subtask'

Project tree context

includestring[]

List of additional fields to include. Recognized extensions unavailable for the current account are ignored.

Example request

{
  "searchText": "searching for this",
  "userIds": [
    123,
    456
  ],
  "status": "active",
  "context": "time_tracking",
  "include": [
    "color",
    "users"
  ]
}

Response

OK

metaobject