Skip to main content
Search messages

Authorizations

Authorization
string
header
required

A Tightknit admin API key, sent as Authorization: Bearer <key>.

Query Parameters

limit
integer
default:20

How many rows to return, from 1 to 100.

Required range: 1 <= x <= 100
Example:

20

starting_after
string

Opaque cursor from a previous page’s next_cursor.

query
string
required

The words to find. Quotes match a phrase, OR either side, and a leading - excludes a word.

Required string length: 1 - 256
Example:

"onboarding checklist"

type
enum<string>
required

What to search. One of:

  • post: posts only.
  • comment: comments only.
Available options:
post,
comment
sort
enum<string>
default:relevance

How results are ordered. One of:

  • relevance: the best match first.
  • newest: the most recently written first.
Available options:
relevance,
newest

Response

Success

object
enum<string>
required

Always list.

Available options:
list
data
object[]
required

The rows on this page, in the order the list is read.

url
string
required

The path this list was read from.

next_cursor
string

Opaque cursor for the next page, to pass back as starting_after. Absent when no further pages exist, which is how a walk ends.