Skip to main content
GET
/
{team_id}
/
search
Get search results
curl --request GET \
  --url https://api.superthread.com/v1/{team_id}/search \
  --header 'Authorization: Bearer <token>'
{
  "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
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://superthread.com/docs/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
team_id
string
required

Team ID is an alphanumerical string that identifies a Team. This is externally referred to as a "Workspace".

Query Parameters

​
query
string
required

Search query

​
cursor
string

cursor for pagination

​
count
integer

max number of items to return. defaults to 25

​
types
enum<string>

Types of object you would like to search against. includes all types if not specified

Available options:
boards,
cards,
pages,
projects
​
fields
enum<string>

Fields you would like to target in the free text search

Available options:
title,
content
​
archived
boolean

Whether or not to include archived data. defaults to false

​
statuses
enum<string>

Card statuses to filter by

Available options:
backlog,
committed,
started,
completed,
cancelled
​
project_id
string

Project ID is a numerical string that identifies a Project. This is externally referred to as a "Space".

​
grouped
boolean

Whether the results will be grouped by type (as opposed to all under the 'results' prop). defaults to true

​
highlight
boolean

Whether matching result text may include Elasticsearch highlight markup. defaults to false

Response

Search results

​
cursor
string
required
Example:

"dmsjqh9d8w1hdjosjaasda"

​
count
integer
required
Example:

14

​
results
object[]
​
boards
object[]
​
cards
object[]
​
pages
object[]
​
projects
object[]
​
epics
object[]
​
notes
object[]