Search in a project

GET /api/2.0/project/{id:[0-9]+}/@search/{query}

Request

Returns the search results for a project containing the words/phrases 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.
Content-Typeenum of string: Can be one of: application/json.

Path

querystring: Search query

Body

idinteger: Project ID

Examples

GET /api/2.0/project/%7Bid:[0-9]+%7D/@search/%7Bquery%7D HTTP/1.1
Accept: application/json
Content-Type: application/json
Host: example.com

curl --request GET \
  --url 'https://example.com/api/2.0/project/%7Bid:[0-9]+%7D/@search/%7Bquery%7D' \
  --header 'Accept: application/json' \
  --header 'Content-Type: 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