Get Workspace Config

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

workspaceId

string

required

Workspace id

Query Parameters

version

string

Optional version

Response

Success Response

schema

object

Hide child attributes

schema.{key}

object

Hide child attributes

schema.{key}.type

enum<string>

Available options:

string,

number,

object,

array,

boolean,

localized:string,

localized:number,

localized:boolean

schema.{key}.format

string

schema.{key}.properties

object

Hide child attributes

schema.{key}.properties.{key}

object

Recursive reference to TypedArgument — nesting is truncated here to avoid the infinite expansion that crashes the API reference renderer.

schema.{key}.title

Hide child attributes

schema.{key}.title.{key}

string

Example:

{ "fr": "Bonjour", "en": "Hello" }

schema.{key}.description

Hide child attributes

schema.{key}.description.{key}

string

Example:

{ "fr": "Bonjour", "en": "Hello" }

schema.{key}.items

object

Recursive reference to TypedArgument — nesting is truncated here to avoid the infinite expansion that crashes the API reference renderer.

schema.{key}.ui:widget

string

schema.{key}.ui:options

object

Example:

{
  "type": "string",
  "title": { "en": "User ID" },
  "description": { "en": "The unique identifier of the user" },
  "secret": { "type": "boolean" },
  "event": { "type": "boolean" }
}

block

string

value

any