Search
Search everything at once.
On this page
Search everything
GET/search
Search people, projects, notes, tasks, documents, task lists and folders.
The best matches of each type, as the web omnibar finds them: people by name (prefix words, misspellings),
email, phone digits or link; projects by name (prefix words, misspellings) or reference, open ones first;
notes by title, tag names, mentioned people's and referenced projects' names, or text; tasks by title (prefix
words, misspellings), open ones first, then the most recently closed; documents by name (prefix words,
misspellings); task lists and folders by name (prefix words). Case and accents don't matter. One group per
requested type in this order (person, project, note, task, document, task_list, folder), empty ones included. Not paginated:
limit is per type, and has_more says there are more (for notes, page through them with GET /notes?q=).
Results are a snapshot to look up by id, not records to sync. A blank q gives empty groups. Expired tasks
are archived first.
curl "$NIFTY_URL/api/v1/search" \
-H "Authorization: Bearer $NIFTY_TOKEN"
Query parameters
| Name | Description |
|---|---|
qstring · optional | Longer, or containing a NUL, is 400. |
typesstring · optional | Comma-separated, e.g. person,note; the default is every type, person,project,note,task,document,task_list,folder. Anything else is 400. |
limitinteger · optional | Results per type. |
Response
200 OK Errors: 400 401 429
{
"data": [
{
"type": "person",
"results": [
{
"id": "01j9zq3k8m5x2v7c4n6b0t1r9e",
"title": "Kitchen renovation",
"subtitle": "Active · due 12 Nov",
"leading": {
"type": "avatar",
"url": "https://example.com"
}
}
],
"has_more": true
}
]
}