Skip to main content
GET
cURL

Authorizations

Authorization
string
header
required

Authenticate with a workspace-pinned Floral personal access token.

Headers

X-Request-ID
string

Optional caller-generated correlation ID. Floral returns the effective value in X-Request-ID.

Required string length: 1 - 128

Path Parameters

workspaceSlug
string
required

Slug of the workspace pinned to the credential.

Required string length: 1 - 100
Pattern: ^[a-z0-9]+(?:-[a-z0-9]+)*$

Query Parameters

archived
enum<string>
default:exclude

Whether archived events are excluded, included, or the only ones returned.

Available options:
exclude,
include,
only
cursor
string

Opaque cursor returned as nextCursor by the previous page. Pass it back with the same filters; do not inspect or construct it.

Maximum string length: 512
finalisationState
enum<string>

Restrict results to one attendance finalisation state.

Available options:
NOT_FINALISED,
FINALISED
from
string<date>

Inclusive local date. Matches events whose local dates, in the event's own timezone, end on or after this date. Undated events never match a date range.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$
limit
integer
default:20

Number of items to return.

Required range: 1 <= x <= 50
ownerUserId
string

Restrict results to events owned by one workspace member.

Required string length: 1 - 255
planningStatus
enum<string>

Restrict results to one planning status.

Available options:
IDEA,
PLANNING,
READY,
HELD,
FOLLOW_UP,
EVALUATED,
CANCELLED
sort
enum<string>
default:starts-asc

Order by start time, undated events last, then by ID. The cursor is bound to the sort.

Available options:
starts-asc,
starts-desc
to
string<date>

Inclusive local date. Matches events whose local dates start on or before this date.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$

Response

Successful response

items
object[]
required
Maximum array length: 50
nextCursor
string | null
required
Required string length: 1 - 512