GET/search.json

Search

Perform a search in one of several Projects settings.

With this call, the parameters seachFor and searchTerm are required. Your path will look like this:

/search.json?searchFor={resource}&searchTerm={search_term}

Eg. Seaching using tags:

To search for a resource with an attached tag of 'My Test', do the following: To search for a Tag, you use a hash symbol and square brackets in the searchTerm, like this : #[My Test] Then where performing a query to the API, you need to ASCII encode the # [ ] symbols, so a GET query to the API will look like this:

GET to /search.json?searchFor=messages&searchTerm=%23%5BMy+Test%5D

In the above example, #, [ and ] have been changed to %23, %5B and %5D respectively.

Resources that can be Searched:

  • projects
  • notebooks
  • files
  • tasks
  • tasklists
  • milestones
  • messages
  • links
  • events
  • people
  • companies
  • taskComments
  • fileComments
  • notebookComments
  • milestoneComments
  • linkComments

Query Params

  • Name
    projectId
    Type
    string
    Description
    The ProjectID you would like to search within
  • Name
    sortOrder
    Type
    string
    Description
    'name' or 'dateupdated' to decide the order of the search results
  • Name
    includeArchivedProjects
    Type
    string
    Description
    True or False to include archived items or not.
  • Name
    includeCompletedItems
    Type
    string
    Description
    True or False to include Completed items or not
  • Name
    pageSize
    Type
    string
    Description
    Define number of results to show, for example 20
  • Name
    searchFor
    Type
    string
    required
    Description
  • Name
    searchTerm
    Type
    string
    required
    Description

Responses

  • Code
    200
    Type
    object
    Schema
    Description
    200 Response

Examples

200 Response

application/json
{
  "searchResult": {
    "tasks": [
      {
        "taskListId": "1",
        "name": "(New hires) Re: Task",
        "companyName": "Teamwork",
        "projectName": "New hires",
        "projectId": "1",
        "taskEstimateMinutes": "0",
        "taskDisplayOrder": "2003",
        "taskParentTaskId": "",
        "lastUpdated": "2018-01-04T13:43:29Z",
        "tags": [
          {
            "name": "documentation",
            "id": "1",
            "color": "#2f8de4"
          }
        ],
        "taskProgress": "0",
        "id": "1",
        "completed": false,
        "taskListName": "Tasklist 1"
      }
    ],
    "moreAvailable": false
  },
  "STATUS": "OK"
}