curl --request POST \
--url https://dovetail.com/api/v1/search \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"offset": 0,
"limit": 50,
"filter": {
"notes": [
{
"title": {
"contains": "<string>",
"equal_to": "<string>"
},
"authors": {
"overlaps": [
"<string>"
]
},
"content": {
"contains": "<string>",
"empty": true,
"equal_to": "<string>"
},
"created_at": {
"empty": true,
"equal_to": "2023-11-07T05:31:56Z",
"greater_than": "2023-11-07T05:31:56Z",
"less_than": "2023-11-07T05:31:56Z"
}
}
],
"tags": [
{
"title": {
"contains": "<string>",
"equal_to": "<string>"
},
"description": {
"contains": "<string>",
"empty": true,
"equal_to": "<string>"
},
"highlight_count": {
"equal_to": 123,
"greater_than": 123,
"less_than": 123
},
"created_at": {
"empty": true,
"equal_to": "2023-11-07T05:31:56Z",
"greater_than": "2023-11-07T05:31:56Z",
"less_than": "2023-11-07T05:31:56Z"
}
}
],
"highlights": [
{
"authors": {
"overlaps": [
"<string>"
]
},
"created_at": {
"empty": true,
"equal_to": "2023-11-07T05:31:56Z",
"greater_than": "2023-11-07T05:31:56Z",
"less_than": "2023-11-07T05:31:56Z"
},
"id": {
"empty": true,
"equal_to": "<string>",
"in": [
"<string>"
]
},
"text": {
"contains": "<string>",
"empty": true,
"equal_to": "<string>"
},
"note": {
"empty": true,
"equal_to": "<string>",
"in": [
"<string>"
]
},
"tags": {
"contains": [
"<string>"
],
"empty": true,
"overlaps": [
"<string>"
]
}
}
],
"insights": [
{
"authors": {
"overlaps": [
"<string>"
]
},
"created_at": {
"empty": true,
"equal_to": "2023-11-07T05:31:56Z",
"greater_than": "2023-11-07T05:31:56Z",
"less_than": "2023-11-07T05:31:56Z"
},
"id": {
"empty": true,
"equal_to": "<string>",
"in": [
"<string>"
]
},
"published": {
"equal_to": true
},
"published_at": {
"empty": true,
"equal_to": "2023-11-07T05:31:56Z",
"greater_than": "2023-11-07T05:31:56Z",
"less_than": "2023-11-07T05:31:56Z"
},
"title": {
"contains": "<string>",
"equal_to": "<string>"
},
"contributors": {
"overlaps": [
"<string>"
]
}
}
],
"channels": [
{
"title": {
"contains": "<string>",
"equal_to": "<string>"
},
"authors": {
"overlaps": [
"<string>"
]
},
"created_at": {
"empty": true,
"equal_to": "2023-11-07T05:31:56Z",
"greater_than": "2023-11-07T05:31:56Z",
"less_than": "2023-11-07T05:31:56Z"
}
}
],
"themes": [
{
"title": {
"contains": "<string>",
"equal_to": "<string>"
},
"created_at": {
"empty": true,
"equal_to": "2023-11-07T05:31:56Z",
"greater_than": "2023-11-07T05:31:56Z",
"less_than": "2023-11-07T05:31:56Z"
}
}
]
},
"query": ""
}'
{
"data": {
"total": 123,
"highlights": [
{
"id": "<string>",
"result_type": "HIGHLIGHT",
"preview_text": "<string>",
"note_id": "<string>",
"note_title": "<string>",
"author_id": "<string>",
"project_id": "<string>",
"project_title": "<string>",
"created_at": "<string>",
"updated_at": "<string>",
"tags": [
{
"title": "<string>",
"highlight_count": 123
}
]
}
],
"tags": [
{
"id": "<string>",
"result_type": "TAG",
"author_id": "<string>",
"title": "<string>",
"color": "<string>",
"highlight_count": 123,
"created_at": "<string>",
"updated_at": "<string>"
}
],
"notes": [
{
"id": "<string>",
"result_type": "NOTE",
"preview_text": "<string>",
"title": "<string>",
"author_id": "<string>",
"project_id": "<string>",
"project_title": "<string>",
"created_at": "<string>",
"updated_at": "<string>",
"fields": [
{
"label": "<string>",
"value": "<string>"
}
]
}
],
"insights": [
{
"id": "<string>",
"result_type": "INSIGHT",
"preview_text": "<string>",
"title": "<string>",
"author_id": "<string>",
"project_id": "<string>",
"project_title": "<string>",
"published": true,
"created_at": "<string>",
"updated_at": "<string>",
"fields": [
{
"label": "<string>",
"value": "<string>"
}
]
}
],
"channels": [
{
"id": "<string>",
"result_type": "CHANNEL",
"author_id": "<string>",
"title": "<string>",
"created_at": "<string>",
"updated_at": "<string>"
}
],
"themes": [
{
"id": "<string>",
"result_type": "THEME",
"title": "<string>",
"summary": "<string>",
"created_at": "<string>",
"updated_at": "<string>"
}
],
"offset": 123,
"limit": 123
}
}
Search a list of highlights, notes, insights, channels and/or themes.
curl --request POST \
--url https://dovetail.com/api/v1/search \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"offset": 0,
"limit": 50,
"filter": {
"notes": [
{
"title": {
"contains": "<string>",
"equal_to": "<string>"
},
"authors": {
"overlaps": [
"<string>"
]
},
"content": {
"contains": "<string>",
"empty": true,
"equal_to": "<string>"
},
"created_at": {
"empty": true,
"equal_to": "2023-11-07T05:31:56Z",
"greater_than": "2023-11-07T05:31:56Z",
"less_than": "2023-11-07T05:31:56Z"
}
}
],
"tags": [
{
"title": {
"contains": "<string>",
"equal_to": "<string>"
},
"description": {
"contains": "<string>",
"empty": true,
"equal_to": "<string>"
},
"highlight_count": {
"equal_to": 123,
"greater_than": 123,
"less_than": 123
},
"created_at": {
"empty": true,
"equal_to": "2023-11-07T05:31:56Z",
"greater_than": "2023-11-07T05:31:56Z",
"less_than": "2023-11-07T05:31:56Z"
}
}
],
"highlights": [
{
"authors": {
"overlaps": [
"<string>"
]
},
"created_at": {
"empty": true,
"equal_to": "2023-11-07T05:31:56Z",
"greater_than": "2023-11-07T05:31:56Z",
"less_than": "2023-11-07T05:31:56Z"
},
"id": {
"empty": true,
"equal_to": "<string>",
"in": [
"<string>"
]
},
"text": {
"contains": "<string>",
"empty": true,
"equal_to": "<string>"
},
"note": {
"empty": true,
"equal_to": "<string>",
"in": [
"<string>"
]
},
"tags": {
"contains": [
"<string>"
],
"empty": true,
"overlaps": [
"<string>"
]
}
}
],
"insights": [
{
"authors": {
"overlaps": [
"<string>"
]
},
"created_at": {
"empty": true,
"equal_to": "2023-11-07T05:31:56Z",
"greater_than": "2023-11-07T05:31:56Z",
"less_than": "2023-11-07T05:31:56Z"
},
"id": {
"empty": true,
"equal_to": "<string>",
"in": [
"<string>"
]
},
"published": {
"equal_to": true
},
"published_at": {
"empty": true,
"equal_to": "2023-11-07T05:31:56Z",
"greater_than": "2023-11-07T05:31:56Z",
"less_than": "2023-11-07T05:31:56Z"
},
"title": {
"contains": "<string>",
"equal_to": "<string>"
},
"contributors": {
"overlaps": [
"<string>"
]
}
}
],
"channels": [
{
"title": {
"contains": "<string>",
"equal_to": "<string>"
},
"authors": {
"overlaps": [
"<string>"
]
},
"created_at": {
"empty": true,
"equal_to": "2023-11-07T05:31:56Z",
"greater_than": "2023-11-07T05:31:56Z",
"less_than": "2023-11-07T05:31:56Z"
}
}
],
"themes": [
{
"title": {
"contains": "<string>",
"equal_to": "<string>"
},
"created_at": {
"empty": true,
"equal_to": "2023-11-07T05:31:56Z",
"greater_than": "2023-11-07T05:31:56Z",
"less_than": "2023-11-07T05:31:56Z"
}
}
]
},
"query": ""
}'
{
"data": {
"total": 123,
"highlights": [
{
"id": "<string>",
"result_type": "HIGHLIGHT",
"preview_text": "<string>",
"note_id": "<string>",
"note_title": "<string>",
"author_id": "<string>",
"project_id": "<string>",
"project_title": "<string>",
"created_at": "<string>",
"updated_at": "<string>",
"tags": [
{
"title": "<string>",
"highlight_count": 123
}
]
}
],
"tags": [
{
"id": "<string>",
"result_type": "TAG",
"author_id": "<string>",
"title": "<string>",
"color": "<string>",
"highlight_count": 123,
"created_at": "<string>",
"updated_at": "<string>"
}
],
"notes": [
{
"id": "<string>",
"result_type": "NOTE",
"preview_text": "<string>",
"title": "<string>",
"author_id": "<string>",
"project_id": "<string>",
"project_title": "<string>",
"created_at": "<string>",
"updated_at": "<string>",
"fields": [
{
"label": "<string>",
"value": "<string>"
}
]
}
],
"insights": [
{
"id": "<string>",
"result_type": "INSIGHT",
"preview_text": "<string>",
"title": "<string>",
"author_id": "<string>",
"project_id": "<string>",
"project_title": "<string>",
"published": true,
"created_at": "<string>",
"updated_at": "<string>",
"fields": [
{
"label": "<string>",
"value": "<string>"
}
]
}
],
"channels": [
{
"id": "<string>",
"result_type": "CHANNEL",
"author_id": "<string>",
"title": "<string>",
"created_at": "<string>",
"updated_at": "<string>"
}
],
"themes": [
{
"id": "<string>",
"result_type": "THEME",
"title": "<string>",
"summary": "<string>",
"created_at": "<string>",
"updated_at": "<string>"
}
],
"offset": 123,
"limit": 123
}
}
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Body
The body is of type object
.
200
The response is of type object
.
Was this page helpful?