Protected management API for administering spaces, teams, and content
Contact
Servers
List me
Update me
List users
Authorizations
Sanctum personal access token passed in Authorization header
Parameters
Path Parameters
The team identifier
"uuid"Responses
Successful response
Attach user to team
Attach user to team
Authorizations
Sanctum personal access token passed in Authorization header
Parameters
Path Parameters
The team identifier
"uuid"Responses
Successful response
Detach user from team
Update user role in team
Update user role in team
Authorizations
Sanctum personal access token passed in Authorization header
Parameters
Path Parameters
The team identifier
"uuid"Responses
Successful response
Create avatar
Create avatar
Authorizations
Sanctum personal access token passed in Authorization header
Parameters
Path Parameters
The team identifier
"uuid"Request Body
Responses
Successful response
Delete avatar
Authorizations
Sanctum personal access token passed in Authorization header
Parameters
Path Parameters
The team identifier
"uuid"Responses
Successful response
Social Links
List social links
Delete social link
List tokens
Authorizations
Sanctum personal access token passed in Authorization header
Parameters
Query Parameters
1100Responses
Successful response
Create tokens
Delete token
Display a listing of the tokens for a space
Display a listing of the tokens for a space.
Authorizations
Sanctum personal access token passed in Authorization header
Parameters
Path Parameters
The space identifier
"uuid"Query Parameters
Filter by name (LIKE search)
Filter by abilities
Filter by expires_at with range syntax (value1...value2)
Filter by creation date (supports operators and ranges)
Sort by field (prefix with - for descending order)
"name""-name""created_at""-created_at""expires_at""-expires_at""last_used_at""-last_used_at"Responses
Successful response
Store a newly created token in storage
Store a newly created token in storage.
Authorizations
Sanctum personal access token passed in Authorization header
Parameters
Path Parameters
The space identifier
"uuid"Request Body
Responses
Successful response
Remove the specified token from storage
Remove the specified token from storage.
Authorizations
Sanctum personal access token passed in Authorization header
Parameters
Path Parameters
The space identifier
"uuid"The token identifier
"uuid"Responses
Resource deleted successfully
Invites
Operations
List invites
Authorizations
Sanctum personal access token passed in Authorization header
Parameters
Query Parameters
Filter by email
Filter by role
Filter by status
Filter by space ID
Filter by team_id
Filter by creation date (supports operators and ranges)
Filter by expires_at with range syntax (value1...value2)
Sort by field (prefix with - for descending order)
"email""-email""roles.key""-roles.key""created_at""-created_at""expires_at""-expires_at"Responses
Successful response
Get a single invite
Authorizations
Sanctum personal access token passed in Authorization header
Parameters
Path Parameters
The invite identifier
"uuid"Responses
Successful response
Create accept
Authorizations
Sanctum personal access token passed in Authorization header
Parameters
Path Parameters
The invite identifier
"uuid"Request Body
Responses
Successful response
Create decline
Authorizations
Sanctum personal access token passed in Authorization header
Parameters
Path Parameters
The invite identifier
"uuid"Responses
Successful response
List invites
Authorizations
Sanctum personal access token passed in Authorization header
Parameters
Path Parameters
The team identifier
"uuid"Query Parameters
Filter by email
Filter by role
Filter by status
Filter by space ID
Filter by team_id
Filter by creation date (supports operators and ranges)
Filter by expires_at with range syntax (value1...value2)
Sort by field (prefix with - for descending order)
"email""-email""roles.key""-roles.key""created_at""-created_at""expires_at""-expires_at"Responses
Successful response
Create invites
Authorizations
Sanctum personal access token passed in Authorization header
Parameters
Path Parameters
The team identifier
"uuid"Request Body
Responses
Successful response
Delete invite
Authorizations
Sanctum personal access token passed in Authorization header
Parameters
Path Parameters
The team identifier
"uuid"The invite identifier
"uuid"Responses
Resource deleted successfully
Create resend
Authorizations
Sanctum personal access token passed in Authorization header
Parameters
Path Parameters
The team identifier
"uuid"The invite identifier
"uuid"Responses
Successful response
List invites
Authorizations
Sanctum personal access token passed in Authorization header
Parameters
Path Parameters
The space identifier
"uuid"Query Parameters
Filter by email
Filter by role
Filter by status
Filter by space ID
Filter by team_id
Filter by creation date (supports operators and ranges)
Filter by expires_at with range syntax (value1...value2)
Sort by field (prefix with - for descending order)
"email""-email""roles.key""-roles.key""created_at""-created_at""expires_at""-expires_at"Responses
Successful response
Create invites
Authorizations
Sanctum personal access token passed in Authorization header
Parameters
Path Parameters
The space identifier
"uuid"Request Body
Responses
Successful response
Delete invite
Authorizations
Sanctum personal access token passed in Authorization header
Parameters
Path Parameters
The space identifier
"uuid"The invite identifier
"uuid"Responses
Resource deleted successfully
Create resend
Authorizations
Sanctum personal access token passed in Authorization header
Parameters
Path Parameters
The space identifier
"uuid"The invite identifier
"uuid"Responses
Successful response
Get a single invite
Authorizations
Sanctum personal access token passed in Authorization header
Parameters
Path Parameters
The invite identifier
"uuid"Responses
Successful response
Notifications
Operations
List notifications
Authorizations
Sanctum personal access token passed in Authorization header
Responses
Successful response
Delete notifications
List unread count
Create read
Delete read
Update read
Authorizations
Sanctum personal access token passed in Authorization header
Parameters
Path Parameters
The notification identifier
Responses
Successful response
Update unread
Authorizations
Sanctum personal access token passed in Authorization header
Parameters
Path Parameters
The notification identifier
Responses
Successful response
Delete notification
List stats
List notes
Authorizations
Sanctum personal access token passed in Authorization header
Responses
Successful response
Create notes
Authorizations
Sanctum personal access token passed in Authorization header
Request Body
Responses
Successful response
Get a single note
Update note
Authorizations
Sanctum personal access token passed in Authorization header
Parameters
Path Parameters
The providerNote identifier
"uuid"Request Body
Responses
Successful response
Delete note
List available models
Authorizations
Sanctum personal access token passed in Authorization header
Parameters
Query Parameters
Filter by name (LIKE search)
Filter by model (LIKE search)
Free-text search filter.
Filter by provider (LIKE search)
Filter by is_free
Sort by field (prefix with - for descending order)
"name""-name""model""-model""provider""-provider""created_at""-created_at""updated_at""-updated_at"Responses
Successful response
List models
Create stream
Create stream
Create stream
Create stream
Get team hierarchy starting from specified parent (or root if null),
Get team hierarchy starting from specified parent (or root if null),
scoped to the teams the user may access (root sees everything).
Authorizations
Sanctum personal access token passed in Authorization header
Responses
Successful response
Display a listing of teams
Display a listing of teams
Authorizations
Sanctum personal access token passed in Authorization header
Parameters
Query Parameters
11Responses
Successful response
Store a newly created team
Store a newly created team
Authorizations
Sanctum personal access token passed in Authorization header
Request Body
Responses
Successful response
Display the specified team
Display the specified team
Authorizations
Sanctum personal access token passed in Authorization header
Parameters
Path Parameters
The team identifier
"uuid"Responses
Successful response
Update the specified team
Update the specified team
Authorizations
Sanctum personal access token passed in Authorization header
Parameters
Path Parameters
The team identifier
"uuid"Request Body
Responses
Successful response
Remove the specified team
List every blueprint the caller may start a space from
List every blueprint the caller may start a space from.
That is the system blueprints plus the ones owned by a team the caller
can reach, directly or through an ancestor team.
Authorizations
Sanctum personal access token passed in Authorization header
Parameters
Query Parameters
Filter by name (LIKE search)
Filter by team_id
Filter by created_by_id
Filter by creation date (supports operators and ranges)
Filter by update date (supports operators and ranges)
Sort by field (prefix with - for descending order)
"name""-name""created_at""-created_at""updated_at""-updated_at"Responses
Successful response
Create a blueprint that belongs to no team
Create a blueprint that belongs to no team.
Root only: the result is offered to every user on the instance.
Authorizations
Sanctum personal access token passed in Authorization header
Request Body
Responses
Successful response
Get a single blueprint that belongs to no team
Get a single blueprint that belongs to no team.
Authorizations
Sanctum personal access token passed in Authorization header
Parameters
Path Parameters
The blueprint identifier
"uuid"Responses
Successful response
Update a blueprint that belongs to no team
Update a blueprint that belongs to no team. Root only.
Authorizations
Sanctum personal access token passed in Authorization header
Parameters
Path Parameters
The blueprint identifier
"uuid"Request Body
Responses
Successful response
Delete a blueprint that belongs to no team
Delete a blueprint that belongs to no team. Root only.
Authorizations
Sanctum personal access token passed in Authorization header
Parameters
Path Parameters
The blueprint identifier
"uuid"Responses
Resource deleted successfully
List people
Authorizations
Sanctum personal access token passed in Authorization header
Parameters
Path Parameters
The team identifier
"uuid"Responses
Successful response
List people
Authorizations
Sanctum personal access token passed in Authorization header
Parameters
Path Parameters
The space identifier
"uuid"Responses
Successful response
List members
Authorizations
Sanctum personal access token passed in Authorization header
Parameters
Path Parameters
The team identifier
"uuid"Responses
Successful response
Delete member
Authorizations
Sanctum personal access token passed in Authorization header
Parameters
Path Parameters
The team identifier
"uuid"The user identifier
"uuid"Responses
Successful response
Update member
Authorizations
Sanctum personal access token passed in Authorization header
Parameters
Path Parameters
The team identifier
"uuid"The user identifier
"uuid"Responses
Successful response
List members
Authorizations
Sanctum personal access token passed in Authorization header
Parameters
Path Parameters
The space identifier
"uuid"Responses
Successful response
Delete member
Authorizations
Sanctum personal access token passed in Authorization header
Parameters
Path Parameters
The space identifier
"uuid"The user identifier
"uuid"Responses
Successful response
Update member
Authorizations
Sanctum personal access token passed in Authorization header
Parameters
Path Parameters
The space identifier
"uuid"The user identifier
"uuid"Responses
Successful response
List saml provider
Update saml provider
Authorizations
Sanctum personal access token passed in Authorization header
Parameters
Path Parameters
The team identifier
"uuid"Request Body
Responses
Successful response
Delete saml provider
List blueprints
Authorizations
Sanctum personal access token passed in Authorization header
Parameters
Path Parameters
The team identifier
"uuid"Query Parameters
Filter by name (LIKE search)
Filter by team_id
Filter by created_by_id
Filter by creation date (supports operators and ranges)
Filter by update date (supports operators and ranges)
Sort by field (prefix with - for descending order)
"name""-name""created_at""-created_at""updated_at""-updated_at"Responses
Successful response
Create blueprints
Authorizations
Sanctum personal access token passed in Authorization header
Parameters
Path Parameters
The team identifier
"uuid"Request Body
Responses
Successful response
Get a single blueprint
Authorizations
Sanctum personal access token passed in Authorization header
Parameters
Path Parameters
The team identifier
"uuid"The blueprint identifier
"uuid"Responses
Successful response
Update blueprint
Authorizations
Sanctum personal access token passed in Authorization header
Parameters
Path Parameters
The team identifier
"uuid"The blueprint identifier
"uuid"Request Body
Responses
Successful response
Delete blueprint
Authorizations
Sanctum personal access token passed in Authorization header
Parameters
Path Parameters
The team identifier
"uuid"The blueprint identifier
"uuid"Responses
Resource deleted successfully
List space
Authorizations
Sanctum personal access token passed in Authorization header
Parameters
Path Parameters
The team identifier
"uuid"Responses
Successful response
Create space
Authorizations
Sanctum personal access token passed in Authorization header
Parameters
Path Parameters
The team identifier
"uuid"Request Body
Responses
Successful response
Delete space
Authorizations
Sanctum personal access token passed in Authorization header
Parameters
Path Parameters
The team identifier
"uuid"The role identifier
"uuid"Responses
Resource deleted successfully
Update space
Authorizations
Sanctum personal access token passed in Authorization header
Parameters
Path Parameters
The team identifier
"uuid"The role identifier
"uuid"Request Body
Responses
Successful response
Display a listing of the spaces
Display a listing of the spaces.
Authorizations
Sanctum personal access token passed in Authorization header
Parameters
Query Parameters
Filter by name (LIKE search)
Filter by slug (LIKE search)
Filter by archived
Filter by creation date (supports operators and ranges)
Filter by update date (supports operators and ranges)
Sort by field (prefix with - for descending order)
"name""-name""slug""-slug""state""-state""created_at""-created_at""updated_at""-updated_at"Responses
Successful response
Store a newly created space in storage
Store a newly created space in storage.
Authorizations
Sanctum personal access token passed in Authorization header
Request Body
Responses
Successful response
Display the specified space
Display the specified space.
Authorizations
Sanctum personal access token passed in Authorization header
Parameters
Path Parameters
The space identifier
"uuid"Responses
Successful response
Update the specified space in storage
Update the specified space in storage.
Authorizations
Sanctum personal access token passed in Authorization header
Parameters
Path Parameters
The space identifier
"uuid"Request Body
Responses
Successful response
Remove the specified space from storage
Create icon
Dismiss or restore the onboarding guide
Dismiss or restore the onboarding guide.
Onboarding state is shared across the space: dismissing it hides the guide
for every member, so it is gated on the same ability as other space edits.
Authorizations
Sanctum personal access token passed in Authorization header
Parameters
Path Parameters
The space identifier
"uuid"Request Body
Responses
Successful response
List usage
Authorizations
Sanctum personal access token passed in Authorization header
Parameters
Path Parameters
The space identifier
"uuid"Responses
Successful response
The space's billing-period history (newest first), each with its usage rollup
The space's billing-period history (newest first), each with its usage rollup.
Authorizations
Sanctum personal access token passed in Authorization header
Parameters
Path Parameters
The space identifier
"uuid"Responses
Successful response
Daily traffic trend within a closed (or open) period, reconstructed
Daily traffic trend within a closed (or open) period, reconstructed
from the hourly rollup tables for the page chart.
Authorizations
Sanctum personal access token passed in Authorization header
Parameters
Path Parameters
The space identifier
"uuid"The period identifier
"uuid"Responses
Successful response
Ai Settings
List ai settings
Update ai settings
Authorizations
Sanctum personal access token passed in Authorization header
Parameters
Path Parameters
The space identifier
"uuid"Request Body
Responses
Successful response
List ai configs
Create ai configs
Get a single ai config
Authorizations
Sanctum personal access token passed in Authorization header
Parameters
Path Parameters
The space identifier
"uuid"The aiConfig identifier
"uuid"Responses
Successful response
Delete ai config
Authorizations
Sanctum personal access token passed in Authorization header
Parameters
Path Parameters
The space identifier
"uuid"The aiConfig identifier
"uuid"Responses
Successful response
Update ai config
Authorizations
Sanctum personal access token passed in Authorization header
Parameters
Path Parameters
The space identifier
"uuid"The aiConfig identifier
"uuid"Responses
Successful response
Update search
Create reindex
Blocks
Operations
Sync a full set of block definitions against the space
Sync a full set of block definitions against the space.
Upserts blocks keyed by external_id (falling back to slug for adoption),
optionally pruning blocks absent from the payload. Supports dry runs.
Authorizations
Sanctum personal access token passed in Authorization header
Parameters
Path Parameters
The space identifier
"uuid"Responses
Successful response
Display a listing of the blocks
Display a listing of the blocks.
Authorizations
Sanctum personal access token passed in Authorization header
Parameters
Path Parameters
The space identifier
"uuid"Query Parameters
Filter by name (LIKE search)
Filter by slug (LIKE search)
Filter by folder ID
Filter by is_nestable
Filter by is_root
Filter by tags
Filter by creation date (supports operators and ranges)
Filter by update date (supports operators and ranges)
Sort by field (prefix with - for descending order)
"name""-name""slug""-slug""is_nestable""-is_nestable""is_root""-is_root""created_at""-created_at""updated_at""-updated_at"Responses
Successful response
Store a newly created block in storage
Store a newly created block in storage.
Authorizations
Sanctum personal access token passed in Authorization header
Parameters
Path Parameters
The space identifier
"uuid"Responses
Successful response
Display the specified block
Display the specified block.
Authorizations
Sanctum personal access token passed in Authorization header
Parameters
Path Parameters
The space identifier
"uuid"The block identifier
"uuid"Responses
Successful response
Update the specified block in storage
Update the specified block in storage.
Authorizations
Sanctum personal access token passed in Authorization header
Parameters
Path Parameters
The space identifier
"uuid"The block identifier
"uuid"Responses
Successful response
Remove the specified block from storage
Remove the specified block from storage.
Authorizations
Sanctum personal access token passed in Authorization header
Parameters
Path Parameters
The space identifier
"uuid"The block identifier
"uuid"Responses
Resource deleted successfully
List templates
Authorizations
Sanctum personal access token passed in Authorization header
Parameters
Path Parameters
The space identifier
"uuid"The block identifier
"uuid"Query Parameters
Filter by name (LIKE search)
Filter by creation date (supports operators and ranges)
Filter by update date (supports operators and ranges)
Sort by field (prefix with - for descending order)
"name""-name""created_at""-created_at""updated_at""-updated_at"Responses
Successful response
Create templates
Authorizations
Sanctum personal access token passed in Authorization header
Parameters
Path Parameters
The space identifier
"uuid"The block identifier
"uuid"Responses
Successful response
Get a single template
Authorizations
Sanctum personal access token passed in Authorization header
Parameters
Path Parameters
The space identifier
"uuid"The block identifier
"uuid"The template identifier
"uuid"Responses
Successful response
Update template
Authorizations
Sanctum personal access token passed in Authorization header
Parameters
Path Parameters
The space identifier
"uuid"The block identifier
"uuid"The template identifier
"uuid"Request Body
Responses
Successful response
Delete template
Authorizations
Sanctum personal access token passed in Authorization header
Parameters
Path Parameters
The space identifier
"uuid"The block identifier
"uuid"The template identifier
"uuid"Responses
Resource deleted successfully
List versions
Authorizations
Sanctum personal access token passed in Authorization header
Parameters
Path Parameters
The space identifier
"uuid"The block identifier
"uuid"Query Parameters
Filter by commit_message (LIKE search)
Filter by creation date (supports operators and ranges)
Sort by field (prefix with - for descending order)
"created_at""-created_at"Responses
Successful response
Get a single version
Authorizations
Sanctum personal access token passed in Authorization header
Parameters
Path Parameters
The space identifier
"uuid"The block identifier
"uuid"The version identifier
"uuid"Responses
Successful response
Delete version
Authorizations
Sanctum personal access token passed in Authorization header
Parameters
Path Parameters
The space identifier
"uuid"The block identifier
"uuid"The version identifier
"uuid"Responses
Resource deleted successfully
Update version
Authorizations
Sanctum personal access token passed in Authorization header
Parameters
Path Parameters
The space identifier
"uuid"The block identifier
"uuid"The version identifier
"uuid"Request Body
Responses
Successful response
Create restore
Authorizations
Sanctum personal access token passed in Authorization header
Parameters
Path Parameters
The space identifier
"uuid"The block identifier
"uuid"The version identifier
"uuid"Responses
Successful response
List block tags
Authorizations
Sanctum personal access token passed in Authorization header
Parameters
Path Parameters
The space identifier
"uuid"Responses
Successful response
Create block tags
Authorizations
Sanctum personal access token passed in Authorization header
Parameters
Path Parameters
The space identifier
"uuid"Responses
Successful response
Get a single block tag
Authorizations
Sanctum personal access token passed in Authorization header
Parameters
Path Parameters
The space identifier
"uuid"The tag identifier
"uuid"Responses
Successful response
Update block tag
Authorizations
Sanctum personal access token passed in Authorization header
Parameters
Path Parameters
The space identifier
"uuid"The tag identifier
"uuid"Responses
Successful response
Delete block tag
Authorizations
Sanctum personal access token passed in Authorization header
Parameters
Path Parameters
The space identifier
"uuid"The tag identifier
"uuid"Responses
Resource deleted successfully
List block folders
Authorizations
Sanctum personal access token passed in Authorization header
Parameters
Path Parameters
The space identifier
"uuid"Responses
Successful response
Create block folders
Authorizations
Sanctum personal access token passed in Authorization header
Parameters
Path Parameters
The space identifier
"uuid"Responses
Successful response
Get a single block folder
Authorizations
Sanctum personal access token passed in Authorization header
Parameters
Path Parameters
The space identifier
"uuid"The folder identifier
"uuid"Responses
Successful response
Update block folder
Authorizations
Sanctum personal access token passed in Authorization header
Parameters
Path Parameters
The space identifier
"uuid"The folder identifier
"uuid"Responses
Successful response
Delete block folder
Authorizations
Sanctum personal access token passed in Authorization header
Parameters
Path Parameters
The space identifier
"uuid"The folder identifier
"uuid"Responses
Resource deleted successfully
Contents
Operations
Display a listing of the content items
Display a listing of the content items.
Authorizations
Sanctum personal access token passed in Authorization header
Parameters
Path Parameters
The space identifier
"uuid"Query Parameters
Filter by publication date and time.
">=2024-01-01T00:00:00Z""date-time"Filter by last update date and time.
"2024-01-01T00:00:00Z...2024-01-31T23:59:59Z""date-time"Filter by creation date and time.
"<2024-06-01T00:00:00Z""date-time"Filter by content language ISO code.
"en"Filter by content language ISO code.
"en"Filter by block type slug used by the content entry.
"page"Filter by parent content identifier.
"01J123ABC456DEF789GHIJKLMN"Filter by content identifier.
"01J123ABC456DEF789GHIJKLMN"Filter by canonical content identifier, including all translations.
"01J123ABC456DEF789GHIJKLMN"Filter by canonical parent identifier, including children of translated parent variants.
"01J123ABC456DEF789GHIJKLMN"Include canonical content without a translation in the requested language.
trueSort by a supported field. Prefix with - for descending order.
"position""-position""published_at""-published_at""updated_at""-updated_at""created_at""-created_at"Responses
Successful response
Store a newly created content item in storage
Store a newly created content item in storage.
Authorizations
Sanctum personal access token passed in Authorization header
Parameters
Path Parameters
The space identifier
"uuid"Responses
Successful response
Display the specified content item
Display the specified content item.
Authorizations
Sanctum personal access token passed in Authorization header
Parameters
Path Parameters
The space identifier
"uuid"The content identifier
"uuid"Responses
Successful response
Update the specified content item in storage
Update the specified content item in storage.
Authorizations
Sanctum personal access token passed in Authorization header
Parameters
Path Parameters
The space identifier
"uuid"The content identifier
"uuid"Responses
Successful response
Remove the specified content item from storage
Remove the specified content item from storage.
Authorizations
Sanctum personal access token passed in Authorization header
Parameters
Path Parameters
The space identifier
"uuid"The content identifier
"uuid"Responses
Resource deleted successfully
Create bulk create
Create tree operations
The values a new entry of a block would receive for its generated fields
The values a new entry of a block would receive for its generated fields.
Deliberately a peek and not a reservation: allocating when a create dialog
opens would burn a number every time someone changes their mind. The preview
can therefore go stale if another editor creates an entry in the same scope
first — the entry shows its real value immediately after it is created.
Authorizations
Sanctum personal access token passed in Authorization header
Parameters
Path Parameters
The space identifier
"uuid"Responses
Successful response
Create move
Authorizations
Sanctum personal access token passed in Authorization header
Parameters
Path Parameters
The space identifier
"uuid"The content identifier
"uuid"Responses
Successful response
Create export
Authorizations
Sanctum personal access token passed in Authorization header
Parameters
Path Parameters
The space identifier
"uuid"Request Body
Responses
Successful response
Create import
Authorizations
Sanctum personal access token passed in Authorization header
Parameters
Path Parameters
The space identifier
"uuid"Request Body
Responses
Successful response
Create an entry and publish it in one round trip
Create an entry and publish it in one round trip.
A new language version only exists client side until it is saved, so the
publish route — which binds an existing {content} — cannot reach it. Without
this endpoint a translation has to be saved before it can go live, which is
an extra step for the editor and leaves an unpublished row behind whenever
the publish then fails.
Create and publish share one transaction: publish validation is stricter than
save validation, so a failure here must not leave the just-created draft
behind.
Authorizations
Sanctum personal access token passed in Authorization header
Parameters
Path Parameters
The space identifier
"uuid"Responses
Successful response
Create publish
Authorizations
Sanctum personal access token passed in Authorization header
Parameters
Path Parameters
The space identifier
"uuid"The content identifier
"uuid"Responses
Successful response
Create unpublish
Authorizations
Sanctum personal access token passed in Authorization header
Parameters
Path Parameters
The space identifier
"uuid"The content identifier
"uuid"Responses
Successful response
Create schedule
Authorizations
Sanctum personal access token passed in Authorization header
Parameters
Path Parameters
The space identifier
"uuid"The content identifier
"uuid"Responses
Successful response
Get root comments for content
Get root comments for content
Authorizations
Sanctum personal access token passed in Authorization header
Parameters
Path Parameters
The space identifier
"uuid"The content identifier
"uuid"Query Parameters
Filter by content_id
Filter by content_version_id
Filter by author_id
Filter by is_resolved
Filter by item_id
Filter by field
Free-text search filter.
Filter by creation date (supports operators and ranges)
Filter by update date (supports operators and ranges)
Sort by field (prefix with - for descending order)
"created_at""-created_at""updated_at""-updated_at""is_resolved""-is_resolved"Responses
Successful response
Create a root comment or reply
Create a root comment or reply
Authorizations
Sanctum personal access token passed in Authorization header
Parameters
Path Parameters
The space identifier
"uuid"The content identifier
"uuid"Responses
Successful response
Get a specific comment (root or reply)
Get a specific comment (root or reply)
Authorizations
Sanctum personal access token passed in Authorization header
Parameters
Path Parameters
The space identifier
"uuid"The content identifier
"uuid"The comment identifier
"uuid"Responses
Successful response
Delete a comment (root or reply)
Delete a comment (root or reply)
Authorizations
Sanctum personal access token passed in Authorization header
Parameters
Path Parameters
The space identifier
"uuid"The content identifier
"uuid"The comment identifier
"uuid"Responses
Resource deleted successfully
Update a comment (root or reply)
Update a comment (root or reply)
Authorizations
Sanctum personal access token passed in Authorization header
Parameters
Path Parameters
The space identifier
"uuid"The content identifier
"uuid"The comment identifier
"uuid"Request Body
Responses
Successful response
Resolve a comment
Resolve a comment
Authorizations
Sanctum personal access token passed in Authorization header
Parameters
Path Parameters
The space identifier
"uuid"The content identifier
"uuid"The comment identifier
"uuid"Responses
Successful response
Unresolve a comment
Unresolve a comment
Authorizations
Sanctum personal access token passed in Authorization header
Parameters
Path Parameters
The space identifier
"uuid"The content identifier
"uuid"The comment identifier
"uuid"Responses
Successful response
List reactions
Authorizations
Sanctum personal access token passed in Authorization header
Parameters
Path Parameters
The space identifier
"uuid"The content identifier
"uuid"The comment identifier
"uuid"Responses
Successful response
Create reactions
Authorizations
Sanctum personal access token passed in Authorization header
Parameters
Path Parameters
The space identifier
"uuid"The content identifier
"uuid"The comment identifier
"uuid"Request Body
Responses
Successful response
Delete reactions
Authorizations
Sanctum personal access token passed in Authorization header
Parameters
Path Parameters
The space identifier
"uuid"The content identifier
"uuid"The comment identifier
"uuid"Request Body
Responses
Resource deleted successfully
List versions
Authorizations
Sanctum personal access token passed in Authorization header
Parameters
Path Parameters
The space identifier
"uuid"The content identifier
"uuid"Query Parameters
Filter by creation date (supports operators and ranges)
Filter by external_id
Filter by created_by
Filter by release_id
Filter by isPublished
Filter by isCurrentVersion
Sort by field (prefix with - for descending order)
"created_at""-created_at"Responses
Successful response
Get a single version
Authorizations
Sanctum personal access token passed in Authorization header
Parameters
Path Parameters
The space identifier
"uuid"The content identifier
"uuid"The version identifier
"uuid"Responses
Successful response
Update version
Authorizations
Sanctum personal access token passed in Authorization header
Parameters
Path Parameters
The space identifier
"uuid"The content identifier
"uuid"The version identifier
"uuid"Responses
Successful response
Create publish
Authorizations
Sanctum personal access token passed in Authorization header
Parameters
Path Parameters
The space identifier
"uuid"The content identifier
"uuid"The version identifier
"uuid"Responses
Successful response
Create current
Authorizations
Sanctum personal access token passed in Authorization header
Parameters
Path Parameters
The space identifier
"uuid"The content identifier
"uuid"The version identifier
"uuid"Responses
Successful response
List audit logs
Authorizations
Sanctum personal access token passed in Authorization header
Parameters
Path Parameters
The space identifier
"uuid"Query Parameters
Filter by creation date (supports operators and ranges)
Filter by owner_type
Filter by owner
Filter by operation
Filter by referenced_type
Filter by name (LIKE search)
Sort by field (prefix with - for descending order)
"created_at""-created_at""owner_name""-owner_name""operation""-operation""referenced_type""-referenced_type""name""-name"Responses
Successful response
Redirects
Operations
List redirects
Authorizations
Sanctum personal access token passed in Authorization header
Parameters
Path Parameters
The space identifier
"uuid"Query Parameters
Filter by source
Filter by target
Filter by status_code
Free-text search filter.
Sort by field (prefix with - for descending order)
"source""-source""target""-target""status_code""-status_code"Responses
Successful response
Create redirects
Authorizations
Sanctum personal access token passed in Authorization header
Parameters
Path Parameters
The space identifier
"uuid"Responses
Successful response
Get a single redirect
Authorizations
Sanctum personal access token passed in Authorization header
Parameters
Path Parameters
The space identifier
"uuid"The redirect identifier
"uuid"Responses
Successful response
Update redirect
Authorizations
Sanctum personal access token passed in Authorization header
Parameters
Path Parameters
The space identifier
"uuid"The redirect identifier
"uuid"Responses
Successful response
Delete redirect
Authorizations
Sanctum personal access token passed in Authorization header
Parameters
Path Parameters
The space identifier
"uuid"The redirect identifier
"uuid"Responses
Resource deleted successfully
Create reset
Authorizations
Sanctum personal access token passed in Authorization header
Parameters
Path Parameters
The space identifier
"uuid"The redirect identifier
"uuid"Responses
Successful response
Create export
Authorizations
Sanctum personal access token passed in Authorization header
Parameters
Path Parameters
The space identifier
"uuid"Query Parameters
Filter by source
Filter by target
Filter by status_code
Free-text search filter.
Sort by field (prefix with - for descending order)
"source""-source""target""-target""status_code""-status_code"Request Body
Responses
Successful response
Create import
Authorizations
Sanctum personal access token passed in Authorization header
Parameters
Path Parameters
The space identifier
"uuid"Request Body
Responses
Successful response
Get the content tree structure for menu navigation
Get the content tree structure for menu navigation.
Authorizations
Sanctum personal access token passed in Authorization header
Parameters
Path Parameters
The space identifier
"uuid"Query Parameters
Filter by name (LIKE search)
Filter by slug (LIKE search)
Filter by block_id
Filter by parent ID
Sort by field (prefix with - for descending order)
"name""-name""slug""-slug""language_iso""-language_iso""position""-position""published_at""-published_at""created_at""-created_at""updated_at""-updated_at"Responses
Successful response
Get dashboard statistics for a space
Asset Folders
Operations
Display a listing of asset folders
Display a listing of asset folders.
Authorizations
Sanctum personal access token passed in Authorization header
Parameters
Path Parameters
The space identifier
"uuid"Responses
Successful response
Store a newly created asset folder
Store a newly created asset folder.
Authorizations
Sanctum personal access token passed in Authorization header
Parameters
Path Parameters
The space identifier
"uuid"Responses
Successful response
Display the specified asset folder
Display the specified asset folder.
Authorizations
Sanctum personal access token passed in Authorization header
Parameters
Path Parameters
The space identifier
"uuid"Responses
Successful response
Update the specified asset folder
Update the specified asset folder.
Authorizations
Sanctum personal access token passed in Authorization header
Parameters
Path Parameters
The space identifier
"uuid"Responses
Successful response
Remove the specified asset folder
Remove the specified asset folder.
Authorizations
Sanctum personal access token passed in Authorization header
Parameters
Path Parameters
The space identifier
"uuid"Responses
Resource deleted successfully
Mirrors a dropped folder tree into asset folders: every requested path is
Mirrors a dropped folder tree into asset folders: every requested path is
resolved to a folder id, creating missing folders along the way.
Authorizations
Sanctum personal access token passed in Authorization header
Parameters
Path Parameters
The space identifier
"uuid"Responses
Successful response
List asset tags
Authorizations
Sanctum personal access token passed in Authorization header
Parameters
Path Parameters
The space identifier
"uuid"Responses
Successful response
Create asset tags
Authorizations
Sanctum personal access token passed in Authorization header
Parameters
Path Parameters
The space identifier
"uuid"Responses
Successful response
Get a single asset tag
Authorizations
Sanctum personal access token passed in Authorization header
Parameters
Path Parameters
The space identifier
"uuid"The tag identifier
"uuid"Responses
Successful response
Update asset tag
Authorizations
Sanctum personal access token passed in Authorization header
Parameters
Path Parameters
The space identifier
"uuid"The tag identifier
"uuid"Responses
Successful response
Delete asset tag
Authorizations
Sanctum personal access token passed in Authorization header
Parameters
Path Parameters
The space identifier
"uuid"The tag identifier
"uuid"Responses
Resource deleted successfully
Create assign
Authorizations
Sanctum personal access token passed in Authorization header
Parameters
Path Parameters
The space identifier
"uuid"The tag identifier
"uuid"Responses
Successful response
Assets
Operations
List linked contents
Authorizations
Sanctum personal access token passed in Authorization header
Parameters
Path Parameters
The space identifier
"uuid"The asset identifier
"uuid"Responses
Successful response
Replace the physical file of an existing asset (keeps ID, busts CDN cache via new filename)
Replace the physical file of an existing asset (keeps ID, busts CDN cache via new filename).
Authorizations
Sanctum personal access token passed in Authorization header
Parameters
Path Parameters
The space identifier
"uuid"The asset identifier
"uuid"Request Body
Responses
Successful response
Upload a custom poster/thumbnail for a non-image asset
Upload a custom poster/thumbnail for a non-image asset.
The image is shown in place of the generated video frames or the
file-type icon.
Authorizations
Sanctum personal access token passed in Authorization header
Parameters
Path Parameters
The space identifier
"uuid"The asset identifier
"uuid"Request Body
Responses
Successful response
Remove a custom poster
Remove a custom poster.
Restores the stashed generated video frames when the asset has any.
Authorizations
Sanctum personal access token passed in Authorization header
Parameters
Path Parameters
The space identifier
"uuid"The asset identifier
"uuid"Responses
Successful response
List the version history of an asset, most recent first
List the version history of an asset, most recent first.
Authorizations
Sanctum personal access token passed in Authorization header
Parameters
Path Parameters
The space identifier
"uuid"The asset identifier
"uuid"Responses
Successful response
Restore an asset to a previous version's file + metadata
Restore an asset to a previous version's file + metadata. The current
state is itself snapshotted first, so this is non-destructive.
Authorizations
Sanctum personal access token passed in Authorization header
Parameters
Path Parameters
The space identifier
"uuid"The asset identifier
"uuid"The version identifier
"uuid"Responses
Successful response
Display a listing of assets
Display a listing of assets.
Authorizations
Sanctum personal access token passed in Authorization header
Parameters
Path Parameters
The space identifier
"uuid"Responses
Successful response
Store a newly created asset
Store a newly created asset.
Authorizations
Sanctum personal access token passed in Authorization header
Parameters
Path Parameters
The space identifier
"uuid"Responses
Successful response