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]+)*$
id
integer
required

Stable numeric resource ID.

Required range: x >= 1

Query Parameters

include
string

Pass sections to include the renderer-neutral section projection in the response. Omitted by default so existing strict clients are unaffected.

Allowed value: "sections"

Response

Successful response

briefing
object
required