Get v2workspaces

Fetch a workspace

GET /v2/workspaces/{workspaceId}

cURL

cURL

curl --request GET \
  --url https://api.eda.prisme.ai/v2/workspaces/{workspaceId} \
  --header 'Authorization: Bearer <token>'

200

{
  "name": "<string>",
  "description": {
    "fr": "Bonjour",
    "en": "Hello"
  },
  "photo": "<string>",
  "config": {
    "schema": {},
    "block": "<string>",
    "value": "<unknown>"
  },
  "blocks": {},
  "slug": "<string>",
  "id": "<string>",
  "labels": [
    "<string>"
  ],
  "customDomains": [
    "<string>"
  ],
  "registerWorkspace": true,
  "repositories": {},
  "secrets": {
    "schema": {}
  },
  "events": {
    "mapping": {},
    "types": {}
  },
  "automations": {},
  "pages": {},
  "imports": {},
  "createdAt": "<string>",
  "updatedAt": "<string>",
  "createdBy": "<string>"
}

Authorizations

BearerAuthWorkspaceApiKeyAuthBearerAuth & WorkspaceApiKeyAuth

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

200

application/json

Success Response

name · string · required

Pattern: ^[0-9A-Za-zÀ-ÖØ-öø-ÿ ,.'- ]{1,60}$

description · object string

Show child attributes

Example:

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

photo · string

config · object

Show child attributes

blocks · object

Show child attributes

slug · string

id · string

labels · string[]

Pattern: ^[0-9A-Za-z._:-]{2,60}$

customDomains · string[]

registerWorkspace · boolean

If true, make this workspace metadata available to all workspaces with this variable : {{global.workspacesRegistry[WORKSPACE_SLUG]}}

repositories · object

Remote versioning repositories

Show child attributes

secrets · object

Show child attributes

events · object

Show child attributes

automations · object

Show child attributes

pages · object

Show child attributes

imports · object

Show child attributes

createdAt · string

updatedAt · string

createdBy · string