Skip to main content
List 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.

id

Returns only rows whose id is one of these. Repeatable.

Pattern: ^msg_[a-zA-Z0-9]{12}$
created_at[gte]
string<date-time>

RFC 3339. Returns only rows whose created_at is at or after this.

created_at[lte]
string<date-time>

RFC 3339. Returns only rows whose created_at is at or before this.

feed_id

Returns only rows whose feed_id is one of these. Repeatable.

Pattern: ^feed_[a-zA-Z0-9]{12}$
author_profile_id

Returns only rows whose author_profile_id is one of these. Repeatable.

Pattern: ^prof_[a-zA-Z0-9]{12}$
parent_message_id

Returns only rows whose parent_message_id is one of these. Repeatable.

Pattern: ^msg_[a-zA-Z0-9]{12}$
type
enum<string>

Returns only rows whose type is this. One of: post, comment.

Available options:
post,
comment
is_published
enum<string>

Returns only rows whose is_published is this. One of: true, false.

Available options:
true,
false
expand

Repeatable. Returns the named relation inline. One of: author, feed, cover_image_file, parent_message.

Available options:
author,
feed,
cover_image_file,
parent_message

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.