Execute a search query across multiple workspace entities, including boards, cards, pages, and projects. Customize the search by specifying targeted fields like title or content, filtering by types of objects, or focusing on specific statuses. Additional options include filtering by project, controlling whether archived data is included, and choosing grouped or ungrouped results. This comprehensive search endpoint provides flexibility to locate relevant workspace data efficiently.
curl --request GET \
--url https://api.superthread.com/v1/{team_id}/search{
"cursor": "dmsjqh9d8w1hdjosjaasda",
"count": 14,
"results": [
{
"board": {
"id": "4",
"title": "New <em>features</em>",
"project_id": "2",
"archived": {
"user_id": "uDsu0j19",
"time_archived": 1608742037016
},
"layout": "board"
},
"page": {
"id": "24",
"icon": {
"type": "image",
"src": "data:image/png;base64, iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAYAAACNbyblAAAAHElEQVQI12P4//8/w38GIAXDIBKE0DHxgljNBAAO9TXL0Y4OHwAAAABJRU5ErkJggg==",
"id": "<string>",
"blurhash": "LEHV6nWB2yk8pyoJadR*.7kCMdnj",
"color": "black",
"emoji": "thumbsup"
},
"title": "Page <em>title</em>",
"project_id": "2",
"excerpt": "this is a <em>sample</em> page content",
"archived": {
"user_id": "uDsu0j19",
"time_archived": 1608742037016,
"parent_page_id": "<string>"
}
},
"card": {
"id": "13",
"title": "Implement new <em>service</em>",
"project_id": "2",
"board_id": "14",
"sprint_id": "1",
"board_title": "Ideas",
"list_id": "3",
"list_title": "Backlog",
"list_color": "<string>",
"status": "started",
"owner_id": "u123abcd",
"members": [
{
"user_id": "u-dsu0j19",
"assigned_date": 1608742037016,
"role": "admin"
}
],
"archived": {
"user_id": "uDsu0j19",
"time_archived": 1608742037016
},
"epic": {
"id": "e-123",
"title": "Epic Title",
"icon": {
"type": "image",
"src": "data:image/png;base64, iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAYAAACNbyblAAAAHElEQVQI12P4//8/w38GIAXDIBKE0DHxgljNBAAO9TXL0Y4OHwAAAABJRU5ErkJggg==",
"id": "<string>",
"blurhash": "LEHV6nWB2yk8pyoJadR*.7kCMdnj",
"color": "black",
"emoji": "thumbsup"
}
},
"parent_card": {
"title": "Implement service requirements",
"card_id": "42",
"list_color": "<string>",
"status": "started"
}
},
"project": {
"id": "2",
"icon": {
"type": "image",
"src": "data:image/png;base64, iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAYAAACNbyblAAAAHElEQVQI12P4//8/w38GIAXDIBKE0DHxgljNBAAO9TXL0Y4OHwAAAABJRU5ErkJggg==",
"id": "<string>",
"blurhash": "LEHV6nWB2yk8pyoJadR*.7kCMdnj",
"color": "black",
"emoji": "thumbsup"
},
"title": "Project <em>title</em>",
"total_members": 5,
"user_id": "u2DdoERz",
"time_created": 1608742037016,
"is_private": true
},
"epic": {
"id": "13",
"title": "Implement new <em>service</em>",
"list_id": "3",
"list_title": "Backlog",
"list_color": "<string>",
"status": "started",
"owner_id": "u123abcd",
"members": [
{
"user_id": "u-dsu0j19",
"assigned_date": 1608742037016,
"role": "admin"
}
],
"archived": {
"user_id": "uDsu0j19",
"time_archived": 1608742037016
},
"icon": {
"type": "image",
"src": "data:image/png;base64, iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAYAAACNbyblAAAAHElEQVQI12P4//8/w38GIAXDIBKE0DHxgljNBAAO9TXL0Y4OHwAAAABJRU5ErkJggg==",
"id": "<string>",
"blurhash": "LEHV6nWB2yk8pyoJadR*.7kCMdnj",
"color": "black",
"emoji": "thumbsup"
},
"type": "epic"
},
"note": {
"id": "21",
"title": "Page <em>title</em>",
"excerpt": "this is a <em>sample</em> note content",
"time_created": 1608742037016
}
}
],
"boards": [
{
"id": "4",
"title": "New <em>features</em>",
"project_id": "2",
"archived": {
"user_id": "uDsu0j19",
"time_archived": 1608742037016
},
"layout": "board"
}
],
"cards": [
{
"id": "13",
"title": "Implement new <em>service</em>",
"project_id": "2",
"board_id": "14",
"sprint_id": "1",
"board_title": "Ideas",
"list_id": "3",
"list_title": "Backlog",
"list_color": "<string>",
"status": "started",
"owner_id": "u123abcd",
"members": [
{
"user_id": "u-dsu0j19",
"assigned_date": 1608742037016,
"role": "admin"
}
],
"archived": {
"user_id": "uDsu0j19",
"time_archived": 1608742037016
},
"epic": {
"id": "e-123",
"title": "Epic Title",
"icon": {
"type": "image",
"src": "data:image/png;base64, iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAYAAACNbyblAAAAHElEQVQI12P4//8/w38GIAXDIBKE0DHxgljNBAAO9TXL0Y4OHwAAAABJRU5ErkJggg==",
"id": "<string>",
"blurhash": "LEHV6nWB2yk8pyoJadR*.7kCMdnj",
"color": "black",
"emoji": "thumbsup"
}
},
"parent_card": {
"title": "Implement service requirements",
"card_id": "42",
"list_color": "<string>",
"status": "started"
}
}
],
"pages": [
{
"id": "24",
"icon": {
"type": "image",
"src": "data:image/png;base64, iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAYAAACNbyblAAAAHElEQVQI12P4//8/w38GIAXDIBKE0DHxgljNBAAO9TXL0Y4OHwAAAABJRU5ErkJggg==",
"id": "<string>",
"blurhash": "LEHV6nWB2yk8pyoJadR*.7kCMdnj",
"color": "black",
"emoji": "thumbsup"
},
"title": "Page <em>title</em>",
"project_id": "2",
"excerpt": "this is a <em>sample</em> page content",
"archived": {
"user_id": "uDsu0j19",
"time_archived": 1608742037016,
"parent_page_id": "<string>"
}
}
],
"projects": [
{
"id": "2",
"icon": {
"type": "image",
"src": "data:image/png;base64, iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAYAAACNbyblAAAAHElEQVQI12P4//8/w38GIAXDIBKE0DHxgljNBAAO9TXL0Y4OHwAAAABJRU5ErkJggg==",
"id": "<string>",
"blurhash": "LEHV6nWB2yk8pyoJadR*.7kCMdnj",
"color": "black",
"emoji": "thumbsup"
},
"title": "Project <em>title</em>",
"total_members": 5,
"user_id": "u2DdoERz",
"time_created": 1608742037016,
"is_private": true
}
],
"epics": [
{
"id": "13",
"title": "Implement new <em>service</em>",
"list_id": "3",
"list_title": "Backlog",
"list_color": "<string>",
"status": "started",
"owner_id": "u123abcd",
"members": [
{
"user_id": "u-dsu0j19",
"assigned_date": 1608742037016,
"role": "admin"
}
],
"archived": {
"user_id": "uDsu0j19",
"time_archived": 1608742037016
},
"icon": {
"type": "image",
"src": "data:image/png;base64, iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAYAAACNbyblAAAAHElEQVQI12P4//8/w38GIAXDIBKE0DHxgljNBAAO9TXL0Y4OHwAAAABJRU5ErkJggg==",
"id": "<string>",
"blurhash": "LEHV6nWB2yk8pyoJadR*.7kCMdnj",
"color": "black",
"emoji": "thumbsup"
},
"type": "epic"
}
],
"notes": [
{
"id": "21",
"title": "Page <em>title</em>",
"excerpt": "this is a <em>sample</em> note content",
"time_created": 1608742037016
}
]
}Team ID is an alphanumerical string that identifies a Team. This is externally referred to as a "Workspace".
Search query
cursor for pagination
max number of items to return. defaults to 25
Types of object you would like to search against. includes all types if not specified
boards, cards, pages, projects Fields you would like to target in the free text search
title, content Whether or not to include archived data. defaults to false
Card statuses to filter by
backlog, committed, started, completed, cancelled Project ID is a numerical string that identifies a Project. This is externally referred to as a "Space".
Whether the results will be grouped by type (as opposed to all under the 'results' prop). defaults to true
Search results
"dmsjqh9d8w1hdjosjaasda"
14
Show child attributes
Show child attributes
"4"
"New <em>features</em>"
"2"
board, list, timeline, calendar "board"
Show child attributes
"24"
Show child attributes
image, icon, emoji Depending on the type this can be a URL, base64 image data, emoji unicode or an icon name
"data:image/png;base64, iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAYAAACNbyblAAAAHElEQVQI12P4//8/w38GIAXDIBKE0DHxgljNBAAO9TXL0Y4OHwAAAABJRU5ErkJggg=="
Unique identifier for the image (optional).
"LEHV6nWB2yk8pyoJadR*.7kCMdnj"
"black"
Emoji string ID
"thumbsup"
"Page <em>title</em>"
"2"
"this is a <em>sample</em> page content"
Show child attributes
"13"
"Implement new <em>service</em>"
"2"
"14"
"1"
"Ideas"
"3"
"Backlog"
committed, started, completed, cancelled "started"
"u123abcd"
brief view of epic to be used in a card
Show child attributes
epic id
"e-123"
epic title
"Epic Title"
Show child attributes
image, icon, emoji Depending on the type this can be a URL, base64 image data, emoji unicode or an icon name
"data:image/png;base64, iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAYAAACNbyblAAAAHElEQVQI12P4//8/w38GIAXDIBKE0DHxgljNBAAO9TXL0Y4OHwAAAABJRU5ErkJggg=="
Unique identifier for the image (optional).
"LEHV6nWB2yk8pyoJadR*.7kCMdnj"
"black"
Emoji string ID
"thumbsup"
Show child attributes
Show child attributes
"2"
Show child attributes
image, icon, emoji Depending on the type this can be a URL, base64 image data, emoji unicode or an icon name
"data:image/png;base64, iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAYAAACNbyblAAAAHElEQVQI12P4//8/w38GIAXDIBKE0DHxgljNBAAO9TXL0Y4OHwAAAABJRU5ErkJggg=="
Unique identifier for the image (optional).
"LEHV6nWB2yk8pyoJadR*.7kCMdnj"
"black"
Emoji string ID
"thumbsup"
"Project <em>title</em>"
5
"u2DdoERz"
unix timestamp in seconds
1608742037016
true
Show child attributes
"13"
"Implement new <em>service</em>"
"3"
"Backlog"
committed, started, completed, cancelled "started"
"u123abcd"
Show child attributes
image, icon, emoji Depending on the type this can be a URL, base64 image data, emoji unicode or an icon name
"data:image/png;base64, iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAYAAACNbyblAAAAHElEQVQI12P4//8/w38GIAXDIBKE0DHxgljNBAAO9TXL0Y4OHwAAAABJRU5ErkJggg=="
Unique identifier for the image (optional).
"LEHV6nWB2yk8pyoJadR*.7kCMdnj"
"black"
Emoji string ID
"thumbsup"
"epic"
Show child attributes
"4"
"New <em>features</em>"
"2"
board, list, timeline, calendar "board"
Show child attributes
"13"
"Implement new <em>service</em>"
"2"
"14"
"1"
"Ideas"
"3"
"Backlog"
committed, started, completed, cancelled "started"
"u123abcd"
brief view of epic to be used in a card
Show child attributes
epic id
"e-123"
epic title
"Epic Title"
Show child attributes
image, icon, emoji Depending on the type this can be a URL, base64 image data, emoji unicode or an icon name
"data:image/png;base64, iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAYAAACNbyblAAAAHElEQVQI12P4//8/w38GIAXDIBKE0DHxgljNBAAO9TXL0Y4OHwAAAABJRU5ErkJggg=="
Unique identifier for the image (optional).
"LEHV6nWB2yk8pyoJadR*.7kCMdnj"
"black"
Emoji string ID
"thumbsup"
Show child attributes
"24"
Show child attributes
image, icon, emoji Depending on the type this can be a URL, base64 image data, emoji unicode or an icon name
"data:image/png;base64, iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAYAAACNbyblAAAAHElEQVQI12P4//8/w38GIAXDIBKE0DHxgljNBAAO9TXL0Y4OHwAAAABJRU5ErkJggg=="
Unique identifier for the image (optional).
"LEHV6nWB2yk8pyoJadR*.7kCMdnj"
"black"
Emoji string ID
"thumbsup"
"Page <em>title</em>"
"2"
"this is a <em>sample</em> page content"
Show child attributes
"2"
Show child attributes
image, icon, emoji Depending on the type this can be a URL, base64 image data, emoji unicode or an icon name
"data:image/png;base64, iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAYAAACNbyblAAAAHElEQVQI12P4//8/w38GIAXDIBKE0DHxgljNBAAO9TXL0Y4OHwAAAABJRU5ErkJggg=="
Unique identifier for the image (optional).
"LEHV6nWB2yk8pyoJadR*.7kCMdnj"
"black"
Emoji string ID
"thumbsup"
"Project <em>title</em>"
5
"u2DdoERz"
unix timestamp in seconds
1608742037016
true
Show child attributes
"13"
"Implement new <em>service</em>"
"3"
"Backlog"
committed, started, completed, cancelled "started"
"u123abcd"
Show child attributes
image, icon, emoji Depending on the type this can be a URL, base64 image data, emoji unicode or an icon name
"data:image/png;base64, iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAYAAACNbyblAAAAHElEQVQI12P4//8/w38GIAXDIBKE0DHxgljNBAAO9TXL0Y4OHwAAAABJRU5ErkJggg=="
Unique identifier for the image (optional).
"LEHV6nWB2yk8pyoJadR*.7kCMdnj"
"black"
Emoji string ID
"thumbsup"
"epic"
curl --request GET \
--url https://api.superthread.com/v1/{team_id}/search{
"cursor": "dmsjqh9d8w1hdjosjaasda",
"count": 14,
"results": [
{
"board": {
"id": "4",
"title": "New <em>features</em>",
"project_id": "2",
"archived": {
"user_id": "uDsu0j19",
"time_archived": 1608742037016
},
"layout": "board"
},
"page": {
"id": "24",
"icon": {
"type": "image",
"src": "data:image/png;base64, iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAYAAACNbyblAAAAHElEQVQI12P4//8/w38GIAXDIBKE0DHxgljNBAAO9TXL0Y4OHwAAAABJRU5ErkJggg==",
"id": "<string>",
"blurhash": "LEHV6nWB2yk8pyoJadR*.7kCMdnj",
"color": "black",
"emoji": "thumbsup"
},
"title": "Page <em>title</em>",
"project_id": "2",
"excerpt": "this is a <em>sample</em> page content",
"archived": {
"user_id": "uDsu0j19",
"time_archived": 1608742037016,
"parent_page_id": "<string>"
}
},
"card": {
"id": "13",
"title": "Implement new <em>service</em>",
"project_id": "2",
"board_id": "14",
"sprint_id": "1",
"board_title": "Ideas",
"list_id": "3",
"list_title": "Backlog",
"list_color": "<string>",
"status": "started",
"owner_id": "u123abcd",
"members": [
{
"user_id": "u-dsu0j19",
"assigned_date": 1608742037016,
"role": "admin"
}
],
"archived": {
"user_id": "uDsu0j19",
"time_archived": 1608742037016
},
"epic": {
"id": "e-123",
"title": "Epic Title",
"icon": {
"type": "image",
"src": "data:image/png;base64, iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAYAAACNbyblAAAAHElEQVQI12P4//8/w38GIAXDIBKE0DHxgljNBAAO9TXL0Y4OHwAAAABJRU5ErkJggg==",
"id": "<string>",
"blurhash": "LEHV6nWB2yk8pyoJadR*.7kCMdnj",
"color": "black",
"emoji": "thumbsup"
}
},
"parent_card": {
"title": "Implement service requirements",
"card_id": "42",
"list_color": "<string>",
"status": "started"
}
},
"project": {
"id": "2",
"icon": {
"type": "image",
"src": "data:image/png;base64, iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAYAAACNbyblAAAAHElEQVQI12P4//8/w38GIAXDIBKE0DHxgljNBAAO9TXL0Y4OHwAAAABJRU5ErkJggg==",
"id": "<string>",
"blurhash": "LEHV6nWB2yk8pyoJadR*.7kCMdnj",
"color": "black",
"emoji": "thumbsup"
},
"title": "Project <em>title</em>",
"total_members": 5,
"user_id": "u2DdoERz",
"time_created": 1608742037016,
"is_private": true
},
"epic": {
"id": "13",
"title": "Implement new <em>service</em>",
"list_id": "3",
"list_title": "Backlog",
"list_color": "<string>",
"status": "started",
"owner_id": "u123abcd",
"members": [
{
"user_id": "u-dsu0j19",
"assigned_date": 1608742037016,
"role": "admin"
}
],
"archived": {
"user_id": "uDsu0j19",
"time_archived": 1608742037016
},
"icon": {
"type": "image",
"src": "data:image/png;base64, iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAYAAACNbyblAAAAHElEQVQI12P4//8/w38GIAXDIBKE0DHxgljNBAAO9TXL0Y4OHwAAAABJRU5ErkJggg==",
"id": "<string>",
"blurhash": "LEHV6nWB2yk8pyoJadR*.7kCMdnj",
"color": "black",
"emoji": "thumbsup"
},
"type": "epic"
},
"note": {
"id": "21",
"title": "Page <em>title</em>",
"excerpt": "this is a <em>sample</em> note content",
"time_created": 1608742037016
}
}
],
"boards": [
{
"id": "4",
"title": "New <em>features</em>",
"project_id": "2",
"archived": {
"user_id": "uDsu0j19",
"time_archived": 1608742037016
},
"layout": "board"
}
],
"cards": [
{
"id": "13",
"title": "Implement new <em>service</em>",
"project_id": "2",
"board_id": "14",
"sprint_id": "1",
"board_title": "Ideas",
"list_id": "3",
"list_title": "Backlog",
"list_color": "<string>",
"status": "started",
"owner_id": "u123abcd",
"members": [
{
"user_id": "u-dsu0j19",
"assigned_date": 1608742037016,
"role": "admin"
}
],
"archived": {
"user_id": "uDsu0j19",
"time_archived": 1608742037016
},
"epic": {
"id": "e-123",
"title": "Epic Title",
"icon": {
"type": "image",
"src": "data:image/png;base64, iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAYAAACNbyblAAAAHElEQVQI12P4//8/w38GIAXDIBKE0DHxgljNBAAO9TXL0Y4OHwAAAABJRU5ErkJggg==",
"id": "<string>",
"blurhash": "LEHV6nWB2yk8pyoJadR*.7kCMdnj",
"color": "black",
"emoji": "thumbsup"
}
},
"parent_card": {
"title": "Implement service requirements",
"card_id": "42",
"list_color": "<string>",
"status": "started"
}
}
],
"pages": [
{
"id": "24",
"icon": {
"type": "image",
"src": "data:image/png;base64, iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAYAAACNbyblAAAAHElEQVQI12P4//8/w38GIAXDIBKE0DHxgljNBAAO9TXL0Y4OHwAAAABJRU5ErkJggg==",
"id": "<string>",
"blurhash": "LEHV6nWB2yk8pyoJadR*.7kCMdnj",
"color": "black",
"emoji": "thumbsup"
},
"title": "Page <em>title</em>",
"project_id": "2",
"excerpt": "this is a <em>sample</em> page content",
"archived": {
"user_id": "uDsu0j19",
"time_archived": 1608742037016,
"parent_page_id": "<string>"
}
}
],
"projects": [
{
"id": "2",
"icon": {
"type": "image",
"src": "data:image/png;base64, iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAYAAACNbyblAAAAHElEQVQI12P4//8/w38GIAXDIBKE0DHxgljNBAAO9TXL0Y4OHwAAAABJRU5ErkJggg==",
"id": "<string>",
"blurhash": "LEHV6nWB2yk8pyoJadR*.7kCMdnj",
"color": "black",
"emoji": "thumbsup"
},
"title": "Project <em>title</em>",
"total_members": 5,
"user_id": "u2DdoERz",
"time_created": 1608742037016,
"is_private": true
}
],
"epics": [
{
"id": "13",
"title": "Implement new <em>service</em>",
"list_id": "3",
"list_title": "Backlog",
"list_color": "<string>",
"status": "started",
"owner_id": "u123abcd",
"members": [
{
"user_id": "u-dsu0j19",
"assigned_date": 1608742037016,
"role": "admin"
}
],
"archived": {
"user_id": "uDsu0j19",
"time_archived": 1608742037016
},
"icon": {
"type": "image",
"src": "data:image/png;base64, iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAYAAACNbyblAAAAHElEQVQI12P4//8/w38GIAXDIBKE0DHxgljNBAAO9TXL0Y4OHwAAAABJRU5ErkJggg==",
"id": "<string>",
"blurhash": "LEHV6nWB2yk8pyoJadR*.7kCMdnj",
"color": "black",
"emoji": "thumbsup"
},
"type": "epic"
}
],
"notes": [
{
"id": "21",
"title": "Page <em>title</em>",
"excerpt": "this is a <em>sample</em> note content",
"time_created": 1608742037016
}
]
}