v1.0.0

Management API v1

Download OpenAPI Document

JSON

Download OpenAPI Document

YAML

Protected management API for administering spaces, teams, and content

Contact

API Support

Servers

https://b10cks.testCurrent environment

---

Users

Operations

GET/mgmt/v1/users/mePATCH/mgmt/v1/users/meGET/mgmt/v1/teams/{team}/usersPOST/mgmt/v1/teams/{team}/usersDELETE/mgmt/v1/teams/{team}/users/{user}PATCH/mgmt/v1/teams/{team}/users/{user}

---

List me

GET

/mgmt/v1/users/me

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Responses

Successful response

GET

/mgmt/v1/users/me

Playground

Authorization

bearerAuth

Samples

---

Update me

PATCH

/mgmt/v1/users/me

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Request Body

application/json

{

  

"firstname": "string",

  

"lastname": "string",

  

"settings": [

  

]

}

Responses

Successful response

PATCH

/mgmt/v1/users/me

Playground

Authorization

bearerAuth

Body

Samples

---

List users

GET

/mgmt/v1/teams/{team}/users

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

team*

The team identifier

Type

string

Required

Format

"uuid"

Responses

Successful response

Content-Type

application/json

"string"

GET

/mgmt/v1/teams/{team}/users

Playground

Authorization

bearerAuth

Variables

Key

Value

team*

Samples

---

Attach user to team

POST

/mgmt/v1/teams/{team}/users

Attach user to team

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

team*

The team identifier

Type

string

Required

Format

"uuid"

Responses

Successful response

Content-Type

application/json

"string"

POST

/mgmt/v1/teams/{team}/users

Playground

Authorization

bearerAuth

Variables

Key

Value

team*

Samples

---

Detach user from team

DELETE

/mgmt/v1/teams/{team}/users/{user}

Detach user from team

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

team*

The team identifier

Type

string

Required

Format

"uuid"

Responses

Successful response

DELETE

/mgmt/v1/teams/{team}/users/{user}

Playground

Authorization

bearerAuth

Variables

Key

Value

team*

Samples

---

Update user role in team

PATCH

/mgmt/v1/teams/{team}/users/{user}

Update user role in team

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

team*

The team identifier

Type

string

Required

Format

"uuid"

Responses

Successful response

Content-Type

application/json

"string"

PATCH

/mgmt/v1/teams/{team}/users/{user}

Playground

Authorization

bearerAuth

Variables

Key

Value

team*

Samples

---

Settings

Operations

POST/mgmt/v1/users/me/settings

---

Create settings

POST

/mgmt/v1/users/me/settings

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Request Body

application/json

{

  

"languageIso": "string",

  

"extendedSidebar": true

}

Responses

Successful response

POST

/mgmt/v1/users/me/settings

Playground

Authorization

bearerAuth

Body

Samples

---

Avatar

Operations

POST/mgmt/v1/users/me/avatar

---

Create avatar

POST

/mgmt/v1/users/me/avatar

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Request Body

application/json

{

  

"avatar": ""

}

Responses

Successful response

POST

/mgmt/v1/users/me/avatar

Playground

Authorization

bearerAuth

Body

Samples

---

Social Links

Operations

GET/mgmt/v1/users/me/social-linksDELETE/mgmt/v1/users/me/social-links/{provider}

---

List social links

GET

/mgmt/v1/users/me/social-links

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Responses

Successful response

GET

/mgmt/v1/users/me/social-links

Playground

Authorization

bearerAuth

Samples

---

Delete social link

DELETE

/mgmt/v1/users/me/social-links/{provider}

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

provider*

The provider identifier

Type

string

Required

Responses

Resource deleted successfully

DELETE

/mgmt/v1/users/me/social-links/{provider}

Playground

Authorization

bearerAuth

Variables

Key

Value

provider*

Samples

---

Password

Operations

POST/mgmt/v1/users/me/password

---

Create password

POST

/mgmt/v1/users/me/password

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Request Body

application/json

{

  

"old_password": "string",

  

"password": "string"

}

Responses

Successful response

POST

/mgmt/v1/users/me/password

Playground

Authorization

bearerAuth

Body

Samples

---

Tokens

Operations

GET/mgmt/v1/users/me/tokensPOST/mgmt/v1/users/me/tokensDELETE/mgmt/v1/users/me/tokens/{token}GET/mgmt/v1/spaces/{space}/tokensPOST/mgmt/v1/spaces/{space}/tokensDELETE/mgmt/v1/spaces/{space}/tokens/{token}

---

List tokens

GET

/mgmt/v1/users/me/tokens

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Query Parameters

per_page

Type

integer

Minimum

1

Maximum

100

Responses

Successful response

Content-Type

application/json

"string"

GET

/mgmt/v1/users/me/tokens

Playground

Authorization

bearerAuth

Variables

Key

Value

per_page

Samples

---

Create tokens

POST

/mgmt/v1/users/me/tokens

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Request Body

application/json

{

  

"name": "string",

  

"abilities": [

  

  

"string"

  

],

  

"expires_at": "string"

}

Responses

Successful response

POST

/mgmt/v1/users/me/tokens

Playground

Authorization

bearerAuth

Body

Samples

---

Delete token

DELETE

/mgmt/v1/users/me/tokens/{token}

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

token*

The token identifier

Type

integer

Required

Responses

Resource deleted successfully

DELETE

/mgmt/v1/users/me/tokens/{token}

Playground

Authorization

bearerAuth

Variables

Key

Value

token*

Samples

---

Display a listing of the tokens for a space

GET

/mgmt/v1/spaces/{space}/tokens

Display a listing of the tokens for a space.

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

space*

The space identifier

Type

string

Required

Format

"uuid"

Query Parameters

name

Filter by name (LIKE search)

Type

string

abilities

Filter by abilities

expires_at

Filter by expires_at with range syntax (value1...value2)

Type

string

created_at

Filter by creation date (supports operators and ranges)

Type

string

sort

Sort by field (prefix with - for descending order)

Type

string

Valid values

"name""-name""created_at""-created_at""expires_at""-expires_at""last_used_at""-last_used_at"

Responses

Successful response

Content-Type

application/json

"string"

GET

/mgmt/v1/spaces/{space}/tokens

Playground

Authorization

bearerAuth

Variables

Key

Value

space*

name

abilities

expires_at

created_at

sort

Samples

---

Store a newly created token in storage

POST

/mgmt/v1/spaces/{space}/tokens

Store a newly created token in storage.

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

space*

The space identifier

Type

string

Required

Format

"uuid"

Request Body

application/json

{

  

"name": "string",

  

"expires_at": "string",

  

"execution_limit": 0

}

Responses

Successful response

POST

/mgmt/v1/spaces/{space}/tokens

Playground

Authorization

bearerAuth

Variables

Key

Value

space*

Body

Samples

---

Remove the specified token from storage

DELETE

/mgmt/v1/spaces/{space}/tokens/{token}

Remove the specified token from storage.

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

space*

The space identifier

Type

string

Required

Format

"uuid"

token*

The token identifier

Type

string

Required

Format

"uuid"

Responses

Resource deleted successfully

DELETE

/mgmt/v1/spaces/{space}/tokens/{token}

Playground

Authorization

bearerAuth

Variables

Key

Value

space*

token*

Samples

---

Invites

Operations

GET/mgmt/v1/users/me/invitesGET/mgmt/v1/users/me/invites/{invite}POST/mgmt/v1/users/me/invites/{invite}/acceptGET/mgmt/v1/teams/{team}/invitesPOST/mgmt/v1/teams/{team}/invitesDELETE/mgmt/v1/teams/{team}/invites/{invite}POST/mgmt/v1/teams/{team}/invites/{invite}/resendGET/mgmt/v1/spaces/{space}/invitesPOST/mgmt/v1/spaces/{space}/invitesDELETE/mgmt/v1/spaces/{space}/invites/{invite}POST/mgmt/v1/spaces/{space}/invites/{invite}/resendGET/mgmt/v1/invites/{invite}

---

List invites

GET

/mgmt/v1/users/me/invites

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Query Parameters

email

Filter by email

Type

string

role

Filter by role

Type

string

status

Filter by status

Type

string

space_id

Filter by space ID

Type

string

team_id

Filter by team_id

Type

string

created_at

Filter by creation date (supports operators and ranges)

Type

string

expires_at

Filter by expires_at with range syntax (value1...value2)

Type

string

sort

Sort by field (prefix with - for descending order)

Type

string

Valid values

"email""-email""roles.key""-roles.key""created_at""-created_at""expires_at""-expires_at"

Responses

Successful response

Content-Type

application/json

"string"

GET

/mgmt/v1/users/me/invites

Playground

Authorization

bearerAuth

Variables

Key

Value

email

role

status

space_id

team_id

created_at

expires_at

sort

Samples

---

Get a single invite

GET

/mgmt/v1/users/me/invites/{invite}

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

invite*

The invite identifier

Type

string

Required

Format

"uuid"

Responses

Successful response

Content-Type

application/json

"string"

GET

/mgmt/v1/users/me/invites/{invite}

Playground

Authorization

bearerAuth

Variables

Key

Value

invite*

Samples

---

Create accept

POST

/mgmt/v1/users/me/invites/{invite}/accept

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

invite*

The invite identifier

Type

string

Required

Format

"uuid"

Request Body

application/json

{

  

"token": "string"

}

Responses

Successful response

Content-Type

application/json

"string"

POST

/mgmt/v1/users/me/invites/{invite}/accept

Playground

Authorization

bearerAuth

Variables

Key

Value

invite*

Body

Samples

---

List invites

GET

/mgmt/v1/teams/{team}/invites

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

team*

The team identifier

Type

string

Required

Format

"uuid"

Query Parameters

email

Filter by email

Type

string

role

Filter by role

Type

string

status

Filter by status

Type

string

space_id

Filter by space ID

Type

string

team_id

Filter by team_id

Type

string

created_at

Filter by creation date (supports operators and ranges)

Type

string

expires_at

Filter by expires_at with range syntax (value1...value2)

Type

string

sort

Sort by field (prefix with - for descending order)

Type

string

Valid values

"email""-email""roles.key""-roles.key""created_at""-created_at""expires_at""-expires_at"

Responses

Successful response

Content-Type

application/json

"string"

GET

/mgmt/v1/teams/{team}/invites

Playground

Authorization

bearerAuth

Variables

Key

Value

team*

email

role

status

space_id

team_id

created_at

expires_at

sort

Samples

---

Create invites

POST

/mgmt/v1/teams/{team}/invites

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

team*

The team identifier

Type

string

Required

Format

"uuid"

Request Body

application/json

{

  

"email": "string",

  

"role": "string",

  

"message": "string",

  

"expires_in_days": 0

}

Responses

Successful response

POST

/mgmt/v1/teams/{team}/invites

Playground

Authorization

bearerAuth

Variables

Key

Value

team*

Body

Samples

---

Delete invite

DELETE

/mgmt/v1/teams/{team}/invites/{invite}

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

team*

The team identifier

Type

string

Required

Format

"uuid"

invite*

The invite identifier

Type

string

Required

Format

"uuid"

Responses

Resource deleted successfully

DELETE

/mgmt/v1/teams/{team}/invites/{invite}

Playground

Authorization

bearerAuth

Variables

Key

Value

team*

invite*

Samples

---

Create resend

POST

/mgmt/v1/teams/{team}/invites/{invite}/resend

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

team*

The team identifier

Type

string

Required

Format

"uuid"

invite*

The invite identifier

Type

string

Required

Format

"uuid"

Responses

Successful response

Content-Type

application/json

"string"

POST

/mgmt/v1/teams/{team}/invites/{invite}/resend

Playground

Authorization

bearerAuth

Variables

Key

Value

team*

invite*

Samples

---

List invites

GET

/mgmt/v1/spaces/{space}/invites

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

space*

The space identifier

Type

string

Required

Format

"uuid"

Query Parameters

email

Filter by email

Type

string

role

Filter by role

Type

string

status

Filter by status

Type

string

space_id

Filter by space ID

Type

string

team_id

Filter by team_id

Type

string

created_at

Filter by creation date (supports operators and ranges)

Type

string

expires_at

Filter by expires_at with range syntax (value1...value2)

Type

string

sort

Sort by field (prefix with - for descending order)

Type

string

Valid values

"email""-email""roles.key""-roles.key""created_at""-created_at""expires_at""-expires_at"

Responses

Successful response

Content-Type

application/json

"string"

GET

/mgmt/v1/spaces/{space}/invites

Playground

Authorization

bearerAuth

Variables

Key

Value

space*

email

role

status

space_id

team_id

created_at

expires_at

sort

Samples

---

Create invites

POST

/mgmt/v1/spaces/{space}/invites

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

space*

The space identifier

Type

string

Required

Format

"uuid"

Request Body

application/json

{

  

"email": "string",

  

"role": "string",

  

"message": "string",

  

"expires_in_days": 0

}

Responses

Successful response

POST

/mgmt/v1/spaces/{space}/invites

Playground

Authorization

bearerAuth

Variables

Key

Value

space*

Body

Samples

---

Delete invite

DELETE

/mgmt/v1/spaces/{space}/invites/{invite}

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

space*

The space identifier

Type

string

Required

Format

"uuid"

invite*

The invite identifier

Type

string

Required

Format

"uuid"

Responses

Resource deleted successfully

DELETE

/mgmt/v1/spaces/{space}/invites/{invite}

Playground

Authorization

bearerAuth

Variables

Key

Value

space*

invite*

Samples

---

Create resend

POST

/mgmt/v1/spaces/{space}/invites/{invite}/resend

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

space*

The space identifier

Type

string

Required

Format

"uuid"

invite*

The invite identifier

Type

string

Required

Format

"uuid"

Responses

Successful response

Content-Type

application/json

"string"

POST

/mgmt/v1/spaces/{space}/invites/{invite}/resend

Playground

Authorization

bearerAuth

Variables

Key

Value

space*

invite*

Samples

---

Get a single invite

GET

/mgmt/v1/invites/{invite}

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

invite*

The invite identifier

Type

string

Required

Format

"uuid"

Responses

Successful response

Content-Type

application/json

"string"

GET

/mgmt/v1/invites/{invite}

Playground

Authorization

bearerAuth

Variables

Key

Value

invite*

Samples

---

Notifications

Operations

GET/mgmt/v1/users/me/notificationsDELETE/mgmt/v1/users/me/notificationsGET/mgmt/v1/users/me/notifications/unread-countPOST/mgmt/v1/users/me/notifications/readDELETE/mgmt/v1/users/me/notifications/readPATCH/mgmt/v1/users/me/notifications/{notification}/readPATCH/mgmt/v1/users/me/notifications/{notification}/unreadDELETE/mgmt/v1/users/me/notifications/{notification}

---

List notifications

GET

/mgmt/v1/users/me/notifications

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Responses

Successful response

Content-Type

application/json

{

  

"data": [

  

  

{

  

  

}

  

],

  

"links": {

  

  

"first": "string",

  

  

"last": "string",

  

  

"prev": "string",

  

  

"next": "string"

  

},

  

"meta": {

  

  

"current_page": 0,

  

  

"from": 0,

  

  

"last_page": 0,

  

  

"per_page": 0,

  

  

"to": 0,

  

  

"total": 0

  

}

}

GET

/mgmt/v1/users/me/notifications

Playground

Authorization

bearerAuth

Samples

---

Delete notifications

DELETE

/mgmt/v1/users/me/notifications

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Responses

Successful response

DELETE

/mgmt/v1/users/me/notifications

Playground

Authorization

bearerAuth

Samples

---

List unread count

GET

/mgmt/v1/users/me/notifications/unread-count

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Responses

Successful response

GET

/mgmt/v1/users/me/notifications/unread-count

Playground

Authorization

bearerAuth

Samples

---

Create read

POST

/mgmt/v1/users/me/notifications/read

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Responses

Successful response

POST

/mgmt/v1/users/me/notifications/read

Playground

Authorization

bearerAuth

Samples

---

Delete read

DELETE

/mgmt/v1/users/me/notifications/read

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Responses

Successful response

DELETE

/mgmt/v1/users/me/notifications/read

Playground

Authorization

bearerAuth

Samples

---

Update read

PATCH

/mgmt/v1/users/me/notifications/{notification}/read

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

notification*

The notification identifier

Type

string

Required

Responses

Successful response

Content-Type

application/json

"string"

PATCH

/mgmt/v1/users/me/notifications/{notification}/read

Playground

Authorization

bearerAuth

Variables

Key

Value

notification*

Samples

---

Update unread

PATCH

/mgmt/v1/users/me/notifications/{notification}/unread

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

notification*

The notification identifier

Type

string

Required

Responses

Successful response

Content-Type

application/json

"string"

PATCH

/mgmt/v1/users/me/notifications/{notification}/unread

Playground

Authorization

bearerAuth

Variables

Key

Value

notification*

Samples

---

Delete notification

DELETE

/mgmt/v1/users/me/notifications/{notification}

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

notification*

The notification identifier

Type

string

Required

Responses

Successful response

DELETE

/mgmt/v1/users/me/notifications/{notification}

Playground

Authorization

bearerAuth

Variables

Key

Value

notification*

Samples

---

Authorization

Operations

GET/mgmt/v1/authorization

---

List authorization

GET

/mgmt/v1/authorization

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Responses

Successful response

GET

/mgmt/v1/authorization

Playground

Authorization

bearerAuth

Samples

---

Provider

Operations

GET/mgmt/v1/provider/statsGET/mgmt/v1/provider/notesPOST/mgmt/v1/provider/notesGET/mgmt/v1/provider/notes/{providerNote}PUT/mgmt/v1/provider/notes/{providerNote}DELETE/mgmt/v1/provider/notes/{providerNote}

---

List stats

GET

/mgmt/v1/provider/stats

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Responses

Successful response

GET

/mgmt/v1/provider/stats

Playground

Authorization

bearerAuth

Samples

---

List notes

GET

/mgmt/v1/provider/notes

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Responses

Successful response

Content-Type

application/json

"string"

GET

/mgmt/v1/provider/notes

Playground

Authorization

bearerAuth

Samples

---

Create notes

POST

/mgmt/v1/provider/notes

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Request Body

application/json

{

  

"title": "string",

  

"icon": "string",

  

"url": "string",

  

"color": "string",

  

"content": "string",

  

"is_pinned": true

}

Responses

Successful response

Content-Type

application/json

"string"

POST

/mgmt/v1/provider/notes

Playground

Authorization

bearerAuth

Body

Samples

---

Get a single note

GET

/mgmt/v1/provider/notes/{providerNote}

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Responses

Successful response

GET

/mgmt/v1/provider/notes/{providerNote}

Playground

Authorization

bearerAuth

Samples

---

Update note

PUT

/mgmt/v1/provider/notes/{providerNote}

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

providerNote*

The providerNote identifier

Type

string

Required

Format

"uuid"

Request Body

application/json

{

  

"title": "string",

  

"icon": "string",

  

"url": "string",

  

"color": "string",

  

"content": "string",

  

"is_pinned": true

}

Responses

Successful response

Content-Type

application/json

"string"

PUT

/mgmt/v1/provider/notes/{providerNote}

Playground

Authorization

bearerAuth

Variables

Key

Value

providerNote*

Body

Samples

---

Delete note

DELETE

/mgmt/v1/provider/notes/{providerNote}

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

providerNote*

The providerNote identifier

Type

string

Required

Format

"uuid"

Responses

Successful response

DELETE

/mgmt/v1/provider/notes/{providerNote}

Playground

Authorization

bearerAuth

Variables

Key

Value

providerNote*

Samples

---

Ai

Operations

GET/mgmt/v1/ai/available-modelsGET/mgmt/v1/ai/modelsPOST/mgmt/v1/ai/meta-tags/streamPOST/mgmt/v1/ai/translate/streamPOST/mgmt/v1/ai/content-interaction/streamPOST/mgmt/v1/ai/content-tree-interaction/stream

---

List available models

GET

/mgmt/v1/ai/available-models

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Query Parameters

name

Filter by name (LIKE search)

Type

string

model

Filter by model (LIKE search)

Type

string

q

Free-text search filter.

Type

string

provider

Filter by provider (LIKE search)

Type

string

is_free

Filter by is_free

Type

boolean

sort

Sort by field (prefix with - for descending order)

Type

string

Valid values

"name""-name""model""-model""provider""-provider""created_at""-created_at""updated_at""-updated_at"

Responses

Successful response

GET

/mgmt/v1/ai/available-models

Playground

Authorization

bearerAuth

Variables

Key

Value

name

model

q

provider

is_free

sort

Samples

---

List models

GET

/mgmt/v1/ai/models

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Responses

Successful response

GET

/mgmt/v1/ai/models

Playground

Authorization

bearerAuth

Samples

---

Create stream

POST

/mgmt/v1/ai/meta-tags/stream

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Responses

Successful response

POST

/mgmt/v1/ai/meta-tags/stream

Playground

Authorization

bearerAuth

Samples

---

Create stream

POST

/mgmt/v1/ai/translate/stream

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Responses

Successful response

POST

/mgmt/v1/ai/translate/stream

Playground

Authorization

bearerAuth

Samples

---

Create stream

POST

/mgmt/v1/ai/content-interaction/stream

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Responses

Successful response

POST

/mgmt/v1/ai/content-interaction/stream

Playground

Authorization

bearerAuth

Samples

---

Create stream

POST

/mgmt/v1/ai/content-tree-interaction/stream

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Responses

Successful response

POST

/mgmt/v1/ai/content-tree-interaction/stream

Playground

Authorization

bearerAuth

Samples

---

Teams

Operations

GET/mgmt/v1/teams/hierarchyGET/mgmt/v1/teamsPOST/mgmt/v1/teamsGET/mgmt/v1/teams/{team}PUT/mgmt/v1/teams/{team}DELETE/mgmt/v1/teams/{team}

---

Get team hierarchy starting from specified parent (or root if null),

GET

/mgmt/v1/teams/hierarchy

Get team hierarchy starting from specified parent (or root if null),
scoped to the teams the user may access (root sees everything).

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Responses

Successful response

Content-Type

application/json

"string"

GET

/mgmt/v1/teams/hierarchy

Playground

Authorization

bearerAuth

Samples

---

Display a listing of teams

GET

/mgmt/v1/teams

Display a listing of teams

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Query Parameters

include_space_context

Type

boolean

per_page

Type

integer

Minimum

1

page

Type

integer

Minimum

1

sort

Type

string

name

Type

string

type

Type

string

parent_id

Type

string

created_at

Type

string

updated_at

Type

string

Responses

Successful response

Content-Type

application/json

"string"

GET

/mgmt/v1/teams

Playground

Authorization

bearerAuth

Variables

Key

Value

include_space_context

per_page

page

sort

name

type

parent_id

created_at

updated_at

Samples

---

Store a newly created team

POST

/mgmt/v1/teams

Store a newly created team

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Request Body

application/json

{

  

"name": "string",

  

"icon": "string",

  

"color": "string",

  

"description": "string",

  

"type": "string",

  

"parent_id": "string",

  

"settings": [

  

]

}

Responses

Successful response

Content-Type

application/json

"string"

POST

/mgmt/v1/teams

Playground

Authorization

bearerAuth

Body

Samples

---

Display the specified team

GET

/mgmt/v1/teams/{team}

Display the specified team

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

team*

The team identifier

Type

string

Required

Format

"uuid"

Responses

Successful response

Content-Type

application/json

"string"

GET

/mgmt/v1/teams/{team}

Playground

Authorization

bearerAuth

Variables

Key

Value

team*

Samples

---

Update the specified team

PUT

/mgmt/v1/teams/{team}

Update the specified team

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

team*

The team identifier

Type

string

Required

Format

"uuid"

Request Body

application/json

{

  

"name": "string",

  

"icon": "string",

  

"color": "string",

  

"description": "string",

  

"type": "string",

  

"parent_id": "string",

  

"settings": [

  

]

}

Responses

Successful response

Content-Type

application/json

"string"

PUT

/mgmt/v1/teams/{team}

Playground

Authorization

bearerAuth

Variables

Key

Value

team*

Body

Samples

---

Remove the specified team

DELETE

/mgmt/v1/teams/{team}

Remove the specified team

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

team*

The team identifier

Type

string

Required

Format

"uuid"

Responses

Successful response

DELETE

/mgmt/v1/teams/{team}

Playground

Authorization

bearerAuth

Variables

Key

Value

team*

Samples

---

Space Blueprints

Operations

GET/mgmt/v1/space-blueprints

---

List space blueprints

GET

/mgmt/v1/space-blueprints

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Query Parameters

name

Filter by name (LIKE search)

Type

string

team_id

Filter by team_id

Type

string

created_by_id

Filter by created_by_id

Type

string

created_at

Filter by creation date (supports operators and ranges)

Type

string

updated_at

Filter by update date (supports operators and ranges)

Type

string

sort

Sort by field (prefix with - for descending order)

Type

string

Valid values

"name""-name""created_at""-created_at""updated_at""-updated_at"

Responses

Successful response

Content-Type

application/json

"string"

GET

/mgmt/v1/space-blueprints

Playground

Authorization

bearerAuth

Variables

Key

Value

name

team_id

created_by_id

created_at

updated_at

sort

Samples

---

Members

Operations

GET/mgmt/v1/teams/{team}/membersDELETE/mgmt/v1/teams/{team}/members/{user}PATCH/mgmt/v1/teams/{team}/members/{user}GET/mgmt/v1/spaces/{space}/membersDELETE/mgmt/v1/spaces/{space}/members/{user}PATCH/mgmt/v1/spaces/{space}/members/{user}

---

List members

GET

/mgmt/v1/teams/{team}/members

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

team*

The team identifier

Type

string

Required

Format

"uuid"

Responses

Successful response

Content-Type

application/json

"string"

GET

/mgmt/v1/teams/{team}/members

Playground

Authorization

bearerAuth

Variables

Key

Value

team*

Samples

---

Delete member

DELETE

/mgmt/v1/teams/{team}/members/{user}

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

team*

The team identifier

Type

string

Required

Format

"uuid"

user*

The user identifier

Type

string

Required

Format

"uuid"

Responses

Successful response

DELETE

/mgmt/v1/teams/{team}/members/{user}

Playground

Authorization

bearerAuth

Variables

Key

Value

team*

user*

Samples

---

Update member

PATCH

/mgmt/v1/teams/{team}/members/{user}

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

team*

The team identifier

Type

string

Required

Format

"uuid"

user*

The user identifier

Type

string

Required

Format

"uuid"

Responses

Successful response

PATCH

/mgmt/v1/teams/{team}/members/{user}

Playground

Authorization

bearerAuth

Variables

Key

Value

team*

user*

Samples

---

List members

GET

/mgmt/v1/spaces/{space}/members

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

space*

The space identifier

Type

string

Required

Format

"uuid"

Responses

Successful response

Content-Type

application/json

"string"

GET

/mgmt/v1/spaces/{space}/members

Playground

Authorization

bearerAuth

Variables

Key

Value

space*

Samples

---

Delete member

DELETE

/mgmt/v1/spaces/{space}/members/{user}

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

space*

The space identifier

Type

string

Required

Format

"uuid"

user*

The user identifier

Type

string

Required

Format

"uuid"

Responses

Successful response

DELETE

/mgmt/v1/spaces/{space}/members/{user}

Playground

Authorization

bearerAuth

Variables

Key

Value

space*

user*

Samples

---

Update member

PATCH

/mgmt/v1/spaces/{space}/members/{user}

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

space*

The space identifier

Type

string

Required

Format

"uuid"

user*

The user identifier

Type

string

Required

Format

"uuid"

Responses

Successful response

PATCH

/mgmt/v1/spaces/{space}/members/{user}

Playground

Authorization

bearerAuth

Variables

Key

Value

space*

user*

Samples

---

Saml Provider

Operations

GET/mgmt/v1/teams/{team}/saml-providerPUT/mgmt/v1/teams/{team}/saml-providerDELETE/mgmt/v1/teams/{team}/saml-provider

---

List saml provider

GET

/mgmt/v1/teams/{team}/saml-provider

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

team*

The team identifier

Type

string

Required

Format

"uuid"

Responses

Successful response

GET

/mgmt/v1/teams/{team}/saml-provider

Playground

Authorization

bearerAuth

Variables

Key

Value

team*

Samples

---

Update saml provider

PUT

/mgmt/v1/teams/{team}/saml-provider

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

team*

The team identifier

Type

string

Required

Format

"uuid"

Request Body

application/json

{

  

"enabled": true,

  

"idp_entity_id": "string",

  

"sso_url": "string",

  

"slo_url": "string",

  

"idp_x509_cert": "string",

  

"sp_x509_cert": "string",

  

"sp_private_key": "string",

  

"name_id_format": "string",

  

"attribute_mapping": {

  

  

"email": "string",

  

  

"first_name": "string",

  

  

"last_name": "string",

  

  

"external_id": "string"

  

},

  

"role_attribute": "string",

  

"role_mapping": [

  

  

"string"

  

],

  

"default_role": "string",

  

"allow_jit": true,

  

"strict": true,

  

"sign_authn_requests": true,

  

"sign_logout_requests": true,

  

"want_assertions_signed": true,

  

"want_messages_signed": true,

  

"want_assertions_encrypted": true,

  

"digest_algorithm": "string",

  

"signature_algorithm": "string"

}

Responses

Successful response

PUT

/mgmt/v1/teams/{team}/saml-provider

Playground

Authorization

bearerAuth

Variables

Key

Value

team*

Body

Samples

---

Delete saml provider

DELETE

/mgmt/v1/teams/{team}/saml-provider

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

team*

The team identifier

Type

string

Required

Format

"uuid"

Responses

Successful response

DELETE

/mgmt/v1/teams/{team}/saml-provider

Playground

Authorization

bearerAuth

Variables

Key

Value

team*

Samples

---

Blueprints

Operations

GET/mgmt/v1/teams/{team}/blueprintsPOST/mgmt/v1/teams/{team}/blueprintsGET/mgmt/v1/teams/{team}/blueprints/{blueprint}PUT/mgmt/v1/teams/{team}/blueprints/{blueprint}DELETE/mgmt/v1/teams/{team}/blueprints/{blueprint}

---

List blueprints

GET

/mgmt/v1/teams/{team}/blueprints

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Query Parameters

name

Filter by name (LIKE search)

Type

string

team_id

Filter by team_id

Type

string

created_by_id

Filter by created_by_id

Type

string

created_at

Filter by creation date (supports operators and ranges)

Type

string

updated_at

Filter by update date (supports operators and ranges)

Type

string

sort

Sort by field (prefix with - for descending order)

Type

string

Valid values

"name""-name""created_at""-created_at""updated_at""-updated_at"

Responses

Successful response

Content-Type

application/json

"string"

GET

/mgmt/v1/teams/{team}/blueprints

Playground

Authorization

bearerAuth

Variables

Key

Value

name

team_id

created_by_id

created_at

updated_at

sort

Samples

---

Create blueprints

POST

/mgmt/v1/teams/{team}/blueprints

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

team*

The team identifier

Type

string

Required

Format

"uuid"

Request Body

application/json

{

  

"name": "string",

  

"icon": "string",

  

"color": "string",

  

"description": "string",

  

"settings": [

  

],

  

"source_space_id": "string",

  

"tables": [

  

  

"string"

  

]

}

Responses

Successful response

Content-Type

application/json

"string"

POST

/mgmt/v1/teams/{team}/blueprints

Playground

Authorization

bearerAuth

Variables

Key

Value

team*

Body

Samples

---

Get a single blueprint

GET

/mgmt/v1/teams/{team}/blueprints/{blueprint}

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

team*

The team identifier

Type

string

Required

Format

"uuid"

blueprint*

The blueprint identifier

Type

string

Required

Format

"uuid"

Responses

Successful response

Content-Type

application/json

"string"

GET

/mgmt/v1/teams/{team}/blueprints/{blueprint}

Playground

Authorization

bearerAuth

Variables

Key

Value

team*

blueprint*

Samples

---

Update blueprint

PUT

/mgmt/v1/teams/{team}/blueprints/{blueprint}

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

team*

The team identifier

Type

string

Required

Format

"uuid"

blueprint*

The blueprint identifier

Type

string

Required

Format

"uuid"

Request Body

application/json

{

  

"name": "string",

  

"icon": "string",

  

"color": "string",

  

"description": "string",

  

"settings": [

  

]

}

Responses

Successful response

Content-Type

application/json

"string"

PUT

/mgmt/v1/teams/{team}/blueprints/{blueprint}

Playground

Authorization

bearerAuth

Variables

Key

Value

team*

blueprint*

Body

Samples

---

Delete blueprint

DELETE

/mgmt/v1/teams/{team}/blueprints/{blueprint}

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

team*

The team identifier

Type

string

Required

Format

"uuid"

blueprint*

The blueprint identifier

Type

string

Required

Format

"uuid"

Responses

Resource deleted successfully

DELETE

/mgmt/v1/teams/{team}/blueprints/{blueprint}

Playground

Authorization

bearerAuth

Variables

Key

Value

team*

blueprint*

Samples

---

Roles

Operations

GET/mgmt/v1/teams/{team}/roles/spacePOST/mgmt/v1/teams/{team}/roles/spaceDELETE/mgmt/v1/teams/{team}/roles/space/{role}PATCH/mgmt/v1/teams/{team}/roles/space/{role}

---

List space

GET

/mgmt/v1/teams/{team}/roles/space

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

team*

The team identifier

Type

string

Required

Format

"uuid"

Responses

Successful response

Content-Type

application/json

{

  

"data": [

  

  

{

  

  

}

  

],

  

"links": {

  

  

"first": "string",

  

  

"last": "string",

  

  

"prev": "string",

  

  

"next": "string"

  

},

  

"meta": {

  

  

"current_page": 0,

  

  

"from": 0,

  

  

"last_page": 0,

  

  

"per_page": 0,

  

  

"to": 0,

  

  

"total": 0

  

}

}

GET

/mgmt/v1/teams/{team}/roles/space

Playground

Authorization

bearerAuth

Variables

Key

Value

team*

Samples

---

Create space

POST

/mgmt/v1/teams/{team}/roles/space

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

team*

The team identifier

Type

string

Required

Format

"uuid"

Request Body

application/json

{

  

"key": "string",

  

"name": "string",

  

"description": "string",

  

"level": 0,

  

"abilities": [

  

  

"string"

  

]

}

Responses

Successful response

POST

/mgmt/v1/teams/{team}/roles/space

Playground

Authorization

bearerAuth

Variables

Key

Value

team*

Body

Samples

---

Delete space

DELETE

/mgmt/v1/teams/{team}/roles/space/{role}

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

team*

The team identifier

Type

string

Required

Format

"uuid"

role*

The role identifier

Type

string

Required

Format

"uuid"

Responses

Resource deleted successfully

DELETE

/mgmt/v1/teams/{team}/roles/space/{role}

Playground

Authorization

bearerAuth

Variables

Key

Value

team*

role*

Samples

---

Update space

PATCH

/mgmt/v1/teams/{team}/roles/space/{role}

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

team*

The team identifier

Type

string

Required

Format

"uuid"

role*

The role identifier

Type

string

Required

Format

"uuid"

Request Body

application/json

{

  

"key": "string",

  

"name": "string",

  

"description": "string",

  

"level": 0,

  

"abilities": [

  

  

"string"

  

]

}

Responses

Successful response

Content-Type

application/json

"string"

PATCH

/mgmt/v1/teams/{team}/roles/space/{role}

Playground

Authorization

bearerAuth

Variables

Key

Value

team*

role*

Body

Samples

---

Spaces

Operations

GET/mgmt/v1/spacesPOST/mgmt/v1/spacesGET/mgmt/v1/spaces/{space}PUT/mgmt/v1/spaces/{space}DELETE/mgmt/v1/spaces/{space}

---

Display a listing of the spaces

GET

/mgmt/v1/spaces

Display a listing of the spaces.

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Query Parameters

name

Filter by name (LIKE search)

Type

string

slug

Filter by slug (LIKE search)

Type

string

archived

Filter by archived

Type

string

created_at

Filter by creation date (supports operators and ranges)

Type

string

updated_at

Filter by update date (supports operators and ranges)

Type

string

sort

Sort by field (prefix with - for descending order)

Type

string

Valid values

"name""-name""slug""-slug""state""-state""created_at""-created_at""updated_at""-updated_at"

Responses

Successful response

Content-Type

application/json

"string"

GET

/mgmt/v1/spaces

Playground

Authorization

bearerAuth

Variables

Key

Value

name

slug

archived

created_at

updated_at

sort

Samples

---

Store a newly created space in storage

POST

/mgmt/v1/spaces

Store a newly created space in storage.

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Request Body

application/json

{

  

"name": "string",

  

"slug": "string",

  

"icon": "string",

  

"team_id": "string",

  

"color": "string",

  

"badge": "string",

  

"description": "string",

  

"settings": {

  

  

"default_language": "string",

  

  

"i18n_mode": "string",

  

  

"languages": [

  

  

  

{

  

  

  

  

"code": "string",

  

  

  

  

"name": "string",

  

  

  

  

"fallback_language": "string"

  

  

  

}

  

  

],

  

  

"asset_fields": [

  

  

  

{

  

  

  

  

"key": "string",

  

  

  

  

"label": "string",

  

  

  

  

"required": true

  

  

  

}

  

  

]

  

},

  

"plan_id": "string",

  

"blueprint_id": "string"

}

Responses

Successful response

Content-Type

application/json

"string"

POST

/mgmt/v1/spaces

Playground

Authorization

bearerAuth

Body

Samples

---

Display the specified space

GET

/mgmt/v1/spaces/{space}

Display the specified space.

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

space*

The space identifier

Type

string

Required

Format

"uuid"

Responses

Successful response

Content-Type

application/json

"string"

GET

/mgmt/v1/spaces/{space}

Playground

Authorization

bearerAuth

Variables

Key

Value

space*

Samples

---

Update the specified space in storage

PUT

/mgmt/v1/spaces/{space}

Update the specified space in storage.

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

space*

The space identifier

Type

string

Required

Format

"uuid"

Request Body

application/json

{

  

"name": "string",

  

"slug": "string",

  

"icon": "string",

  

"color": "string",

  

"badge": "string",

  

"description": "string",

  

"settings": {

  

  

"default_language": "string",

  

  

"i18n_mode": "string",

  

  

"languages": [

  

  

  

{

  

  

  

  

"code": "string",

  

  

  

  

"name": "string",

  

  

  

  

"fallback_language": "string"

  

  

  

}

  

  

],

  

  

"sitemap": [

  

  

  

{

  

  

  

  

"types": [

  

  

  

  

  

{

  

  

  

  

  

  

"block": "string",

  

  

  

  

  

  

"path": "string"

  

  

  

  

  

}

  

  

  

  

]

  

  

  

}

  

  

]

  

},

  

"state": "string"

}

Responses

Successful response

Content-Type

application/json

"string"

PUT

/mgmt/v1/spaces/{space}

Playground

Authorization

bearerAuth

Variables

Key

Value

space*

Body

Samples

---

Remove the specified space from storage

DELETE

/mgmt/v1/spaces/{space}

Remove the specified space from storage.

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

space*

The space identifier

Type

string

Required

Format

"uuid"

Responses

Resource deleted successfully

DELETE

/mgmt/v1/spaces/{space}

Playground

Authorization

bearerAuth

Variables

Key

Value

space*

Samples

---

Icon

Operations

POST/mgmt/v1/spaces/{space}/icon

---

Create icon

POST

/mgmt/v1/spaces/{space}/icon

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

space*

The space identifier

Type

string

Required

Format

"uuid"

Request Body

application/json

{

  

"icon": ""

}

Responses

Successful response

POST

/mgmt/v1/spaces/{space}/icon

Playground

Authorization

bearerAuth

Variables

Key

Value

space*

Body

Samples

---

Archive

Operations

POST/mgmt/v1/spaces/{space}/archive

---

Create archive

POST

/mgmt/v1/spaces/{space}/archive

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

space*

The space identifier

Type

string

Required

Format

"uuid"

Responses

Successful response

POST

/mgmt/v1/spaces/{space}/archive

Playground

Authorization

bearerAuth

Variables

Key

Value

space*

Samples

---

Ai Usage

Operations

GET/mgmt/v1/spaces/{space}/ai-usage

---

List ai usage

GET

/mgmt/v1/spaces/{space}/ai-usage

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

space*

The space identifier

Type

string

Required

Format

"uuid"

Responses

Successful response

Content-Type

application/json

"string"

GET

/mgmt/v1/spaces/{space}/ai-usage

Playground

Authorization

bearerAuth

Variables

Key

Value

space*

Samples

---

Usage

Operations

GET/mgmt/v1/spaces/{space}/usageGET/mgmt/v1/spaces/{space}/usage/historyGET/mgmt/v1/spaces/{space}/usage/history/{period}/timeseries

---

List usage

GET

/mgmt/v1/spaces/{space}/usage

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

space*

The space identifier

Type

string

Required

Format

"uuid"

Responses

Successful response

Content-Type

application/json

"string"

GET

/mgmt/v1/spaces/{space}/usage

Playground

Authorization

bearerAuth

Variables

Key

Value

space*

Samples

---

The space's billing-period history (newest first), each with its usage rollup

GET

/mgmt/v1/spaces/{space}/usage/history

The space's billing-period history (newest first), each with its usage rollup.

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

space*

The space identifier

Type

string

Required

Format

"uuid"

Responses

Successful response

Content-Type

application/json

"string"

GET

/mgmt/v1/spaces/{space}/usage/history

Playground

Authorization

bearerAuth

Variables

Key

Value

space*

Samples

---

Daily traffic/requests trend within a closed (or open) period, reconstructed

GET

/mgmt/v1/spaces/{space}/usage/history/{period}/timeseries

Daily traffic/requests trend within a closed (or open) period, reconstructed
from the hourly rollup tables for the page charts.

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

space*

The space identifier

Type

string

Required

Format

"uuid"

period*

The period identifier

Type

string

Required

Format

"uuid"

Responses

Successful response

GET

/mgmt/v1/spaces/{space}/usage/history/{period}/timeseries

Playground

Authorization

bearerAuth

Variables

Key

Value

space*

period*

Samples

---

Ai Settings

Operations

GET/mgmt/v1/spaces/{space}/ai-settingsPATCH/mgmt/v1/spaces/{space}/ai-settings

---

List ai settings

GET

/mgmt/v1/spaces/{space}/ai-settings

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

space*

The space identifier

Type

string

Required

Format

"uuid"

Responses

Successful response

GET

/mgmt/v1/spaces/{space}/ai-settings

Playground

Authorization

bearerAuth

Variables

Key

Value

space*

Samples

---

Update ai settings

PATCH

/mgmt/v1/spaces/{space}/ai-settings

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

space*

The space identifier

Type

string

Required

Format

"uuid"

Request Body

application/json

{

  

"ai": {

  

  

"region": "string",

  

  

"default_block": "string",

  

  

"default_language": "string",

  

  

"i18n_mode": "string",

  

  

"languages": [

  

  

  

{

  

  

  

  

"code": "string",

  

  

  

  

"name": "string",

  

  

  

  

"fallback_language": "string",

  

  

  

  

"hidden": true

  

  

  

}

  

  

],

  

  

"site_locales": [

  

  

  

{

  

  

  

  

"segment": "string",

  

  

  

  

"language": "string",

  

  

  

  

"name": "string"

  

  

  

}

  

  

],

  

  

"asset_fields": [

  

  

  

{

  

  

  

  

"key": "string",

  

  

  

  

"label": "string",

  

  

  

  

"required": true

  

  

  

}

  

  

],

  

  

"environments": [

  

  

  

{

  

  

  

  

"key": "string",

  

  

  

  

"label": "string"

  

  

  

}

  

  

],

  

  

"default_environment": "string",

  

  

"visual_editor": true,

  

  

"search_driver": "string",

  

  

"slug_strategy": "string",

  

  

"filter_hidden_blocks": true,

  

  

"content_sorting": true,

  

  

"ai": [

  

  

  

{

  

  

  

  

"enabled": true,

  

  

  

  

"model": "string",

  

  

  

  

"favourites": [

  

  

  

  

  

"string"

  

  

  

  

]

  

  

  

}

  

  

],

  

  

"sitemap": [

  

  

  

{

  

  

  

  

"types": [

  

  

  

  

  

{

  

  

  

  

  

  

"block": "string",

  

  

  

  

  

  

"path": "string"

  

  

  

  

  

}

  

  

  

  

]

  

  

  

}

  

  

]

  

}

}

Responses

Successful response

PATCH

/mgmt/v1/spaces/{space}/ai-settings

Playground

Authorization

bearerAuth

Variables

Key

Value

space*

Body

Samples

---

Ai Configs

Operations

GET/mgmt/v1/spaces/{space}/ai-configsPOST/mgmt/v1/spaces/{space}/ai-configsGET/mgmt/v1/spaces/{space}/ai-configs/{aiConfig}DELETE/mgmt/v1/spaces/{space}/ai-configs/{aiConfig}PATCH/mgmt/v1/spaces/{space}/ai-configs/{aiConfig}

---

List ai configs

GET

/mgmt/v1/spaces/{space}/ai-configs

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

space*

The space identifier

Type

string

Required

Format

"uuid"

Responses

Successful response

GET

/mgmt/v1/spaces/{space}/ai-configs

Playground

Authorization

bearerAuth

Variables

Key

Value

space*

Samples

---

Create ai configs

POST

/mgmt/v1/spaces/{space}/ai-configs

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

space*

The space identifier

Type

string

Required

Format

"uuid"

Responses

Successful response

POST

/mgmt/v1/spaces/{space}/ai-configs

Playground

Authorization

bearerAuth

Variables

Key

Value

space*

Samples

---

Get a single ai config

GET

/mgmt/v1/spaces/{space}/ai-configs/{aiConfig}

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

space*

The space identifier

Type

string

Required

Format

"uuid"

aiConfig*

The aiConfig identifier

Type

string

Required

Format

"uuid"

Responses

Successful response

GET

/mgmt/v1/spaces/{space}/ai-configs/{aiConfig}

Playground

Authorization

bearerAuth

Variables

Key

Value

space*

aiConfig*

Samples

---

Delete ai config

DELETE

/mgmt/v1/spaces/{space}/ai-configs/{aiConfig}

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

space*

The space identifier

Type

string

Required

Format

"uuid"

aiConfig*

The aiConfig identifier

Type

string

Required

Format

"uuid"

Responses

Successful response

DELETE

/mgmt/v1/spaces/{space}/ai-configs/{aiConfig}

Playground

Authorization

bearerAuth

Variables

Key

Value

space*

aiConfig*

Samples

---

Update ai config

PATCH

/mgmt/v1/spaces/{space}/ai-configs/{aiConfig}

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

space*

The space identifier

Type

string

Required

Format

"uuid"

aiConfig*

The aiConfig identifier

Type

string

Required

Format

"uuid"

Responses

Successful response

PATCH

/mgmt/v1/spaces/{space}/ai-configs/{aiConfig}

Playground

Authorization

bearerAuth

Variables

Key

Value

space*

aiConfig*

Samples

---

Search

Operations

PATCH/mgmt/v1/spaces/{space}/searchPOST/mgmt/v1/spaces/{space}/search/reindex

---

Update search

PATCH

/mgmt/v1/spaces/{space}/search

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

space*

The space identifier

Type

string

Required

Format

"uuid"

Responses

Successful response

PATCH

/mgmt/v1/spaces/{space}/search

Playground

Authorization

bearerAuth

Variables

Key

Value

space*

Samples

---

Create reindex

POST

/mgmt/v1/spaces/{space}/search/reindex

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

space*

The space identifier

Type

string

Required

Format

"uuid"

Responses

Successful response

POST

/mgmt/v1/spaces/{space}/search/reindex

Playground

Authorization

bearerAuth

Variables

Key

Value

space*

Samples

---

Blocks

Operations

GET/mgmt/v1/spaces/{space}/blocksPOST/mgmt/v1/spaces/{space}/blocksGET/mgmt/v1/spaces/{space}/blocks/{block}PUT/mgmt/v1/spaces/{space}/blocks/{block}DELETE/mgmt/v1/spaces/{space}/blocks/{block}GET/mgmt/v1/spaces/{space}/blocks/{block}/templatesPOST/mgmt/v1/spaces/{space}/blocks/{block}/templatesGET/mgmt/v1/spaces/{space}/blocks/{block}/templates/{template}PUT/mgmt/v1/spaces/{space}/blocks/{block}/templates/{template}DELETE/mgmt/v1/spaces/{space}/blocks/{block}/templates/{template}GET/mgmt/v1/spaces/{space}/blocks/{block}/versionsGET/mgmt/v1/spaces/{space}/blocks/{block}/versions/{version}DELETE/mgmt/v1/spaces/{space}/blocks/{block}/versions/{version}PATCH/mgmt/v1/spaces/{space}/blocks/{block}/versions/{version}POST/mgmt/v1/spaces/{space}/blocks/{block}/versions/{version}/restore

---

Display a listing of the blocks

GET

/mgmt/v1/spaces/{space}/blocks

Display a listing of the blocks.

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

space*

The space identifier

Type

string

Required

Format

"uuid"

Query Parameters

name

Filter by name (LIKE search)

Type

string

slug

Filter by slug (LIKE search)

Type

string

folder_id

Filter by folder ID

Type

string

is_nestable

Filter by is_nestable

Type

string

is_root

Filter by is_root

Type

string

tags

Filter by tags

created_at

Filter by creation date (supports operators and ranges)

Type

string

updated_at

Filter by update date (supports operators and ranges)

Type

string

sort

Sort by field (prefix with - for descending order)

Type

string

Valid values

"name""-name""slug""-slug""is_nestable""-is_nestable""is_root""-is_root""created_at""-created_at""updated_at""-updated_at"

Responses

Successful response

Content-Type

application/json

"string"

GET

/mgmt/v1/spaces/{space}/blocks

Playground

Authorization

bearerAuth

Variables

Key

Value

space*

name

slug

folder_id

is_nestable

is_root

tags

created_at

updated_at

sort

Samples

---

Store a newly created block in storage

POST

/mgmt/v1/spaces/{space}/blocks

Store a newly created block in storage.

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

space*

The space identifier

Type

string

Required

Format

"uuid"

Responses

Successful response

Content-Type

application/json

"string"

POST

/mgmt/v1/spaces/{space}/blocks

Playground

Authorization

bearerAuth

Variables

Key

Value

space*

Samples

---

Display the specified block

GET

/mgmt/v1/spaces/{space}/blocks/{block}

Display the specified block.

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

space*

The space identifier

Type

string

Required

Format

"uuid"

block*

The block identifier

Type

string

Required

Format

"uuid"

Responses

Successful response

Content-Type

application/json

"string"

GET

/mgmt/v1/spaces/{space}/blocks/{block}

Playground

Authorization

bearerAuth

Variables

Key

Value

space*

block*

Samples

---

Update the specified block in storage

PUT

/mgmt/v1/spaces/{space}/blocks/{block}

Update the specified block in storage.

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

space*

The space identifier

Type

string

Required

Format

"uuid"

block*

The block identifier

Type

string

Required

Format

"uuid"

Responses

Successful response

Content-Type

application/json

"string"

PUT

/mgmt/v1/spaces/{space}/blocks/{block}

Playground

Authorization

bearerAuth

Variables

Key

Value

space*

block*

Samples

---

Remove the specified block from storage

DELETE

/mgmt/v1/spaces/{space}/blocks/{block}

Remove the specified block from storage.

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

space*

The space identifier

Type

string

Required

Format

"uuid"

block*

The block identifier

Type

string

Required

Format

"uuid"

Responses

Resource deleted successfully

DELETE

/mgmt/v1/spaces/{space}/blocks/{block}

Playground

Authorization

bearerAuth

Variables

Key

Value

space*

block*

Samples

---

List templates

GET

/mgmt/v1/spaces/{space}/blocks/{block}/templates

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

space*

The space identifier

Type

string

Required

Format

"uuid"

block*

The block identifier

Type

string

Required

Format

"uuid"

Query Parameters

name

Filter by name (LIKE search)

Type

string

created_at

Filter by creation date (supports operators and ranges)

Type

string

updated_at

Filter by update date (supports operators and ranges)

Type

string

sort

Sort by field (prefix with - for descending order)

Type

string

Valid values

"name""-name""created_at""-created_at""updated_at""-updated_at"

Responses

Successful response

Content-Type

application/json

"string"

GET

/mgmt/v1/spaces/{space}/blocks/{block}/templates

Playground

Authorization

bearerAuth

Variables

Key

Value

space*

block*

name

created_at

updated_at

sort

Samples

---

Create templates

POST

/mgmt/v1/spaces/{space}/blocks/{block}/templates

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

space*

The space identifier

Type

string

Required

Format

"uuid"

block*

The block identifier

Type

string

Required

Format

"uuid"

Responses

Successful response

Content-Type

application/json

"string"

POST

/mgmt/v1/spaces/{space}/blocks/{block}/templates

Playground

Authorization

bearerAuth

Variables

Key

Value

space*

block*

Samples

---

Get a single template

GET

/mgmt/v1/spaces/{space}/blocks/{block}/templates/{template}

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

space*

The space identifier

Type

string

Required

Format

"uuid"

block*

The block identifier

Type

string

Required

Format

"uuid"

template*

The template identifier

Type

string

Required

Format

"uuid"

Responses

Successful response

Content-Type

application/json

"string"

GET

/mgmt/v1/spaces/{space}/blocks/{block}/templates/{template}

Playground

Authorization

bearerAuth

Variables

Key

Value

space*

block*

template*

Samples

---

Update template

PUT

/mgmt/v1/spaces/{space}/blocks/{block}/templates/{template}

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

space*

The space identifier

Type

string

Required

Format

"uuid"

block*

The block identifier

Type

string

Required

Format

"uuid"

template*

The template identifier

Type

string

Required

Format

"uuid"

Request Body

application/json

{

  

"name": "string",

  

"icon": "string",

  

"color": "string",

  

"description": "string",

  

"content": [

  

],

  

"preview_file": "string"

}

Responses

Successful response

Content-Type

application/json

"string"

PUT

/mgmt/v1/spaces/{space}/blocks/{block}/templates/{template}

Playground

Authorization

bearerAuth

Variables

Key

Value

space*

block*

template*

Body

Samples

---

Delete template

DELETE

/mgmt/v1/spaces/{space}/blocks/{block}/templates/{template}

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

space*

The space identifier

Type

string

Required

Format

"uuid"

block*

The block identifier

Type

string

Required

Format

"uuid"

template*

The template identifier

Type

string

Required

Format

"uuid"

Responses

Resource deleted successfully

DELETE

/mgmt/v1/spaces/{space}/blocks/{block}/templates/{template}

Playground

Authorization

bearerAuth

Variables

Key

Value

space*

block*

template*

Samples

---

List versions

GET

/mgmt/v1/spaces/{space}/blocks/{block}/versions

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

space*

The space identifier

Type

string

Required

Format

"uuid"

block*

The block identifier

Type

string

Required

Format

"uuid"

Query Parameters

commit_message

Filter by commit_message (LIKE search)

Type

string

created_at

Filter by creation date (supports operators and ranges)

Type

string

sort

Sort by field (prefix with - for descending order)

Type

string

Valid values

"created_at""-created_at"

Responses

Successful response

Content-Type

application/json

"string"

GET

/mgmt/v1/spaces/{space}/blocks/{block}/versions

Playground

Authorization

bearerAuth

Variables

Key

Value

space*

block*

commit_message

created_at

sort

Samples

---

Get a single version

GET

/mgmt/v1/spaces/{space}/blocks/{block}/versions/{version}

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

space*

The space identifier

Type

string

Required

Format

"uuid"

block*

The block identifier

Type

string

Required

Format

"uuid"

version*

The version identifier

Type

string

Required

Format

"uuid"

Responses

Successful response

Content-Type

application/json

"string"

GET

/mgmt/v1/spaces/{space}/blocks/{block}/versions/{version}

Playground

Authorization

bearerAuth

Variables

Key

Value

space*

block*

version*

Samples

---

Delete version

DELETE

/mgmt/v1/spaces/{space}/blocks/{block}/versions/{version}

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

space*

The space identifier

Type

string

Required

Format

"uuid"

block*

The block identifier

Type

string

Required

Format

"uuid"

version*

The version identifier

Type

string

Required

Format

"uuid"

Responses

Resource deleted successfully

DELETE

/mgmt/v1/spaces/{space}/blocks/{block}/versions/{version}

Playground

Authorization

bearerAuth

Variables

Key

Value

space*

block*

version*

Samples

---

Update version

PATCH

/mgmt/v1/spaces/{space}/blocks/{block}/versions/{version}

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

space*

The space identifier

Type

string

Required

Format

"uuid"

block*

The block identifier

Type

string

Required

Format

"uuid"

version*

The version identifier

Type

string

Required

Format

"uuid"

Request Body

application/json

{

  

"commit_message": "string"

}

Responses

Successful response

Content-Type

application/json

"string"

PATCH

/mgmt/v1/spaces/{space}/blocks/{block}/versions/{version}

Playground

Authorization

bearerAuth

Variables

Key

Value

space*

block*

version*

Body

Samples

---

Create restore

POST

/mgmt/v1/spaces/{space}/blocks/{block}/versions/{version}/restore

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

space*

The space identifier

Type

string

Required

Format

"uuid"

block*

The block identifier

Type

string

Required

Format

"uuid"

version*

The version identifier

Type

string

Required

Format

"uuid"

Responses

Successful response

Content-Type

application/json

"string"

POST

/mgmt/v1/spaces/{space}/blocks/{block}/versions/{version}/restore

Playground

Authorization

bearerAuth

Variables

Key

Value

space*

block*

version*

Samples

---

Block Tags

Operations

GET/mgmt/v1/spaces/{space}/block-tagsPOST/mgmt/v1/spaces/{space}/block-tagsGET/mgmt/v1/spaces/{space}/block-tags/{tag}PUT/mgmt/v1/spaces/{space}/block-tags/{tag}DELETE/mgmt/v1/spaces/{space}/block-tags/{tag}

---

List block tags

GET

/mgmt/v1/spaces/{space}/block-tags

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

space*

The space identifier

Type

string

Required

Format

"uuid"

Responses

Successful response

Content-Type

application/json

"string"

GET

/mgmt/v1/spaces/{space}/block-tags

Playground

Authorization

bearerAuth

Variables

Key

Value

space*

Samples

---

Create block tags

POST

/mgmt/v1/spaces/{space}/block-tags

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

space*

The space identifier

Type

string

Required

Format

"uuid"

Responses

Successful response

Content-Type

application/json

"string"

POST

/mgmt/v1/spaces/{space}/block-tags

Playground

Authorization

bearerAuth

Variables

Key

Value

space*

Samples

---

Get a single block tag

GET

/mgmt/v1/spaces/{space}/block-tags/{tag}

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

space*

The space identifier

Type

string

Required

Format

"uuid"

tag*

The tag identifier

Type

string

Required

Format

"uuid"

Responses

Successful response

Content-Type

application/json

"string"

GET

/mgmt/v1/spaces/{space}/block-tags/{tag}

Playground

Authorization

bearerAuth

Variables

Key

Value

space*

tag*

Samples

---

Update block tag

PUT

/mgmt/v1/spaces/{space}/block-tags/{tag}

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

space*

The space identifier

Type

string

Required

Format

"uuid"

tag*

The tag identifier

Type

string

Required

Format

"uuid"

Responses

Successful response

Content-Type

application/json

"string"

PUT

/mgmt/v1/spaces/{space}/block-tags/{tag}

Playground

Authorization

bearerAuth

Variables

Key

Value

space*

tag*

Samples

---

Delete block tag

DELETE

/mgmt/v1/spaces/{space}/block-tags/{tag}

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

space*

The space identifier

Type

string

Required

Format

"uuid"

tag*

The tag identifier

Type

string

Required

Format

"uuid"

Responses

Resource deleted successfully

DELETE

/mgmt/v1/spaces/{space}/block-tags/{tag}

Playground

Authorization

bearerAuth

Variables

Key

Value

space*

tag*

Samples

---

Block Folders

Operations

GET/mgmt/v1/spaces/{space}/block-foldersPOST/mgmt/v1/spaces/{space}/block-foldersGET/mgmt/v1/spaces/{space}/block-folders/{folder}PUT/mgmt/v1/spaces/{space}/block-folders/{folder}DELETE/mgmt/v1/spaces/{space}/block-folders/{folder}

---

List block folders

GET

/mgmt/v1/spaces/{space}/block-folders

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

space*

The space identifier

Type

string

Required

Format

"uuid"

Responses

Successful response

Content-Type

application/json

"string"

GET

/mgmt/v1/spaces/{space}/block-folders

Playground

Authorization

bearerAuth

Variables

Key

Value

space*

Samples

---

Create block folders

POST

/mgmt/v1/spaces/{space}/block-folders

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

space*

The space identifier

Type

string

Required

Format

"uuid"

Responses

Successful response

Content-Type

application/json

"string"

POST

/mgmt/v1/spaces/{space}/block-folders

Playground

Authorization

bearerAuth

Variables

Key

Value

space*

Samples

---

Get a single block folder

GET

/mgmt/v1/spaces/{space}/block-folders/{folder}

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

space*

The space identifier

Type

string

Required

Format

"uuid"

folder*

The folder identifier

Type

string

Required

Format

"uuid"

Responses

Successful response

Content-Type

application/json

"string"

GET

/mgmt/v1/spaces/{space}/block-folders/{folder}

Playground

Authorization

bearerAuth

Variables

Key

Value

space*

folder*

Samples

---

Update block folder

PUT

/mgmt/v1/spaces/{space}/block-folders/{folder}

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

space*

The space identifier

Type

string

Required

Format

"uuid"

folder*

The folder identifier

Type

string

Required

Format

"uuid"

Responses

Successful response

Content-Type

application/json

"string"

PUT

/mgmt/v1/spaces/{space}/block-folders/{folder}

Playground

Authorization

bearerAuth

Variables

Key

Value

space*

folder*

Samples

---

Delete block folder

DELETE

/mgmt/v1/spaces/{space}/block-folders/{folder}

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

space*

The space identifier

Type

string

Required

Format

"uuid"

folder*

The folder identifier

Type

string

Required

Format

"uuid"

Responses

Resource deleted successfully

DELETE

/mgmt/v1/spaces/{space}/block-folders/{folder}

Playground

Authorization

bearerAuth

Variables

Key

Value

space*

folder*

Samples

---

Contents

Operations

GET/mgmt/v1/spaces/{space}/contentsPOST/mgmt/v1/spaces/{space}/contentsGET/mgmt/v1/spaces/{space}/contents/{content}PUT/mgmt/v1/spaces/{space}/contents/{content}DELETE/mgmt/v1/spaces/{space}/contents/{content}POST/mgmt/v1/spaces/{space}/contents/bulk-createPOST/mgmt/v1/spaces/{space}/contents/tree-operationsPOST/mgmt/v1/spaces/{space}/contents/{content}/movePOST/mgmt/v1/spaces/{space}/contents/{content}/presenceDELETE/mgmt/v1/spaces/{space}/contents/{content}/presencePOST/mgmt/v1/spaces/{space}/contents/exportPOST/mgmt/v1/spaces/{space}/contents/importPOST/mgmt/v1/spaces/{space}/contents/{content}/publishPOST/mgmt/v1/spaces/{space}/contents/{content}/unpublishPOST/mgmt/v1/spaces/{space}/contents/{content}/scheduleGET/mgmt/v1/spaces/{space}/contents/{content}/commentsPOST/mgmt/v1/spaces/{space}/contents/{content}/commentsGET/mgmt/v1/spaces/{space}/contents/{content}/comments/{comment}DELETE/mgmt/v1/spaces/{space}/contents/{content}/comments/{comment}PATCH/mgmt/v1/spaces/{space}/contents/{content}/comments/{comment}POST/mgmt/v1/spaces/{space}/contents/{content}/comments/{comment}/resolveDELETE/mgmt/v1/spaces/{space}/contents/{content}/comments/{comment}/resolveGET/mgmt/v1/spaces/{space}/contents/{content}/comments/{comment}/reactionsPOST/mgmt/v1/spaces/{space}/contents/{content}/comments/{comment}/reactionsDELETE/mgmt/v1/spaces/{space}/contents/{content}/comments/{comment}/reactionsGET/mgmt/v1/spaces/{space}/contents/{content}/versionsGET/mgmt/v1/spaces/{space}/contents/{content}/versions/{version}PATCH/mgmt/v1/spaces/{space}/contents/{content}/versions/{version}POST/mgmt/v1/spaces/{space}/contents/{content}/versions/{version}/publishPOST/mgmt/v1/spaces/{space}/contents/{content}/versions/{version}/current

---

Display a listing of the content items

GET

/mgmt/v1/spaces/{space}/contents

Display a listing of the content items.

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

space*

The space identifier

Type

string

Required

Format

"uuid"

Query Parameters

published_at

Filter by publication date and time.

Type

string

Example">=2024-01-01T00:00:00Z"

Format

"date-time"

updated_at

Filter by last update date and time.

Type

string

Example"2024-01-01T00:00:00Z...2024-01-31T23:59:59Z"

Format

"date-time"

created_at

Filter by creation date and time.

Type

string

Example"<2024-06-01T00:00:00Z"

Format

"date-time"

language

Filter by content language ISO code.

Type

string

Example"en"

language_iso

Filter by content language ISO code.

Type

string

Example"en"

content_type

Filter by block type slug used by the content entry.

Type

string

Example"page"

parent_id

Filter by parent content identifier.

Type

string

Example"01J123ABC456DEF789GHIJKLMN"

id

Filter by content identifier.

Type

string

Example"01J123ABC456DEF789GHIJKLMN"

canonical_id

Filter by canonical content identifier, including all translations.

Type

string

Example"01J123ABC456DEF789GHIJKLMN"

canonical_parent_id

Filter by canonical parent identifier, including children of translated parent variants.

Type

string

Example"01J123ABC456DEF789GHIJKLMN"

include_fallback

Include canonical content without a translation in the requested language.

Type

boolean

Exampletrue

sort

Sort by a supported field. Prefix with - for descending order.

Type

string

Valid values

"position""-position""published_at""-published_at""updated_at""-updated_at""created_at""-created_at"

Responses

Successful response

Content-Type

application/json

"string"

GET

/mgmt/v1/spaces/{space}/contents

Playground

Authorization

bearerAuth

Variables

Key

Value

space*

published_at

updated_at

created_at

language

language_iso

content_type

parent_id

id

canonical_id

canonical_parent_id

include_fallback

sort

Samples

---

Store a newly created content item in storage

POST

/mgmt/v1/spaces/{space}/contents

Store a newly created content item in storage.

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

space*

The space identifier

Type

string

Required

Format

"uuid"

Responses

Successful response

Content-Type

application/json

"string"

POST

/mgmt/v1/spaces/{space}/contents

Playground

Authorization

bearerAuth

Variables

Key

Value

space*

Samples

---

Display the specified content item

GET

/mgmt/v1/spaces/{space}/contents/{content}

Display the specified content item.

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

space*

The space identifier

Type

string

Required

Format

"uuid"

content*

The content identifier

Type

string

Required

Format

"uuid"

Responses

Successful response

Content-Type

application/json

"string"

GET

/mgmt/v1/spaces/{space}/contents/{content}

Playground

Authorization

bearerAuth

Variables

Key

Value

space*

content*

Samples

---

Update the specified content item in storage

PUT

/mgmt/v1/spaces/{space}/contents/{content}

Update the specified content item in storage.

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

space*

The space identifier

Type

string

Required

Format

"uuid"

content*

The content identifier

Type

string

Required

Format

"uuid"

Responses

Successful response

Content-Type

application/json

"string"

PUT

/mgmt/v1/spaces/{space}/contents/{content}

Playground

Authorization

bearerAuth

Variables

Key

Value

space*

content*

Samples

---

Remove the specified content item from storage

DELETE

/mgmt/v1/spaces/{space}/contents/{content}

Remove the specified content item from storage.

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

space*

The space identifier

Type

string

Required

Format

"uuid"

content*

The content identifier

Type

string

Required

Format

"uuid"

Responses

Resource deleted successfully

DELETE

/mgmt/v1/spaces/{space}/contents/{content}

Playground

Authorization

bearerAuth

Variables

Key

Value

space*

content*

Samples

---

Create bulk create

POST

/mgmt/v1/spaces/{space}/contents/bulk-create

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

space*

The space identifier

Type

string

Required

Format

"uuid"

Responses

Successful response

POST

/mgmt/v1/spaces/{space}/contents/bulk-create

Playground

Authorization

bearerAuth

Variables

Key

Value

space*

Samples

---

Create tree operations

POST

/mgmt/v1/spaces/{space}/contents/tree-operations

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

space*

The space identifier

Type

string

Required

Format

"uuid"

Responses

Successful response

POST

/mgmt/v1/spaces/{space}/contents/tree-operations

Playground

Authorization

bearerAuth

Variables

Key

Value

space*

Samples

---

Create move

POST

/mgmt/v1/spaces/{space}/contents/{content}/move

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

space*

The space identifier

Type

string

Required

Format

"uuid"

content*

The content identifier

Type

string

Required

Format

"uuid"

Responses

Successful response

Content-Type

application/json

"string"

POST

/mgmt/v1/spaces/{space}/contents/{content}/move

Playground

Authorization

bearerAuth

Variables

Key

Value

space*

content*

Samples

---

Create presence

POST

/mgmt/v1/spaces/{space}/contents/{content}/presence

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

space*

The space identifier

Type

string

Required

Format

"uuid"

content*

The content identifier

Type

string

Required

Format

"uuid"

Responses

Successful response

POST

/mgmt/v1/spaces/{space}/contents/{content}/presence

Playground

Authorization

bearerAuth

Variables

Key

Value

space*

content*

Samples

---

Delete presence

DELETE

/mgmt/v1/spaces/{space}/contents/{content}/presence

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

space*

The space identifier

Type

string

Required

Format

"uuid"

content*

The content identifier

Type

string

Required

Format

"uuid"

Responses

Successful response

DELETE

/mgmt/v1/spaces/{space}/contents/{content}/presence

Playground

Authorization

bearerAuth

Variables

Key

Value

space*

content*

Samples

---

Create export

POST

/mgmt/v1/spaces/{space}/contents/export

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

space*

The space identifier

Type

string

Required

Format

"uuid"

Request Body

application/json

{

  

"as": "string"

}

Responses

Successful response

POST

/mgmt/v1/spaces/{space}/contents/export

Playground

Authorization

bearerAuth

Variables

Key

Value

space*

Body

Samples

---

Create import

POST

/mgmt/v1/spaces/{space}/contents/import

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

space*

The space identifier

Type

string

Required

Format

"uuid"

Request Body

application/json

{

  

"file": "",

  

"import_mode": "string",

  

"create_missing": true

}

Responses

Successful response

POST

/mgmt/v1/spaces/{space}/contents/import

Playground

Authorization

bearerAuth

Variables

Key

Value

space*

Body

Samples

---

Create publish

POST

/mgmt/v1/spaces/{space}/contents/{content}/publish

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

space*

The space identifier

Type

string

Required

Format

"uuid"

content*

The content identifier

Type

string

Required

Format

"uuid"

Responses

Successful response

Content-Type

application/json

"string"

POST

/mgmt/v1/spaces/{space}/contents/{content}/publish

Playground

Authorization

bearerAuth

Variables

Key

Value

space*

content*

Samples

---

Create unpublish

POST

/mgmt/v1/spaces/{space}/contents/{content}/unpublish

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

space*

The space identifier

Type

string

Required

Format

"uuid"

content*

The content identifier

Type

string

Required

Format

"uuid"

Responses

Successful response

Content-Type

application/json

"string"

POST

/mgmt/v1/spaces/{space}/contents/{content}/unpublish

Playground

Authorization

bearerAuth

Variables

Key

Value

space*

content*

Samples

---

Create schedule

POST

/mgmt/v1/spaces/{space}/contents/{content}/schedule

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

space*

The space identifier

Type

string

Required

Format

"uuid"

content*

The content identifier

Type

string

Required

Format

"uuid"

Responses

Successful response

Content-Type

application/json

"string"

POST

/mgmt/v1/spaces/{space}/contents/{content}/schedule

Playground

Authorization

bearerAuth

Variables

Key

Value

space*

content*

Samples

---

Get root comments for content

GET

/mgmt/v1/spaces/{space}/contents/{content}/comments

Get root comments for content

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

space*

The space identifier

Type

string

Required

Format

"uuid"

content*

The content identifier

Type

string

Required

Format

"uuid"

Query Parameters

content_id

Filter by content_id

Type

string

content_version_id

Filter by content_version_id

Type

string

author_id

Filter by author_id

Type

string

is_resolved

Filter by is_resolved

Type

string

item_id

Filter by item_id

Type

string

field

Filter by field

Type

string

q

Free-text search filter.

Type

string

created_at

Filter by creation date (supports operators and ranges)

Type

string

updated_at

Filter by update date (supports operators and ranges)

Type

string

sort

Sort by field (prefix with - for descending order)

Type

string

Valid values

"created_at""-created_at""updated_at""-updated_at""is_resolved""-is_resolved"

Responses

Successful response

Content-Type

application/json

"string"

GET

/mgmt/v1/spaces/{space}/contents/{content}/comments

Playground

Authorization

bearerAuth

Variables

Key

Value

space*

content*

content_id

content_version_id

author_id

is_resolved

item_id

field

q

created_at

updated_at

sort

Samples

---

Create a root comment or reply

POST

/mgmt/v1/spaces/{space}/contents/{content}/comments

Create a root comment or reply

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

space*

The space identifier

Type

string

Required

Format

"uuid"

content*

The content identifier

Type

string

Required

Format

"uuid"

Responses

Successful response

Content-Type

application/json

"string"

POST

/mgmt/v1/spaces/{space}/contents/{content}/comments

Playground

Authorization

bearerAuth

Variables

Key

Value

space*

content*

Samples

---

Get a specific comment (root or reply)

GET

/mgmt/v1/spaces/{space}/contents/{content}/comments/{comment}

Get a specific comment (root or reply)

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

space*

The space identifier

Type

string

Required

Format

"uuid"

content*

The content identifier

Type

string

Required

Format

"uuid"

comment*

The comment identifier

Type

string

Required

Format

"uuid"

Responses

Successful response

Content-Type

application/json

"string"

GET

/mgmt/v1/spaces/{space}/contents/{content}/comments/{comment}

Playground

Authorization

bearerAuth

Variables

Key

Value

space*

content*

comment*

Samples

---

Delete a comment (root or reply)

DELETE

/mgmt/v1/spaces/{space}/contents/{content}/comments/{comment}

Delete a comment (root or reply)

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

space*

The space identifier

Type

string

Required

Format

"uuid"

content*

The content identifier

Type

string

Required

Format

"uuid"

comment*

The comment identifier

Type

string

Required

Format

"uuid"

Responses

Resource deleted successfully

DELETE

/mgmt/v1/spaces/{space}/contents/{content}/comments/{comment}

Playground

Authorization

bearerAuth

Variables

Key

Value

space*

content*

comment*

Samples

---

Update a comment (root or reply)

PATCH

/mgmt/v1/spaces/{space}/contents/{content}/comments/{comment}

Update a comment (root or reply)

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

space*

The space identifier

Type

string

Required

Format

"uuid"

content*

The content identifier

Type

string

Required

Format

"uuid"

comment*

The comment identifier

Type

string

Required

Format

"uuid"

Request Body

application/json

{

  

"body": "string",

  

"item_id": "string",

  

"field": "string",

  

"position": {

  

  

"x": 0,

  

  

"y": 0

  

}

}

Responses

Successful response

Content-Type

application/json

"string"

PATCH

/mgmt/v1/spaces/{space}/contents/{content}/comments/{comment}

Playground

Authorization

bearerAuth

Variables

Key

Value

space*

content*

comment*

Body

Samples

---

Resolve a comment

POST

/mgmt/v1/spaces/{space}/contents/{content}/comments/{comment}/resolve

Resolve a comment

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

space*

The space identifier

Type

string

Required

Format

"uuid"

content*

The content identifier

Type

string

Required

Format

"uuid"

comment*

The comment identifier

Type

string

Required

Format

"uuid"

Responses

Successful response

Content-Type

application/json

"string"

POST

/mgmt/v1/spaces/{space}/contents/{content}/comments/{comment}/resolve

Playground

Authorization

bearerAuth

Variables

Key

Value

space*

content*

comment*

Samples

---

Unresolve a comment

DELETE

/mgmt/v1/spaces/{space}/contents/{content}/comments/{comment}/resolve

Unresolve a comment

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

space*

The space identifier

Type

string

Required

Format

"uuid"

content*

The content identifier

Type

string

Required

Format

"uuid"

comment*

The comment identifier

Type

string

Required

Format

"uuid"

Responses

Successful response

Content-Type

application/json

"string"

DELETE

/mgmt/v1/spaces/{space}/contents/{content}/comments/{comment}/resolve

Playground

Authorization

bearerAuth

Variables

Key

Value

space*

content*

comment*

Samples

---

List reactions

GET

/mgmt/v1/spaces/{space}/contents/{content}/comments/{comment}/reactions

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

space*

The space identifier

Type

string

Required

Format

"uuid"

content*

The content identifier

Type

string

Required

Format

"uuid"

comment*

The comment identifier

Type

string

Required

Format

"uuid"

Responses

Successful response

Content-Type

application/json

"string"

GET

/mgmt/v1/spaces/{space}/contents/{content}/comments/{comment}/reactions

Playground

Authorization

bearerAuth

Variables

Key

Value

space*

content*

comment*

Samples

---

Create reactions

POST

/mgmt/v1/spaces/{space}/contents/{content}/comments/{comment}/reactions

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

space*

The space identifier

Type

string

Required

Format

"uuid"

content*

The content identifier

Type

string

Required

Format

"uuid"

comment*

The comment identifier

Type

string

Required

Format

"uuid"

Request Body

application/json

{

  

"emoji": "string"

}

Responses

Successful response

Content-Type

application/json

"string"

POST

/mgmt/v1/spaces/{space}/contents/{content}/comments/{comment}/reactions

Playground

Authorization

bearerAuth

Variables

Key

Value

space*

content*

comment*

Body

Samples

---

Delete reactions

DELETE

/mgmt/v1/spaces/{space}/contents/{content}/comments/{comment}/reactions

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

space*

The space identifier

Type

string

Required

Format

"uuid"

content*

The content identifier

Type

string

Required

Format

"uuid"

comment*

The comment identifier

Type

string

Required

Format

"uuid"

Request Body

application/json

{

  

"emoji": "string"

}

Responses

Resource deleted successfully

DELETE

/mgmt/v1/spaces/{space}/contents/{content}/comments/{comment}/reactions

Playground

Authorization

bearerAuth

Variables

Key

Value

space*

content*

comment*

Body

Samples

---

List versions

GET

/mgmt/v1/spaces/{space}/contents/{content}/versions

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

space*

The space identifier

Type

string

Required

Format

"uuid"

content*

The content identifier

Type

string

Required

Format

"uuid"

Query Parameters

created_at

Filter by creation date (supports operators and ranges)

Type

string

external_id

Filter by external_id

Type

string

created_by

Filter by created_by

Type

string

release_id

Filter by release_id

Type

string

isPublished

Filter by isPublished

Type

boolean

isCurrentVersion

Filter by isCurrentVersion

Type

boolean

sort

Sort by field (prefix with - for descending order)

Type

string

Valid values

"created_at""-created_at"

Responses

Successful response

Content-Type

application/json

"string"

GET

/mgmt/v1/spaces/{space}/contents/{content}/versions

Playground

Authorization

bearerAuth

Variables

Key

Value

space*

content*

created_at

external_id

created_by

release_id

isPublished

isCurrentVersion

sort

Samples

---

Get a single version

GET

/mgmt/v1/spaces/{space}/contents/{content}/versions/{version}

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

space*

The space identifier

Type

string

Required

Format

"uuid"

content*

The content identifier

Type

string

Required

Format

"uuid"

version*

The version identifier

Type

string

Required

Format

"uuid"

Responses

Successful response

Content-Type

application/json

"string"

GET

/mgmt/v1/spaces/{space}/contents/{content}/versions/{version}

Playground

Authorization

bearerAuth

Variables

Key

Value

space*

content*

version*

Samples

---

Update version

PATCH

/mgmt/v1/spaces/{space}/contents/{content}/versions/{version}

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

space*

The space identifier

Type

string

Required

Format

"uuid"

content*

The content identifier

Type

string

Required

Format

"uuid"

version*

The version identifier

Type

string

Required

Format

"uuid"

Responses

Successful response

Content-Type

application/json

"string"

PATCH

/mgmt/v1/spaces/{space}/contents/{content}/versions/{version}

Playground

Authorization

bearerAuth

Variables

Key

Value

space*

content*

version*

Samples

---

Create publish

POST

/mgmt/v1/spaces/{space}/contents/{content}/versions/{version}/publish

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

space*

The space identifier

Type

string

Required

Format

"uuid"

content*

The content identifier

Type

string

Required

Format

"uuid"

version*

The version identifier

Type

string

Required

Format

"uuid"

Responses

Successful response

POST

/mgmt/v1/spaces/{space}/contents/{content}/versions/{version}/publish

Playground

Authorization

bearerAuth

Variables

Key

Value

space*

content*

version*

Samples

---

Create current

POST

/mgmt/v1/spaces/{space}/contents/{content}/versions/{version}/current

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

space*

The space identifier

Type

string

Required

Format

"uuid"

content*

The content identifier

Type

string

Required

Format

"uuid"

version*

The version identifier

Type

string

Required

Format

"uuid"

Responses

Successful response

POST

/mgmt/v1/spaces/{space}/contents/{content}/versions/{version}/current

Playground

Authorization

bearerAuth

Variables

Key

Value

space*

content*

version*

Samples

---

Audit Logs

Operations

GET/mgmt/v1/spaces/{space}/audit-logs

---

List audit logs

GET

/mgmt/v1/spaces/{space}/audit-logs

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

space*

The space identifier

Type

string

Required

Format

"uuid"

Query Parameters

created_at

Filter by creation date (supports operators and ranges)

Type

string

owner_type

Filter by owner_type

Type

string

owner

Filter by owner

Type

string

operation

Filter by operation

Type

string

referenced_type

Filter by referenced_type

Type

string

name

Filter by name (LIKE search)

Type

string

sort

Sort by field (prefix with - for descending order)

Type

string

Valid values

"created_at""-created_at""owner_name""-owner_name""operation""-operation""referenced_type""-referenced_type""name""-name"

Responses

Successful response

Content-Type

application/json

"string"

GET

/mgmt/v1/spaces/{space}/audit-logs

Playground

Authorization

bearerAuth

Variables

Key

Value

space*

created_at

owner_type

owner

operation

referenced_type

name

sort

Samples

---

Redirects

Operations

GET/mgmt/v1/spaces/{space}/redirectsPOST/mgmt/v1/spaces/{space}/redirectsGET/mgmt/v1/spaces/{space}/redirects/{redirect}PUT/mgmt/v1/spaces/{space}/redirects/{redirect}DELETE/mgmt/v1/spaces/{space}/redirects/{redirect}POST/mgmt/v1/spaces/{space}/redirects/{redirect}/resetPOST/mgmt/v1/spaces/{space}/redirects/exportPOST/mgmt/v1/spaces/{space}/redirects/import

---

List redirects

GET

/mgmt/v1/spaces/{space}/redirects

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

space*

The space identifier

Type

string

Required

Format

"uuid"

Query Parameters

source

Filter by source

Type

string

target

Filter by target

Type

string

status_code

Filter by status_code

Type

string

q

Free-text search filter.

Type

string

sort

Sort by field (prefix with - for descending order)

Type

string

Valid values

"source""-source""target""-target""status_code""-status_code"

Responses

Successful response

Content-Type

application/json

"string"

GET

/mgmt/v1/spaces/{space}/redirects

Playground

Authorization

bearerAuth

Variables

Key

Value

space*

source

target

status_code

q

sort

Samples

---

Create redirects

POST

/mgmt/v1/spaces/{space}/redirects

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

space*

The space identifier

Type

string

Required

Format

"uuid"

Responses

Successful response

Content-Type

application/json

"string"

POST

/mgmt/v1/spaces/{space}/redirects

Playground

Authorization

bearerAuth

Variables

Key

Value

space*

Samples

---

Get a single redirect

GET

/mgmt/v1/spaces/{space}/redirects/{redirect}

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

space*

The space identifier

Type

string

Required

Format

"uuid"

redirect*

The redirect identifier

Type

string

Required

Format

"uuid"

Responses

Successful response

Content-Type

application/json

"string"

GET

/mgmt/v1/spaces/{space}/redirects/{redirect}

Playground

Authorization

bearerAuth

Variables

Key

Value

space*

redirect*

Samples

---

Update redirect

PUT

/mgmt/v1/spaces/{space}/redirects/{redirect}

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

space*

The space identifier

Type

string

Required

Format

"uuid"

redirect*

The redirect identifier

Type

string

Required

Format

"uuid"

Responses

Successful response

Content-Type

application/json

"string"

PUT

/mgmt/v1/spaces/{space}/redirects/{redirect}

Playground

Authorization

bearerAuth

Variables

Key

Value

space*

redirect*

Samples

---

Delete redirect

DELETE

/mgmt/v1/spaces/{space}/redirects/{redirect}

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

space*

The space identifier

Type

string

Required

Format

"uuid"

redirect*

The redirect identifier

Type

string

Required

Format

"uuid"

Responses

Resource deleted successfully

DELETE

/mgmt/v1/spaces/{space}/redirects/{redirect}

Playground

Authorization

bearerAuth

Variables

Key

Value

space*

redirect*

Samples

---

Create reset

POST

/mgmt/v1/spaces/{space}/redirects/{redirect}/reset

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

space*

The space identifier

Type

string

Required

Format

"uuid"

redirect*

The redirect identifier

Type

string

Required

Format

"uuid"

Responses

Successful response

Content-Type

application/json

"string"

POST

/mgmt/v1/spaces/{space}/redirects/{redirect}/reset

Playground

Authorization

bearerAuth

Variables

Key

Value

space*

redirect*

Samples

---

Create export

POST

/mgmt/v1/spaces/{space}/redirects/export

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

space*

The space identifier

Type

string

Required

Format

"uuid"

Query Parameters

source

Filter by source

Type

string

target

Filter by target

Type

string

status_code

Filter by status_code

Type

string

q

Free-text search filter.

Type

string

sort

Sort by field (prefix with - for descending order)

Type

string

Valid values

"source""-source""target""-target""status_code""-status_code"

Request Body

application/json

{

  

"as": "string"

}

Responses

Successful response

POST

/mgmt/v1/spaces/{space}/redirects/export

Playground

Authorization

bearerAuth

Variables

Key

Value

space*

source

target

status_code

q

sort

Body

Samples

---

Create import

POST

/mgmt/v1/spaces/{space}/redirects/import

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

space*

The space identifier

Type

string

Required

Format

"uuid"

Request Body

application/json

{

  

"file": "",

  

"import_mode": "string"

}

Responses

Successful response

POST

/mgmt/v1/spaces/{space}/redirects/import

Playground

Authorization

bearerAuth

Variables

Key

Value

space*

Body

Samples

---

Content Menu

Operations

GET/mgmt/v1/spaces/{space}/content-menu

---

Get the content tree structure for menu navigation

GET

/mgmt/v1/spaces/{space}/content-menu

Get the content tree structure for menu navigation.

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

space*

The space identifier

Type

string

Required

Format

"uuid"

Query Parameters

name

Filter by name (LIKE search)

Type

string

slug

Filter by slug (LIKE search)

Type

string

block_id

Filter by block_id

Type

string

parent_id

Filter by parent ID

sort

Sort by field (prefix with - for descending order)

Type

string

Valid values

"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

/mgmt/v1/spaces/{space}/content-menu

Playground

Authorization

bearerAuth

Variables

Key

Value

space*

name

slug

block_id

parent_id

sort

Samples

---

Stats

Operations

GET/mgmt/v1/spaces/{space}/stats

---

Get dashboard statistics for a space

GET

/mgmt/v1/spaces/{space}/stats

Get dashboard statistics for a space

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

space*

The space identifier

Type

string

Required

Format

"uuid"

Responses

Successful response

GET

/mgmt/v1/spaces/{space}/stats

Playground

Authorization

bearerAuth

Variables

Key

Value

space*

Samples

---

Presence

Operations

POST/mgmt/v1/spaces/{space}/presenceDELETE/mgmt/v1/spaces/{space}/presence

---

Create presence

POST

/mgmt/v1/spaces/{space}/presence

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

space*

The space identifier

Type

string

Required

Format

"uuid"

Responses

Successful response

POST

/mgmt/v1/spaces/{space}/presence

Playground

Authorization

bearerAuth

Variables

Key

Value

space*

Samples

---

Delete presence

DELETE

/mgmt/v1/spaces/{space}/presence

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

space*

The space identifier

Type

string

Required

Format

"uuid"

Responses

Successful response

DELETE

/mgmt/v1/spaces/{space}/presence

Playground

Authorization

bearerAuth

Variables

Key

Value

space*

Samples

---

Asset Folders

Operations

GET/mgmt/v1/spaces/{space}/asset-foldersPOST/mgmt/v1/spaces/{space}/asset-foldersGET/mgmt/v1/spaces/{space}/asset-folders/{asset_folder}PUT/mgmt/v1/spaces/{space}/asset-folders/{asset_folder}DELETE/mgmt/v1/spaces/{space}/asset-folders/{asset_folder}

---

Display a listing of asset folders

GET

/mgmt/v1/spaces/{space}/asset-folders

Display a listing of asset folders.

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

space*

The space identifier

Type

string

Required

Format

"uuid"

Responses

Successful response

Content-Type

application/json

"string"

GET

/mgmt/v1/spaces/{space}/asset-folders

Playground

Authorization

bearerAuth

Variables

Key

Value

space*

Samples

---

Store a newly created asset folder

POST

/mgmt/v1/spaces/{space}/asset-folders

Store a newly created asset folder.

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

space*

The space identifier

Type

string

Required

Format

"uuid"

Responses

Successful response

Content-Type

application/json

"string"

POST

/mgmt/v1/spaces/{space}/asset-folders

Playground

Authorization

bearerAuth

Variables

Key

Value

space*

Samples

---

Display the specified asset folder

GET

/mgmt/v1/spaces/{space}/asset-folders/{asset_folder}

Display the specified asset folder.

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

space*

The space identifier

Type

string

Required

Format

"uuid"

Responses

Successful response

Content-Type

application/json

"string"

GET

/mgmt/v1/spaces/{space}/asset-folders/{asset_folder}

Playground

Authorization

bearerAuth

Variables

Key

Value

space*

Samples

---

Update the specified asset folder

PUT

/mgmt/v1/spaces/{space}/asset-folders/{asset_folder}

Update the specified asset folder.

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

space*

The space identifier

Type

string

Required

Format

"uuid"

Responses

Successful response

Content-Type

application/json

"string"

PUT

/mgmt/v1/spaces/{space}/asset-folders/{asset_folder}

Playground

Authorization

bearerAuth

Variables

Key

Value

space*

Samples

---

Remove the specified asset folder

DELETE

/mgmt/v1/spaces/{space}/asset-folders/{asset_folder}

Remove the specified asset folder.

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

space*

The space identifier

Type

string

Required

Format

"uuid"

Responses

Resource deleted successfully

DELETE

/mgmt/v1/spaces/{space}/asset-folders/{asset_folder}

Playground

Authorization

bearerAuth

Variables

Key

Value

space*

Samples

---

Asset Tags

Operations

GET/mgmt/v1/spaces/{space}/asset-tagsPOST/mgmt/v1/spaces/{space}/asset-tagsGET/mgmt/v1/spaces/{space}/asset-tags/{tag}PUT/mgmt/v1/spaces/{space}/asset-tags/{tag}DELETE/mgmt/v1/spaces/{space}/asset-tags/{tag}POST/mgmt/v1/spaces/{space}/asset-tags/{tag}/assign

---

List asset tags

GET

/mgmt/v1/spaces/{space}/asset-tags

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

space*

The space identifier

Type

string

Required

Format

"uuid"

Responses

Successful response

Content-Type

application/json

"string"

GET

/mgmt/v1/spaces/{space}/asset-tags

Playground

Authorization

bearerAuth

Variables

Key

Value

space*

Samples

---

Create asset tags

POST

/mgmt/v1/spaces/{space}/asset-tags

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

space*

The space identifier

Type

string

Required

Format

"uuid"

Responses

Successful response

Content-Type

application/json

"string"

POST

/mgmt/v1/spaces/{space}/asset-tags

Playground

Authorization

bearerAuth

Variables

Key

Value

space*

Samples

---

Get a single asset tag

GET

/mgmt/v1/spaces/{space}/asset-tags/{tag}

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

space*

The space identifier

Type

string

Required

Format

"uuid"

tag*

The tag identifier

Type

string

Required

Format

"uuid"

Responses

Successful response

Content-Type

application/json

"string"

GET

/mgmt/v1/spaces/{space}/asset-tags/{tag}

Playground

Authorization

bearerAuth

Variables

Key

Value

space*

tag*

Samples

---

Update asset tag

PUT

/mgmt/v1/spaces/{space}/asset-tags/{tag}

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

space*

The space identifier

Type

string

Required

Format

"uuid"

tag*

The tag identifier

Type

string

Required

Format

"uuid"

Responses

Successful response

Content-Type

application/json

"string"

PUT

/mgmt/v1/spaces/{space}/asset-tags/{tag}

Playground

Authorization

bearerAuth

Variables

Key

Value

space*

tag*

Samples

---

Delete asset tag

DELETE

/mgmt/v1/spaces/{space}/asset-tags/{tag}

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

space*

The space identifier

Type

string

Required

Format

"uuid"

tag*

The tag identifier

Type

string

Required

Format

"uuid"

Responses

Resource deleted successfully

DELETE

/mgmt/v1/spaces/{space}/asset-tags/{tag}

Playground

Authorization

bearerAuth

Variables

Key

Value

space*

tag*

Samples

---

Create assign

POST

/mgmt/v1/spaces/{space}/asset-tags/{tag}/assign

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

space*

The space identifier

Type

string

Required

Format

"uuid"

tag*

The tag identifier

Type

string

Required

Format

"uuid"

Responses

Successful response

POST

/mgmt/v1/spaces/{space}/asset-tags/{tag}/assign

Playground

Authorization

bearerAuth

Variables

Key

Value

space*

tag*

Samples

---

Assets

Operations

GET/mgmt/v1/spaces/{space}/assets/{asset}/linked-contentsPOST/mgmt/v1/spaces/{space}/assets/{asset}/replace-fileGET/mgmt/v1/spaces/{space}/assets/{asset}/versionsPOST/mgmt/v1/spaces/{space}/assets/{asset}/versions/{version}/restoreGET/mgmt/v1/spaces/{space}/assetsPOST/mgmt/v1/spaces/{space}/assetsGET/mgmt/v1/spaces/{space}/assets/{asset}PUT/mgmt/v1/spaces/{space}/assets/{asset}DELETE/mgmt/v1/spaces/{space}/assets/{asset}POST/mgmt/v1/spaces/{space}/assets/exportPOST/mgmt/v1/spaces/{space}/assets/import

---

List linked contents

GET

/mgmt/v1/spaces/{space}/assets/{asset}/linked-contents

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

space*

The space identifier

Type

string

Required

Format

"uuid"

asset*

The asset identifier

Type

string

Required

Format

"uuid"

Responses

Successful response

Content-Type

application/json

"string"

GET

/mgmt/v1/spaces/{space}/assets/{asset}/linked-contents

Playground

Authorization

bearerAuth

Variables

Key

Value

space*

asset*

Samples

---

Replace the physical file of an existing asset (keeps ID, busts CDN cache via new filename)

POST

/mgmt/v1/spaces/{space}/assets/{asset}/replace-file

Replace the physical file of an existing asset (keeps ID, busts CDN cache via new filename).

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

space*

The space identifier

Type

string

Required

Format

"uuid"

asset*

The asset identifier

Type

string

Required

Format

"uuid"

Request Body

application/json

{

  

"file": ""

}

Responses

Successful response

Content-Type

application/json

"string"

POST

/mgmt/v1/spaces/{space}/assets/{asset}/replace-file

Playground

Authorization

bearerAuth

Variables

Key

Value

space*

asset*

Body

Samples

---

List the version history of an asset, most recent first

GET

/mgmt/v1/spaces/{space}/assets/{asset}/versions

List the version history of an asset, most recent first.

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

space*

The space identifier

Type

string

Required

Format

"uuid"

asset*

The asset identifier

Type

string

Required

Format

"uuid"

Responses

Successful response

Content-Type

application/json

"string"

GET

/mgmt/v1/spaces/{space}/assets/{asset}/versions

Playground

Authorization

bearerAuth

Variables

Key

Value

space*

asset*

Samples

---

Restore an asset to a previous version's file + metadata

POST

/mgmt/v1/spaces/{space}/assets/{asset}/versions/{version}/restore

Restore an asset to a previous version's file + metadata. The current
state is itself snapshotted first, so this is non-destructive.

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

space*

The space identifier

Type

string

Required

Format

"uuid"

asset*

The asset identifier

Type

string

Required

Format

"uuid"

version*

The version identifier

Type

string

Required

Format

"uuid"

Responses

Successful response

Content-Type

application/json

"string"

POST

/mgmt/v1/spaces/{space}/assets/{asset}/versions/{version}/restore

Playground

Authorization

bearerAuth

Variables

Key

Value

space*

asset*

version*

Samples

---

Display a listing of assets

GET

/mgmt/v1/spaces/{space}/assets

Display a listing of assets.

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

space*

The space identifier

Type

string

Required

Format

"uuid"

Responses

Successful response

Content-Type

application/json

"string"

GET

/mgmt/v1/spaces/{space}/assets

Playground

Authorization

bearerAuth

Variables

Key

Value

space*

Samples

---

Store a newly created asset

POST

/mgmt/v1/spaces/{space}/assets

Store a newly created asset.

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

space*

The space identifier

Type

string

Required

Format

"uuid"

Responses

Successful response

Content-Type

application/json

"string"

POST

/mgmt/v1/spaces/{space}/assets

Playground

Authorization

bearerAuth

Variables

Key

Value

space*

Samples

---

Display the specified asset

GET

/mgmt/v1/spaces/{space}/assets/{asset}

Display the specified asset.

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

space*

The space identifier

Type

string

Required

Format

"uuid"

asset*

The asset identifier

Type

string

Required

Format

"uuid"

Responses

Successful response

Content-Type

application/json

"string"

GET

/mgmt/v1/spaces/{space}/assets/{asset}

Playground

Authorization

bearerAuth

Variables

Key

Value

space*

asset*

Samples

---

Update the specified asset metadata

PUT

/mgmt/v1/spaces/{space}/assets/{asset}

Update the specified asset metadata.

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

space*

The space identifier

Type

string

Required

Format

"uuid"

asset*

The asset identifier

Type

string

Required

Format

"uuid"

Responses

Successful response

Content-Type

application/json

"string"

PUT

/mgmt/v1/spaces/{space}/assets/{asset}

Playground

Authorization

bearerAuth

Variables

Key

Value

space*

asset*

Samples

---

Remove the specified asset

DELETE

/mgmt/v1/spaces/{space}/assets/{asset}

Remove the specified asset.

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

space*

The space identifier

Type

string

Required

Format

"uuid"

asset*

The asset identifier

Type

string

Required

Format

"uuid"

Responses

Resource deleted successfully

DELETE

/mgmt/v1/spaces/{space}/assets/{asset}

Playground

Authorization

bearerAuth

Variables

Key

Value

space*

asset*

Samples

---

Create export

POST

/mgmt/v1/spaces/{space}/assets/export

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

space*

The space identifier

Type

string

Required

Format

"uuid"

Request Body

application/json

{

  

"as": "string"

}

Responses

Successful response

POST

/mgmt/v1/spaces/{space}/assets/export

Playground

Authorization

bearerAuth

Variables

Key

Value

space*

Body

Samples

---

Create import

POST

/mgmt/v1/spaces/{space}/assets/import

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

space*

The space identifier

Type

string

Required

Format

"uuid"

Request Body

application/json

{

  

"file": ""

}

Responses

Successful response

POST

/mgmt/v1/spaces/{space}/assets/import

Playground

Authorization

bearerAuth

Variables

Key

Value

space*

Body

Samples

---

Asset Collections

Operations

GET/mgmt/v1/spaces/{space}/asset-collections/{collection}/assetsPOST/mgmt/v1/spaces/{space}/asset-collections/{collection}/assetsDELETE/mgmt/v1/spaces/{space}/asset-collections/{collection}/assetsPATCH/mgmt/v1/spaces/{space}/asset-collections/{collection}/assets/orderGET/mgmt/v1/spaces/{space}/asset-collectionsPOST/mgmt/v1/spaces/{space}/asset-collectionsGET/mgmt/v1/spaces/{space}/asset-collections/{collection}PUT/mgmt/v1/spaces/{space}/asset-collections/{collection}DELETE/mgmt/v1/spaces/{space}/asset-collections/{collection}

---

List the assets of a collection

GET

/mgmt/v1/spaces/{space}/asset-collections/{collection}/assets

List the assets of a collection. Manual collections resolve their
explicit items (ordered by position unless the client sorts), smart
collections evaluate their stored rules.

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

space*

The space identifier

Type

string

Required

Format

"uuid"

collection*

The collection identifier

Type

string

Required

Format

"uuid"

Responses

Successful response

Content-Type

application/json

"string"

GET

/mgmt/v1/spaces/{space}/asset-collections/{collection}/assets

Playground

Authorization

bearerAuth

Variables

Key

Value

space*

collection*

Samples

---

Add assets to a manual collection, appended after the current last

POST

/mgmt/v1/spaces/{space}/asset-collections/{collection}/assets

Add assets to a manual collection, appended after the current last
position. Assets already in the collection are silently skipped.

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

space*

The space identifier

Type

string

Required

Format

"uuid"

collection*

The collection identifier

Type

string

Required

Format

"uuid"

Responses

Successful response

POST

/mgmt/v1/spaces/{space}/asset-collections/{collection}/assets

Playground

Authorization

bearerAuth

Variables

Key

Value

space*

collection*

Samples

---

Remove assets from a manual collection

DELETE

/mgmt/v1/spaces/{space}/asset-collections/{collection}/assets

Remove assets from a manual collection.

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

space*

The space identifier

Type

string

Required

Format

"uuid"

collection*

The collection identifier

Type

string

Required

Format

"uuid"

Responses

Resource deleted successfully

DELETE

/mgmt/v1/spaces/{space}/asset-collections/{collection}/assets

Playground

Authorization

bearerAuth

Variables

Key

Value

space*

collection*

Samples

---

Reorder a manual collection: `asset_ids` is the full ordered list,

PATCH

/mgmt/v1/spaces/{space}/asset-collections/{collection}/assets/order

Reorder a manual collection: asset_ids is the full ordered list,
each item's position becomes its array index.

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

space*

The space identifier

Type

string

Required

Format

"uuid"

collection*

The collection identifier

Type

string

Required

Format

"uuid"

Responses

Successful response

PATCH

/mgmt/v1/spaces/{space}/asset-collections/{collection}/assets/order

Playground

Authorization

bearerAuth

Variables

Key

Value

space*

collection*

Samples

---

List asset collections

GET

/mgmt/v1/spaces/{space}/asset-collections

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

space*

The space identifier

Type

string

Required

Format

"uuid"

Responses

Successful response

Content-Type

application/json

"string"

GET

/mgmt/v1/spaces/{space}/asset-collections

Playground

Authorization

bearerAuth

Variables

Key

Value

space*

Samples

---

Create asset collections

POST

/mgmt/v1/spaces/{space}/asset-collections

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

space*

The space identifier

Type

string

Required

Format

"uuid"

Responses

Successful response

Content-Type

application/json

"string"

POST

/mgmt/v1/spaces/{space}/asset-collections

Playground

Authorization

bearerAuth

Variables

Key

Value

space*

Samples

---

Get a single asset collection

GET

/mgmt/v1/spaces/{space}/asset-collections/{collection}

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

space*

The space identifier

Type

string

Required

Format

"uuid"

collection*

The collection identifier

Type

string

Required

Format

"uuid"

Responses

Successful response

Content-Type

application/json

"string"

GET

/mgmt/v1/spaces/{space}/asset-collections/{collection}

Playground

Authorization

bearerAuth

Variables

Key

Value

space*

collection*

Samples

---

Update asset collection

PUT

/mgmt/v1/spaces/{space}/asset-collections/{collection}

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

space*

The space identifier

Type

string

Required

Format

"uuid"

collection*

The collection identifier

Type

string

Required

Format

"uuid"

Responses

Successful response

Content-Type

application/json

"string"

PUT

/mgmt/v1/spaces/{space}/asset-collections/{collection}

Playground

Authorization

bearerAuth

Variables

Key

Value

space*

collection*

Samples

---

Delete asset collection

DELETE

/mgmt/v1/spaces/{space}/asset-collections/{collection}

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

space*

The space identifier

Type

string

Required

Format

"uuid"

collection*

The collection identifier

Type

string

Required

Format

"uuid"

Responses

Resource deleted successfully

DELETE

/mgmt/v1/spaces/{space}/asset-collections/{collection}

Playground

Authorization

bearerAuth

Variables

Key

Value

space*

collection*

Samples

---

Asset Packages

Operations

GET/mgmt/v1/spaces/{space}/asset-packages/{package}/downloadGET/mgmt/v1/spaces/{space}/asset-packagesPOST/mgmt/v1/spaces/{space}/asset-packagesGET/mgmt/v1/spaces/{space}/asset-packages/{package}DELETE/mgmt/v1/spaces/{space}/asset-packages/{package}

---

Internal (management UI) download: an un-metered presigned S3 URL —

GET

/mgmt/v1/spaces/{space}/asset-packages/{package}/download

Internal (management UI) download: an un-metered presigned S3 URL —
the metered CloudFront path is reserved for public share downloads.

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

space*

The space identifier

Type

string

Required

Format

"uuid"

package*

The package identifier

Type

string

Required

Format

"uuid"

Responses

Successful response

GET

/mgmt/v1/spaces/{space}/asset-packages/{package}/download

Playground

Authorization

bearerAuth

Variables

Key

Value

space*

package*

Samples

---

List asset packages

GET

/mgmt/v1/spaces/{space}/asset-packages

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

space*

The space identifier

Type

string

Required

Format

"uuid"

Responses

Successful response

Content-Type

application/json

"string"

GET

/mgmt/v1/spaces/{space}/asset-packages

Playground

Authorization

bearerAuth

Variables

Key

Value

space*

Samples

---

Create asset packages

POST

/mgmt/v1/spaces/{space}/asset-packages

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

space*

The space identifier

Type

string

Required

Format

"uuid"

Responses

Successful response

POST

/mgmt/v1/spaces/{space}/asset-packages

Playground

Authorization

bearerAuth

Variables

Key

Value

space*

Samples

---

Get a single asset package

GET

/mgmt/v1/spaces/{space}/asset-packages/{package}

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

space*

The space identifier

Type

string

Required

Format

"uuid"

package*

The package identifier

Type

string

Required

Format

"uuid"

Responses

Successful response

Content-Type

application/json

"string"

GET

/mgmt/v1/spaces/{space}/asset-packages/{package}

Playground

Authorization

bearerAuth

Variables

Key

Value

space*

package*

Samples

---

Delete asset package

DELETE

/mgmt/v1/spaces/{space}/asset-packages/{package}

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

space*

The space identifier

Type

string

Required

Format

"uuid"

package*

The package identifier

Type

string

Required

Format

"uuid"

Responses

Resource deleted successfully

DELETE

/mgmt/v1/spaces/{space}/asset-packages/{package}

Playground

Authorization

bearerAuth

Variables

Key

Value

space*

package*

Samples

---

Asset Shares

Operations

POST/mgmt/v1/spaces/{space}/asset-shares/{share}/revokeGET/mgmt/v1/spaces/{space}/asset-sharesPOST/mgmt/v1/spaces/{space}/asset-sharesGET/mgmt/v1/spaces/{space}/asset-shares/{share}PUT/mgmt/v1/spaces/{space}/asset-shares/{share}DELETE/mgmt/v1/spaces/{space}/asset-shares/{share}

---

Create revoke

POST

/mgmt/v1/spaces/{space}/asset-shares/{share}/revoke

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

space*

The space identifier

Type

string

Required

Format

"uuid"

share*

The share identifier

Type

string

Required

Format

"uuid"

Responses

Successful response

Content-Type

application/json

"string"

POST

/mgmt/v1/spaces/{space}/asset-shares/{share}/revoke

Playground

Authorization

bearerAuth

Variables

Key

Value

space*

share*

Samples

---

List asset shares

GET

/mgmt/v1/spaces/{space}/asset-shares

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

space*

The space identifier

Type

string

Required

Format

"uuid"

Responses

Successful response

Content-Type

application/json

"string"

GET

/mgmt/v1/spaces/{space}/asset-shares

Playground

Authorization

bearerAuth

Variables

Key

Value

space*

Samples

---

Create asset shares

POST

/mgmt/v1/spaces/{space}/asset-shares

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

space*

The space identifier

Type

string

Required

Format

"uuid"

Responses

Successful response

Content-Type

application/json

"string"

POST

/mgmt/v1/spaces/{space}/asset-shares

Playground

Authorization

bearerAuth

Variables

Key

Value

space*

Samples

---

Get a single asset share

GET

/mgmt/v1/spaces/{space}/asset-shares/{share}

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

space*

The space identifier

Type

string

Required

Format

"uuid"

share*

The share identifier

Type

string

Required

Format

"uuid"

Responses

Successful response

Content-Type

application/json

"string"

GET

/mgmt/v1/spaces/{space}/asset-shares/{share}

Playground

Authorization

bearerAuth

Variables

Key

Value

space*

share*

Samples

---

Password semantics: key absent = keep current password, explicit null

PUT

/mgmt/v1/spaces/{space}/asset-shares/{share}

Password semantics: key absent = keep current password, explicit null
(or empty string) = remove the password, non-empty string = re-hash.

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

space*

The space identifier

Type

string

Required

Format

"uuid"

share*

The share identifier

Type

string

Required

Format

"uuid"

Responses

Successful response

Content-Type

application/json

"string"

PUT

/mgmt/v1/spaces/{space}/asset-shares/{share}

Playground

Authorization

bearerAuth

Variables

Key

Value

space*

share*

Samples

---

Delete asset share

DELETE

/mgmt/v1/spaces/{space}/asset-shares/{share}

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

space*

The space identifier

Type

string

Required

Format

"uuid"

share*

The share identifier

Type

string

Required

Format

"uuid"

Responses

Resource deleted successfully

DELETE

/mgmt/v1/spaces/{space}/asset-shares/{share}

Playground

Authorization

bearerAuth

Variables

Key

Value

space*

share*

Samples

---

Icons

Operations

GET/mgmt/v1/spaces/{space}/icons/tagsPOST/mgmt/v1/spaces/{space}/icons/importGET/mgmt/v1/spaces/{space}/iconsPOST/mgmt/v1/spaces/{space}/iconsGET/mgmt/v1/spaces/{space}/icons/{icon}PUT/mgmt/v1/spaces/{space}/icons/{icon}DELETE/mgmt/v1/spaces/{space}/icons/{icon}

---

Return the distinct list of tags used across the space's icons

GET

/mgmt/v1/spaces/{space}/icons/tags

Return the distinct list of tags used across the space's icons.

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

space*

The space identifier

Type

string

Required

Format

"uuid"

Responses

Successful response

GET

/mgmt/v1/spaces/{space}/icons/tags

Playground

Authorization

bearerAuth

Variables

Key

Value

space*

Samples

---

Create import

POST

/mgmt/v1/spaces/{space}/icons/import

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

space*

The space identifier

Type

string

Required

Format

"uuid"

Request Body

application/json

{

  

"file": "",

  

"import_mode": "string"

}

Responses

Successful response

POST

/mgmt/v1/spaces/{space}/icons/import

Playground

Authorization

bearerAuth

Variables

Key

Value

space*

Body

Samples

---

Display a listing of icons

GET

/mgmt/v1/spaces/{space}/icons

Display a listing of icons.

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

space*

The space identifier

Type

string

Required

Format

"uuid"

Responses

Successful response

Content-Type

application/json

"string"

GET

/mgmt/v1/spaces/{space}/icons

Playground

Authorization

bearerAuth

Variables

Key

Value

space*

Samples

---

Store a newly uploaded icon

POST

/mgmt/v1/spaces/{space}/icons

Store a newly uploaded icon.

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

space*

The space identifier

Type

string

Required

Format

"uuid"

Responses

Successful response

Content-Type

application/json

"string"

POST

/mgmt/v1/spaces/{space}/icons

Playground

Authorization

bearerAuth

Variables

Key

Value

space*

Samples

---

Display the specified icon

GET

/mgmt/v1/spaces/{space}/icons/{icon}

Display the specified icon.

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

space*

The space identifier

Type

string

Required

Format

"uuid"

icon*

The icon identifier

Type

string

Required

Format

"uuid"

Responses

Successful response

Content-Type

application/json

"string"

GET

/mgmt/v1/spaces/{space}/icons/{icon}

Playground

Authorization

bearerAuth

Variables

Key

Value

space*

icon*

Samples

---

Update the specified icon (metadata and/or SVG body)

PUT

/mgmt/v1/spaces/{space}/icons/{icon}

Update the specified icon (metadata and/or SVG body).

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

space*

The space identifier

Type

string

Required

Format

"uuid"

icon*

The icon identifier

Type

string

Required

Format

"uuid"

Responses

Successful response

Content-Type

application/json

"string"

PUT

/mgmt/v1/spaces/{space}/icons/{icon}

Playground

Authorization

bearerAuth

Variables

Key

Value

space*

icon*

Samples

---

Remove the specified icon

DELETE

/mgmt/v1/spaces/{space}/icons/{icon}

Remove the specified icon.

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

space*

The space identifier

Type

string

Required

Format

"uuid"

icon*

The icon identifier

Type

string

Required

Format

"uuid"

Responses

Resource deleted successfully

DELETE

/mgmt/v1/spaces/{space}/icons/{icon}

Playground

Authorization

bearerAuth

Variables

Key

Value

space*

icon*

Samples

---

Backups

Operations

GET/mgmt/v1/spaces/{space}/backupsPOST/mgmt/v1/spaces/{space}/backupsGET/mgmt/v1/spaces/{space}/backups/{backup}PUT/mgmt/v1/spaces/{space}/backups/{backup}DELETE/mgmt/v1/spaces/{space}/backups/{backup}

---

List backups

GET

/mgmt/v1/spaces/{space}/backups

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

space*

The space identifier

Type

string

Required

Format

"uuid"

Query Parameters

name

Filter by name (LIKE search)

Type

string

state

Filter by state

Type

string

created_at

Filter by creation date (supports operators and ranges)

Type

string

updated_at

Filter by update date (supports operators and ranges)

Type

string

expires_at

Filter by expires_at with range syntax (value1...value2)

Type

string

sort

Sort by field (prefix with - for descending order)

Type

string

Valid values

"name""-name""state""-state""progress""-progress""created_at""-created_at""updated_at""-updated_at""expires_at""-expires_at"

Responses

Successful response

Content-Type

application/json

"string"

GET

/mgmt/v1/spaces/{space}/backups

Playground

Authorization

bearerAuth

Variables

Key

Value

space*

name

state

created_at

updated_at

expires_at

sort

Samples

---

Create backups

POST

/mgmt/v1/spaces/{space}/backups

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

space*

The space identifier

Type

string

Required

Format

"uuid"

Request Body

application/json

{

  

"name": "string",

  

"description": "string",

  

"to": [

  

  

"string"

  

],

  

"password": "string",

  

"expires_at": "string"

}

Responses

Successful response

Content-Type

application/json

"string"

POST

/mgmt/v1/spaces/{space}/backups

Playground

Authorization

bearerAuth

Variables

Key

Value

space*

Body

Samples

---

Get a single backup

GET

/mgmt/v1/spaces/{space}/backups/{backup}

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

space*

The space identifier

Type

string

Required

Format

"uuid"

backup*

The backup identifier

Type

string

Required

Format

"uuid"

Responses

Successful response

Content-Type

application/json

"string"

GET

/mgmt/v1/spaces/{space}/backups/{backup}

Playground

Authorization

bearerAuth

Variables

Key

Value

space*

backup*

Samples

---

Update backup

PUT

/mgmt/v1/spaces/{space}/backups/{backup}

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

space*

The space identifier

Type

string

Required

Format

"uuid"

backup*

The backup identifier

Type

string

Required

Format

"uuid"

Request Body

application/json

{

  

"name": "string",

  

"description": "string",

  

"expires_at": "string"

}

Responses

Successful response

Content-Type

application/json

"string"

PUT

/mgmt/v1/spaces/{space}/backups/{backup}

Playground

Authorization

bearerAuth

Variables

Key

Value

space*

backup*

Body

Samples

---

Delete backup

DELETE

/mgmt/v1/spaces/{space}/backups/{backup}

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

space*

The space identifier

Type

string

Required

Format

"uuid"

backup*

The backup identifier

Type

string

Required

Format

"uuid"

Responses

Resource deleted successfully

DELETE

/mgmt/v1/spaces/{space}/backups/{backup}

Playground

Authorization

bearerAuth

Variables

Key

Value

space*

backup*

Samples

---

Migrations

Operations

GET/mgmt/v1/spaces/{space}/migrationsPOST/mgmt/v1/spaces/{space}/migrationsGET/mgmt/v1/spaces/{space}/migrations/{migration}DELETE/mgmt/v1/spaces/{space}/migrations/{migration}

---

List migrations

GET

/mgmt/v1/spaces/{space}/migrations

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

space*

The space identifier

Type

string

Required

Format

"uuid"

Responses

Successful response

Content-Type

application/json

"string"

GET

/mgmt/v1/spaces/{space}/migrations

Playground

Authorization

bearerAuth

Variables

Key

Value

space*

Samples

---

Create migrations

POST

/mgmt/v1/spaces/{space}/migrations

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

space*

The space identifier

Type

string

Required

Format

"uuid"

Responses

Successful response

Content-Type

application/json

"string"

POST

/mgmt/v1/spaces/{space}/migrations

Playground

Authorization

bearerAuth

Variables

Key

Value

space*

Samples

---

Get a single migration

GET

/mgmt/v1/spaces/{space}/migrations/{migration}

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

space*

The space identifier

Type

string

Required

Format

"uuid"

migration*

The migration identifier

Type

string

Required

Format

"uuid"

Responses

Successful response

Content-Type

application/json

"string"

GET

/mgmt/v1/spaces/{space}/migrations/{migration}

Playground

Authorization

bearerAuth

Variables

Key

Value

space*

migration*

Samples

---

Delete migration

DELETE

/mgmt/v1/spaces/{space}/migrations/{migration}

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

space*

The space identifier

Type

string

Required

Format

"uuid"

migration*

The migration identifier

Type

string

Required

Format

"uuid"

Responses

Resource deleted successfully

DELETE

/mgmt/v1/spaces/{space}/migrations/{migration}

Playground

Authorization

bearerAuth

Variables

Key

Value

space*

migration*

Samples

---

Subscriptions

Operations

GET/mgmt/v1/spaces/{space}/subscriptionsGET/mgmt/v1/spaces/{space}/subscriptions/currentPOST/mgmt/v1/spaces/{space}/subscriptions/checkoutPOST/mgmt/v1/spaces/{space}/subscriptions/reinitPOST/mgmt/v1/spaces/{space}/subscriptions/cancel

---

List all subscriptions for a space

GET

/mgmt/v1/spaces/{space}/subscriptions

List all subscriptions for a space.

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

space*

The space identifier

Type

string

Required

Format

"uuid"

Responses

Successful response

Content-Type

application/json

"string"

GET

/mgmt/v1/spaces/{space}/subscriptions

Playground

Authorization

bearerAuth

Variables

Key

Value

space*

Samples

---

Get the current active subscription (with plan and quotas)

GET

/mgmt/v1/spaces/{space}/subscriptions/current

Get the current active subscription (with plan and quotas).

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

space*

The space identifier

Type

string

Required

Format

"uuid"

Responses

Successful response

GET

/mgmt/v1/spaces/{space}/subscriptions/current

Playground

Authorization

bearerAuth

Variables

Key

Value

space*

Samples

---

Initiate a checkout for a plan

POST

/mgmt/v1/spaces/{space}/subscriptions/checkout

Initiate a checkout for a plan. Returns a checkout URL for paid plans.

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

space*

The space identifier

Type

string

Required

Format

"uuid"

Responses

Successful response

POST

/mgmt/v1/spaces/{space}/subscriptions/checkout

Playground

Authorization

bearerAuth

Variables

Key

Value

space*

Samples

---

Re-initiate the checkout flow for a pending subscription

POST

/mgmt/v1/spaces/{space}/subscriptions/reinit

Re-initiate the checkout flow for a pending subscription.
No body required — the pending subscription and its plan are resolved automatically.

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

space*

The space identifier

Type

string

Required

Format

"uuid"

Responses

Successful response

POST

/mgmt/v1/spaces/{space}/subscriptions/reinit

Playground

Authorization

bearerAuth

Variables

Key

Value

space*

Samples

---

Cancel the active subscription at period end

POST

/mgmt/v1/spaces/{space}/subscriptions/cancel

Cancel the active subscription at period end.

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

space*

The space identifier

Type

string

Required

Format

"uuid"

Responses

Successful response

POST

/mgmt/v1/spaces/{space}/subscriptions/cancel

Playground

Authorization

bearerAuth

Variables

Key

Value

space*

Samples

---

Invoices

Operations

GET/mgmt/v1/spaces/{space}/invoices

---

List the space's LemonSqueezy invoices (newest first)

GET

/mgmt/v1/spaces/{space}/invoices

List the space's LemonSqueezy invoices (newest first). Returns an empty
collection for free spaces or when LemonSqueezy is unreachable — the
billing portal remains the source of truth.

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

space*

The space identifier

Type

string

Required

Format

"uuid"

Responses

Successful response

Content-Type

application/json

"string"

GET

/mgmt/v1/spaces/{space}/invoices

Playground

Authorization

bearerAuth

Variables

Key

Value

space*

Samples

---

Data Sources

Operations

GET/mgmt/v1/spaces/{space}/data-sourcesPOST/mgmt/v1/spaces/{space}/data-sourcesGET/mgmt/v1/spaces/{space}/data-sources/{data_source}PUT/mgmt/v1/spaces/{space}/data-sources/{data_source}DELETE/mgmt/v1/spaces/{space}/data-sources/{data_source}POST/mgmt/v1/spaces/{space}/data-sources/{data_source}/entries/exportPOST/mgmt/v1/spaces/{space}/data-sources/{data_source}/entries/importPOST/mgmt/v1/spaces/{space}/data-sources/{data_source}/entries/translate-missing-dimensions/streamGET/mgmt/v1/spaces/{space}/data-sources/{data_source}/entriesPOST/mgmt/v1/spaces/{space}/data-sources/{data_source}/entriesGET/mgmt/v1/spaces/{space}/data-sources/{data_source}/entries/{entry}PUT/mgmt/v1/spaces/{space}/data-sources/{data_source}/entries/{entry}DELETE/mgmt/v1/spaces/{space}/data-sources/{data_source}/entries/{entry}

---

Display a listing of the data sources

GET

/mgmt/v1/spaces/{space}/data-sources

Display a listing of the data sources.

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

space*

The space identifier

Type

string

Required

Format

"uuid"

Responses

Successful response

Content-Type

application/json

"string"

GET

/mgmt/v1/spaces/{space}/data-sources

Playground

Authorization

bearerAuth

Variables

Key

Value

space*

Samples

---

Store a newly created data source

POST

/mgmt/v1/spaces/{space}/data-sources

Store a newly created data source.

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

space*

The space identifier

Type

string

Required

Format

"uuid"

Responses

Successful response

Content-Type

application/json

"string"

POST

/mgmt/v1/spaces/{space}/data-sources

Playground

Authorization

bearerAuth

Variables

Key

Value

space*

Samples

---

Display the specified data source

GET

/mgmt/v1/spaces/{space}/data-sources/{data_source}

Display the specified data source.

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

space*

The space identifier

Type

string

Required

Format

"uuid"

Responses

Successful response

Content-Type

application/json

"string"

GET

/mgmt/v1/spaces/{space}/data-sources/{data_source}

Playground

Authorization

bearerAuth

Variables

Key

Value

space*

Samples

---

Update the specified data source

PUT

/mgmt/v1/spaces/{space}/data-sources/{data_source}

Update the specified data source.

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

space*

The space identifier

Type

string

Required

Format

"uuid"

Responses

Successful response

Content-Type

application/json

"string"

PUT

/mgmt/v1/spaces/{space}/data-sources/{data_source}

Playground

Authorization

bearerAuth

Variables

Key

Value

space*

Samples

---

Remove the specified data source

DELETE

/mgmt/v1/spaces/{space}/data-sources/{data_source}

Remove the specified data source.

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

space*

The space identifier

Type

string

Required

Format

"uuid"

Responses

Resource deleted successfully

DELETE

/mgmt/v1/spaces/{space}/data-sources/{data_source}

Playground

Authorization

bearerAuth

Variables

Key

Value

space*

Samples

---

Create export

POST

/mgmt/v1/spaces/{space}/data-sources/{data_source}/entries/export

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

space*

The space identifier

Type

string

Required

Format

"uuid"

Request Body

application/json

{

  

"as": "string"

}

Responses

Successful response

POST

/mgmt/v1/spaces/{space}/data-sources/{data_source}/entries/export

Playground

Authorization

bearerAuth

Variables

Key

Value

space*

Body

Samples

---

Create import

POST

/mgmt/v1/spaces/{space}/data-sources/{data_source}/entries/import

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

space*

The space identifier

Type

string

Required

Format

"uuid"

Request Body

application/json

{

  

"file": "",

  

"import_mode": "string"

}

Responses

Successful response

POST

/mgmt/v1/spaces/{space}/data-sources/{data_source}/entries/import

Playground

Authorization

bearerAuth

Variables

Key

Value

space*

Body

Samples

---

Create stream

POST

/mgmt/v1/spaces/{space}/data-sources/{data_source}/entries/translate-missing-dimensions/stream

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

space*

The space identifier

Type

string

Required

Format

"uuid"

Responses

Successful response

POST

/mgmt/v1/spaces/{space}/data-sources/{data_source}/entries/translate-missing-dimensions/stream

Playground

Authorization

bearerAuth

Variables

Key

Value

space*

Samples

---

Display a listing of data entries for a data source

GET

/mgmt/v1/spaces/{space}/data-sources/{data_source}/entries

Display a listing of data entries for a data source.

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

space*

The space identifier

Type

string

Required

Format

"uuid"

Responses

Successful response

Content-Type

application/json

"string"

GET

/mgmt/v1/spaces/{space}/data-sources/{data_source}/entries

Playground

Authorization

bearerAuth

Variables

Key

Value

space*

Samples

---

Store a newly created data entry

POST

/mgmt/v1/spaces/{space}/data-sources/{data_source}/entries

Store a newly created data entry.

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

space*

The space identifier

Type

string

Required

Format

"uuid"

Responses

Successful response

Content-Type

application/json

"string"

POST

/mgmt/v1/spaces/{space}/data-sources/{data_source}/entries

Playground

Authorization

bearerAuth

Variables

Key

Value

space*

Samples

---

Display the specified data entry

GET

/mgmt/v1/spaces/{space}/data-sources/{data_source}/entries/{entry}

Display the specified data entry.

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

space*

The space identifier

Type

string

Required

Format

"uuid"

entry*

The entry identifier

Type

string

Required

Format

"uuid"

Responses

Successful response

Content-Type

application/json

"string"

GET

/mgmt/v1/spaces/{space}/data-sources/{data_source}/entries/{entry}

Playground

Authorization

bearerAuth

Variables

Key

Value

space*

entry*

Samples

---

Update the specified data entry

PUT

/mgmt/v1/spaces/{space}/data-sources/{data_source}/entries/{entry}

Update the specified data entry.

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

space*

The space identifier

Type

string

Required

Format

"uuid"

entry*

The entry identifier

Type

string

Required

Format

"uuid"

Responses

Successful response

Content-Type

application/json

"string"

PUT

/mgmt/v1/spaces/{space}/data-sources/{data_source}/entries/{entry}

Playground

Authorization

bearerAuth

Variables

Key

Value

space*

entry*

Samples

---

Remove the specified data entry

DELETE

/mgmt/v1/spaces/{space}/data-sources/{data_source}/entries/{entry}

Remove the specified data entry.

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

space*

The space identifier

Type

string

Required

Format

"uuid"

entry*

The entry identifier

Type

string

Required

Format

"uuid"

Responses

Resource deleted successfully

DELETE

/mgmt/v1/spaces/{space}/data-sources/{data_source}/entries/{entry}

Playground

Authorization

bearerAuth

Variables

Key

Value

space*

entry*

Samples

---

Releases

Operations

GET/mgmt/v1/spaces/{space}/releasesPOST/mgmt/v1/spaces/{space}/releasesGET/mgmt/v1/spaces/{space}/releases/{release}PUT/mgmt/v1/spaces/{space}/releases/{release}DELETE/mgmt/v1/spaces/{space}/releases/{release}POST/mgmt/v1/spaces/{space}/releases/{release}/commitPOST/mgmt/v1/spaces/{space}/releases/{release}/cancelPOST/mgmt/v1/spaces/{space}/releases/{release}/publishPOST/mgmt/v1/spaces/{space}/releases/{release}/versions/assignDELETE/mgmt/v1/spaces/{space}/releases/{release}/versions/remove

---

Display a listing of releases

GET

/mgmt/v1/spaces/{space}/releases

Display a listing of releases.

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

space*

The space identifier

Type

string

Required

Format

"uuid"

Query Parameters

name

Filter by name (LIKE search)

Type

string

external_id

Filter by external_id

Type

string

scheduled

Filter by scheduled (check if null)

publish_at

Filter by publish_at with range syntax (value1...value2)

Type

string

committed_at

Filter by committed_at with range syntax (value1...value2)

Type

string

published_at

Filter by publication date (supports operators and ranges)

Type

string

created_at

Filter by creation date (supports operators and ranges)

Type

string

updated_at

Filter by update date (supports operators and ranges)

Type

string

isPublished

Filter by isPublished (check if null)

isCommitted

Filter by isCommitted (check if null)

sort

Sort by field (prefix with - for descending order)

Type

string

Valid values

"name""-name""publish_at""-publish_at""committed_at""-committed_at""published_at""-published_at""created_at""-created_at""updated_at""-updated_at"

Responses

Successful response

Content-Type

application/json

"string"

GET

/mgmt/v1/spaces/{space}/releases

Playground

Authorization

bearerAuth

Variables

Key

Value

space*

name

external_id

scheduled

publish_at

committed_at

published_at

created_at

updated_at

isPublished

isCommitted

sort

Samples

---

Store a newly created release in storage

POST

/mgmt/v1/spaces/{space}/releases

Store a newly created release in storage.

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

space*

The space identifier

Type

string

Required

Format

"uuid"

Request Body

application/json

{

  

"external_id": "string",

  

"name": "string",

  

"description": "string",

  

"settings": [

  

],

  

"publish_at": "string"

}

Responses

Successful response

Content-Type

application/json

"string"

POST

/mgmt/v1/spaces/{space}/releases

Playground

Authorization

bearerAuth

Variables

Key

Value

space*

Body

Samples

---

Display the specified release

GET

/mgmt/v1/spaces/{space}/releases/{release}

Display the specified release.

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

space*

The space identifier

Type

string

Required

Format

"uuid"

release*

The release identifier

Type

string

Required

Format

"uuid"

Responses

Successful response

Content-Type

application/json

"string"

GET

/mgmt/v1/spaces/{space}/releases/{release}

Playground

Authorization

bearerAuth

Variables

Key

Value

space*

release*

Samples

---

Update the specified release in storage

PUT

/mgmt/v1/spaces/{space}/releases/{release}

Update the specified release in storage.

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

space*

The space identifier

Type

string

Required

Format

"uuid"

release*

The release identifier

Type

string

Required

Format

"uuid"

Request Body

application/json

{

  

"name": "string",

  

"description": "string",

  

"settings": [

  

],

  

"publish_at": "string"

}

Responses

Successful response

Content-Type

application/json

"string"

PUT

/mgmt/v1/spaces/{space}/releases/{release}

Playground

Authorization

bearerAuth

Variables

Key

Value

space*

release*

Body

Samples

---

Remove the specified release from storage

DELETE

/mgmt/v1/spaces/{space}/releases/{release}

Remove the specified release from storage.

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

space*

The space identifier

Type

string

Required

Format

"uuid"

release*

The release identifier

Type

string

Required

Format

"uuid"

Responses

Resource deleted successfully

DELETE

/mgmt/v1/spaces/{space}/releases/{release}

Playground

Authorization

bearerAuth

Variables

Key

Value

space*

release*

Samples

---

Create commit

POST

/mgmt/v1/spaces/{space}/releases/{release}/commit

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

space*

The space identifier

Type

string

Required

Format

"uuid"

release*

The release identifier

Type

string

Required

Format

"uuid"

Responses

Successful response

Content-Type

application/json

"string"

POST

/mgmt/v1/spaces/{space}/releases/{release}/commit

Playground

Authorization

bearerAuth

Variables

Key

Value

space*

release*

Samples

---

Create cancel

POST

/mgmt/v1/spaces/{space}/releases/{release}/cancel

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

space*

The space identifier

Type

string

Required

Format

"uuid"

release*

The release identifier

Type

string

Required

Format

"uuid"

Responses

Successful response

Content-Type

application/json

"string"

POST

/mgmt/v1/spaces/{space}/releases/{release}/cancel

Playground

Authorization

bearerAuth

Variables

Key

Value

space*

release*

Samples

---

Create publish

POST

/mgmt/v1/spaces/{space}/releases/{release}/publish

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

space*

The space identifier

Type

string

Required

Format

"uuid"

release*

The release identifier

Type

string

Required

Format

"uuid"

Responses

Successful response

Content-Type

application/json

"string"

POST

/mgmt/v1/spaces/{space}/releases/{release}/publish

Playground

Authorization

bearerAuth

Variables

Key

Value

space*

release*

Samples

---

Create assign

POST

/mgmt/v1/spaces/{space}/releases/{release}/versions/assign

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

space*

The space identifier

Type

string

Required

Format

"uuid"

release*

The release identifier

Type

string

Required

Format

"uuid"

Request Body

application/json

{

  

"version_ids": [

  

  

"string"

  

]

}

Responses

Successful response

Content-Type

application/json

"string"

POST

/mgmt/v1/spaces/{space}/releases/{release}/versions/assign

Playground

Authorization

bearerAuth

Variables

Key

Value

space*

release*

Body

Samples

---

Delete remove

DELETE

/mgmt/v1/spaces/{space}/releases/{release}/versions/remove

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

space*

The space identifier

Type

string

Required

Format

"uuid"

release*

The release identifier

Type

string

Required

Format

"uuid"

Request Body

application/json

{

  

"version_ids": [

  

  

"string"

  

]

}

Responses

Successful response

Content-Type

application/json

"string"

DELETE

/mgmt/v1/spaces/{space}/releases/{release}/versions/remove

Playground

Authorization

bearerAuth

Variables

Key

Value

space*

release*

Body

Samples

---

Automation Actions

Operations

GET/mgmt/v1/spaces/{space}/automation-actionsPOST/mgmt/v1/spaces/{space}/automation-actionsGET/mgmt/v1/spaces/{space}/automation-actions/{automation_action}PUT/mgmt/v1/spaces/{space}/automation-actions/{automation_action}DELETE/mgmt/v1/spaces/{space}/automation-actions/{automation_action}

---

List automation actions

GET

/mgmt/v1/spaces/{space}/automation-actions

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

space*

The space identifier

Type

string

Required

Format

"uuid"

Query Parameters

q

Free-text search filter.

Type

string

name

Filter by name (LIKE search)

Type

string

type

Filter by type

Type

string

is_active

Filter by is_active

Type

string

sort

Sort by field (prefix with - for descending order)

Type

string

Valid values

"name""-name""type""-type""is_active""-is_active""last_executed_at""-last_executed_at""created_at""-created_at""updated_at""-updated_at"

Responses

Successful response

Content-Type

application/json

{

  

"data": [

  

  

{

  

  

}

  

],

  

"links": {

  

  

"first": "string",

  

  

"last": "string",

  

  

"prev": "string",

  

  

"next": "string"

  

},

  

"meta": {

  

  

"current_page": 0,

  

  

"from": 0,

  

  

"last_page": 0,

  

  

"per_page": 0,

  

  

"to": 0,

  

  

"total": 0

  

}

}

GET

/mgmt/v1/spaces/{space}/automation-actions

Playground

Authorization

bearerAuth

Variables

Key

Value

space*

q

name

type

is_active

sort

Samples

---

Create automation actions

POST

/mgmt/v1/spaces/{space}/automation-actions

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

space*

The space identifier

Type

string

Required

Format

"uuid"

Request Body

application/json

{

  

"name": "string",

  

"description": "string",

  

"type": "string",

  

"config": [

  

],

  

"secrets": [

  

],

  

"is_active": true

}

Responses

Successful response

POST

/mgmt/v1/spaces/{space}/automation-actions

Playground

Authorization

bearerAuth

Variables

Key

Value

space*

Body

Samples

---

Get a single automation action

GET

/mgmt/v1/spaces/{space}/automation-actions/{automation_action}

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

space*

The space identifier

Type

string

Required

Format

"uuid"

Responses

Successful response

Content-Type

application/json

"string"

GET

/mgmt/v1/spaces/{space}/automation-actions/{automation_action}

Playground

Authorization

bearerAuth

Variables

Key

Value

space*

Samples

---

Update automation action

PUT

/mgmt/v1/spaces/{space}/automation-actions/{automation_action}

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

space*

The space identifier

Type

string

Required

Format

"uuid"

Request Body

application/json

{

  

"name": "string",

  

"description": "string",

  

"type": "string",

  

"config": [

  

],

  

"secrets": [

  

],

  

"clear_secret_keys": [

  

  

"string"

  

],

  

"is_active": true

}

Responses

Successful response

Content-Type

application/json

"string"

PUT

/mgmt/v1/spaces/{space}/automation-actions/{automation_action}

Playground

Authorization

bearerAuth

Variables

Key

Value

space*

Body

Samples

---

Delete automation action

DELETE

/mgmt/v1/spaces/{space}/automation-actions/{automation_action}

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

space*

The space identifier

Type

string

Required

Format

"uuid"

Responses

Resource deleted successfully

DELETE

/mgmt/v1/spaces/{space}/automation-actions/{automation_action}

Playground

Authorization

bearerAuth

Variables

Key

Value

space*

Samples

---

Automations

Operations

GET/mgmt/v1/spaces/{space}/automations/trigger-catalogGET/mgmt/v1/spaces/{space}/automationsPOST/mgmt/v1/spaces/{space}/automationsGET/mgmt/v1/spaces/{space}/automations/{automation}PUT/mgmt/v1/spaces/{space}/automations/{automation}DELETE/mgmt/v1/spaces/{space}/automations/{automation}POST/mgmt/v1/spaces/{space}/automations/{automation}/triggerGET/mgmt/v1/spaces/{space}/automations/{automation}/stats/executionsGET/mgmt/v1/spaces/{space}/automations/{automation}/stats/trendsGET/mgmt/v1/spaces/{space}/automations/{automation}/stats/statisticsGET/mgmt/v1/spaces/{space}/automations/{automation}/stats/summary

---

List trigger catalog

GET

/mgmt/v1/spaces/{space}/automations/trigger-catalog

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

space*

The space identifier

Type

string

Required

Format

"uuid"

Responses

Successful response

GET

/mgmt/v1/spaces/{space}/automations/trigger-catalog

Playground

Authorization

bearerAuth

Variables

Key

Value

space*

Samples

---

List automations

GET

/mgmt/v1/spaces/{space}/automations

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

space*

The space identifier

Type

string

Required

Format

"uuid"

Query Parameters

q

Free-text search filter.

Type

string

name

Filter by name (LIKE search)

Type

string

is_active

Filter by is_active

Type

string

trigger_type

Filter by trigger_type

Type

string

action_id

Filter by action_id

Type

string

action_type

Filter by action_type

Type

string

table

Filter by table

Type

string

execution_limit

Filter by execution_limit (check if null)

Type

string

execution_count

Filter by execution_count with range syntax (value1...value2)

Type

string

sort

Sort by field (prefix with - for descending order)

Type

string

Valid values

"name""-name""trigger_type""-trigger_type""is_active""-is_active""execution_limit""-execution_limit""execution_count""-execution_count""last_triggered_at""-last_triggered_at""created_at""-created_at""updated_at""-updated_at"

Responses

Successful response

Content-Type

application/json

{

  

"data": [

  

  

{

  

  

}

  

],

  

"links": {

  

  

"first": "string",

  

  

"last": "string",

  

  

"prev": "string",

  

  

"next": "string"

  

},

  

"meta": {

  

  

"current_page": 0,

  

  

"from": 0,

  

  

"last_page": 0,

  

  

"per_page": 0,

  

  

"to": 0,

  

  

"total": 0

  

}

}

GET

/mgmt/v1/spaces/{space}/automations

Playground

Authorization

bearerAuth

Variables

Key

Value

space*

q

name

is_active

trigger_type

action_id

action_type

table

execution_limit

execution_count

sort

Samples

---

Create automations

POST

/mgmt/v1/spaces/{space}/automations

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

space*

The space identifier

Type

string

Required

Format

"uuid"

Request Body

application/json

{

  

"name": "string",

  

"description": "string",

  

"action_id": "string",

  

"trigger": {

  

  

"type": "string",

  

  

"config": [

  

  

]

  

},

  

"is_active": true,

  

"execution_limit": 0

}

Responses

Successful response

POST

/mgmt/v1/spaces/{space}/automations

Playground

Authorization

bearerAuth

Variables

Key

Value

space*

Body

Samples

---

Get a single automation

GET

/mgmt/v1/spaces/{space}/automations/{automation}

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

space*

The space identifier

Type

string

Required

Format

"uuid"

automation*

The automation identifier

Type

string

Required

Format

"uuid"

Responses

Successful response

Content-Type

application/json

"string"

GET

/mgmt/v1/spaces/{space}/automations/{automation}

Playground

Authorization

bearerAuth

Variables

Key

Value

space*

automation*

Samples

---

Update automation

PUT

/mgmt/v1/spaces/{space}/automations/{automation}

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

space*

The space identifier

Type

string

Required

Format

"uuid"

automation*

The automation identifier

Type

string

Required

Format

"uuid"

Request Body

application/json

{

  

"name": "string",

  

"description": "string",

  

"action_id": "string",

  

"trigger": {

  

  

"type": "string",

  

  

"config": [

  

  

]

  

},

  

"is_active": true,

  

"execution_limit": 0

}

Responses

Successful response

Content-Type

application/json

"string"

PUT

/mgmt/v1/spaces/{space}/automations/{automation}

Playground

Authorization

bearerAuth

Variables

Key

Value

space*

automation*

Body

Samples

---

Delete automation

DELETE

/mgmt/v1/spaces/{space}/automations/{automation}

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

space*

The space identifier

Type

string

Required

Format

"uuid"

automation*

The automation identifier

Type

string

Required

Format

"uuid"

Responses

Resource deleted successfully

DELETE

/mgmt/v1/spaces/{space}/automations/{automation}

Playground

Authorization

bearerAuth

Variables

Key

Value

space*

automation*

Samples

---

Create trigger

POST

/mgmt/v1/spaces/{space}/automations/{automation}/trigger

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

space*

The space identifier

Type

string

Required

Format

"uuid"

automation*

The automation identifier

Type

string

Required

Format

"uuid"

Responses

Successful response

Content-Type

application/json

"string"

POST

/mgmt/v1/spaces/{space}/automations/{automation}/trigger

Playground

Authorization

bearerAuth

Variables

Key

Value

space*

automation*

Samples

---

List executions

GET

/mgmt/v1/spaces/{space}/automations/{automation}/stats/executions

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

space*

The space identifier

Type

string

Required

Format

"uuid"

automation*

The automation identifier

Type

string

Required

Format

"uuid"

Responses

Successful response

Content-Type

application/json

{

  

"data": [

  

  

{

  

  

}

  

],

  

"links": {

  

  

"first": "string",

  

  

"last": "string",

  

  

"prev": "string",

  

  

"next": "string"

  

},

  

"meta": {

  

  

"current_page": 0,

  

  

"from": 0,

  

  

"last_page": 0,

  

  

"per_page": 0,

  

  

"to": 0,

  

  

"total": 0

  

}

}

GET

/mgmt/v1/spaces/{space}/automations/{automation}/stats/executions

Playground

Authorization

bearerAuth

Variables

Key

Value

space*

automation*

Samples

---

List trends

GET

/mgmt/v1/spaces/{space}/automations/{automation}/stats/trends

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

space*

The space identifier

Type

string

Required

Format

"uuid"

automation*

The automation identifier

Type

string

Required

Format

"uuid"

Responses

Successful response

Content-Type

application/json

{

  

"data": [

  

  

{

  

  

}

  

],

  

"links": {

  

  

"first": "string",

  

  

"last": "string",

  

  

"prev": "string",

  

  

"next": "string"

  

},

  

"meta": {

  

  

"current_page": 0,

  

  

"from": 0,

  

  

"last_page": 0,

  

  

"per_page": 0,

  

  

"to": 0,

  

  

"total": 0

  

}

}

GET

/mgmt/v1/spaces/{space}/automations/{automation}/stats/trends

Playground

Authorization

bearerAuth

Variables

Key

Value

space*

automation*

Samples

---

List statistics

GET

/mgmt/v1/spaces/{space}/automations/{automation}/stats/statistics

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

space*

The space identifier

Type

string

Required

Format

"uuid"

automation*

The automation identifier

Type

string

Required

Format

"uuid"

Responses

Successful response

GET

/mgmt/v1/spaces/{space}/automations/{automation}/stats/statistics

Playground

Authorization

bearerAuth

Variables

Key

Value

space*

automation*

Samples

---

List summary

GET

/mgmt/v1/spaces/{space}/automations/{automation}/stats/summary

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

space*

The space identifier

Type

string

Required

Format

"uuid"

automation*

The automation identifier

Type

string

Required

Format

"uuid"

Responses

Successful response

GET

/mgmt/v1/spaces/{space}/automations/{automation}/stats/summary

Playground

Authorization

bearerAuth

Variables

Key

Value

space*

automation*

Samples

---

Automation Executions

Operations

GET/mgmt/v1/spaces/{space}/automation-executionsPOST/mgmt/v1/spaces/{space}/automation-executions/{automationExecution}/replay

---

List automation executions

GET

/mgmt/v1/spaces/{space}/automation-executions

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

space*

The space identifier

Type

string

Required

Format

"uuid"

Query Parameters

q

Free-text search filter.

Type

string

automation_id

Filter by automation_id

Type

string

status

Filter by status

Type

string

sort

Sort by field (prefix with - for descending order)

Type

string

Valid values

"status""-status""duration""-duration""started_at""-started_at""completed_at""-completed_at""created_at""-created_at"

Responses

Successful response

Content-Type

application/json

{

  

"data": [

  

  

{

  

  

}

  

],

  

"links": {

  

  

"first": "string",

  

  

"last": "string",

  

  

"prev": "string",

  

  

"next": "string"

  

},

  

"meta": {

  

  

"current_page": 0,

  

  

"from": 0,

  

  

"last_page": 0,

  

  

"per_page": 0,

  

  

"to": 0,

  

  

"total": 0

  

}

}

GET

/mgmt/v1/spaces/{space}/automation-executions

Playground

Authorization

bearerAuth

Variables

Key

Value

space*

q

automation_id

status

sort

Samples

---

Create replay

POST

/mgmt/v1/spaces/{space}/automation-executions/{automationExecution}/replay

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

space*

The space identifier

Type

string

Required

Format

"uuid"

automationExecution*

The automationExecution identifier

Type

string

Required

Format

"uuid"

Responses

Successful response

POST

/mgmt/v1/spaces/{space}/automation-executions/{automationExecution}/replay

Playground

Authorization

bearerAuth

Variables

Key

Value

space*

automationExecution*

Samples

---

Health

Operations

GET/mgmt/v1/health

---

List health

GET

/mgmt/v1/health

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Responses

Successful response

GET

/mgmt/v1/health

Playground

Authorization

bearerAuth

Samples

---

Config

Operations

GET/mgmt/v1/config

---

List config

GET

/mgmt/v1/config

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Responses

Successful response

GET

/mgmt/v1/config

Playground

Authorization

bearerAuth

Samples

---

Plans

Operations

GET/mgmt/v1/plans

---

List all active plans

GET

/mgmt/v1/plans

List all active plans.
Public endpoint, cached for 1 hour.

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Responses

Successful response

Content-Type

application/json

"string"

GET

/mgmt/v1/plans

Playground

Authorization

bearerAuth

Samples

---

Shares

Operations

GET/mgmt/v1/shares/{space}/{token}GET/mgmt/v1/shares/{space}/{token}/assetsPOST/mgmt/v1/shares/{space}/{token}/unlockGET/mgmt/v1/shares/{space}/{token}/downloadGET/mgmt/v1/shares/{space}/{token}/assets/{asset}/downloadGET/mgmt/v1/shares/{space}/{token}/assets/{asset}/preview

---

Get a single share

GET

/mgmt/v1/shares/{space}/{token}

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

space*

The space identifier

Type

string

Required

Format

"uuid"

token*

The token identifier

Type

string

Required

Responses

Successful response

GET

/mgmt/v1/shares/{space}/{token}

Playground

Authorization

bearerAuth

Variables

Key

Value

space*

token*

Samples

---

List assets

GET

/mgmt/v1/shares/{space}/{token}/assets

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

space*

The space identifier

Type

string

Required

Format

"uuid"

token*

The token identifier

Type

string

Required

Responses

Successful response

GET

/mgmt/v1/shares/{space}/{token}/assets

Playground

Authorization

bearerAuth

Variables

Key

Value

space*

token*

Samples

---

Create unlock

POST

/mgmt/v1/shares/{space}/{token}/unlock

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

space*

The space identifier

Type

string

Required

Format

"uuid"

token*

The token identifier

Type

string

Required

Responses

Successful response

POST

/mgmt/v1/shares/{space}/{token}/unlock

Playground

Authorization

bearerAuth

Variables

Key

Value

space*

token*

Samples

---

List download

GET

/mgmt/v1/shares/{space}/{token}/download

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

space*

The space identifier

Type

string

Required

Format

"uuid"

token*

The token identifier

Type

string

Required

Responses

Successful response

GET

/mgmt/v1/shares/{space}/{token}/download

Playground

Authorization

bearerAuth

Variables

Key

Value

space*

token*

Samples

---

List download

GET

/mgmt/v1/shares/{space}/{token}/assets/{asset}/download

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

space*

The space identifier

Type

string

Required

Format

"uuid"

token*

The token identifier

Type

string

Required

asset*

The asset identifier

Type

string

Required

Responses

Successful response

GET

/mgmt/v1/shares/{space}/{token}/assets/{asset}/download

Playground

Authorization

bearerAuth

Variables

Key

Value

space*

token*

asset*

Samples

---

Share-scoped image preview: a bounded-size derivative served only while

GET

/mgmt/v1/shares/{space}/{token}/assets/{asset}/preview

Share-scoped image preview: a bounded-size derivative served only while
the share is accessible and unlocked. Never hands out a permanent asset
URL — those would outlive revocation, expiry and download limits.

Authorizations

bearerAuth

Sanctum personal access token passed in Authorization header

Type

HTTP (bearer)

Parameters

Path Parameters

space*

The space identifier

Type

string

Required

Format

"uuid"

token*

The token identifier

Type

string

Required

asset*

The asset identifier

Type

string

Required

Responses

Successful response

GET

/mgmt/v1/shares/{space}/{token}/assets/{asset}/preview

Playground

Authorization

bearerAuth

Variables

Key

Value

space*

token*

asset*

Samples

---

Powered by VitePress OpenAPI