Search projects

GET /api/2.0/project/@search/{query}

Request

Returns a list of all the projects matching the query specified in the request.

Authorization

An API key is a token that you provide when making API calls. Include the token in a header parameter called Authorization.

Example: Authorization: 864FE52C-1C1C-469F-9308-51DAFEFE7436.

Headers

Acceptenum of string

Can be one of: application/json.

Path

querystring

Search query

Examples

GET /api/2.0/project/@search/%7Bquery%7D HTTP/1.1
Accept: application/json
Host: example.com
curl --request GET \
  --url https://example.com/api/2.0/project/@search/%7Bquery%7D \
  --header 'Accept: application/json'

Responses

200

List of results

Itemobject
Idstring
EntityTypeenum of integerformat: int32

[0 - Project, 1 - Milestone, 2 - Task, 3 - SubTask, 4 - Team, 5 - Comment, 6 - Message, 7 - File, 8 - TimeSpend]

Can be one of: Project, Milestone, Task, SubTask, Team, Comment, Message, File, TimeSpend.

Titlestring
Descriptionstring
Createdstring
Ownerobject
Idstring
EntityTypeenum of integerformat: int32

[0 - Project, 1 - Milestone, 2 - Task, 3 - SubTask, 4 - Team, 5 - Comment, 6 - Message, 7 - File, 8 - TimeSpend]

Can be one of: Project, Milestone, Task, SubTask, Team, Comment, Message, File, TimeSpend.

Titlestring
Descriptionstring
Createdstring

401

Unauthorized

Get Help

  • If you have any questions about ONLYOFFICE Workspace, try the FAQ section first.
  • You can request a feature or report a bug by posting an issue on GitHub.
  • You can also ask our developers on ONLYOFFICE forum (registration required).