Skip to main content
List groups

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: ^grup_[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.

slug

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

visibility

Returns only rows whose visibility is one of these. Repeatable. One of: private, public.

Available options:
private,
public
search[contains]
string

Returns only rows whose search contains this.

membership_award_id

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

Pattern: ^awrd_[a-zA-Z0-9]{12}$
membership_award_id[is]
enum<string>

null returns only rows with no membership_award_id, notnull only rows that have one.

Available options:
null,
notnull
expand

Repeatable. Returns the named relation inline. One of: created_by, membership_award, banner_file.

Available options:
created_by,
membership_award,
banner_file

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.