Skip to main content
List calendar events

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

status

Returns only rows whose status is one of these. Repeatable. One of: draft, needs_approval, published, cancelled.

Available options:
draft,
needs_approval,
published,
cancelled
title[contains]
string

Returns only rows whose title contains this.

start_date[gte]
string<date-time>

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

start_date[lte]
string<date-time>

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

end_date[gte]
string<date-time>

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

end_date[lte]
string<date-time>

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

is_unlisted
enum<string>

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

Available options:
true,
false
tag_id

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

Pattern: ^tags_[a-zA-Z0-9]{12}$
sort
enum<string>
default:-created_at

The order to list in, one of -created_at, start_date, -start_date: a field name sorts ascending, a leading - descending. Defaults to -created_at, newest first.

Available options:
-created_at,
start_date,
-start_date
expand

Repeatable. Returns the named relation inline. One of: cover_image_file, created_by, tag_links, slack_channels.

Available options:
cover_image_file,
created_by,
tag_links,
slack_channels

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.