Skip to main content
GET
/
v2
/
workspaces
/
{workspaceId}
cURL
curl --request GET \
  --url https://api.eda.prisme.ai/v2/workspaces/{workspaceId} \
  --header 'Authorization: Bearer <token>'
{
  "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": {},
  "platformRepositories": {},
  "secrets": {
    "schema": {}
  },
  "events": {
    "mapping": {},
    "types": {}
  },
  "writeLock": {
    "lockedAt": "<string>",
    "lockedBy": "<string>",
    "reason": "<string>"
  },
  "automations": {},
  "pages": {},
  "imports": {},
  "createdAt": "<string>",
  "updatedAt": "<string>",
  "createdBy": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.prisme.ai/llms.txt

Use this file to discover all available pages before exploring further.

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

​
name
string
required
Pattern: ^[0-9A-Za-zÀ-ÖØ-öø-ÿ ,.'- ]{1,60}$
​
description
Example:
{ "fr": "Bonjour", "en": "Hello" }
​
photo
string
​
config
object
​
blocks
object
​
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

​
platformRepositories
object

Platform remote versioning repositories

​
secrets
object
​
events
object
​
writeLock
object

Lock preventing writes during versioning operations or unresolved merge conflicts

​
automations
object
​
pages
object
​
imports
object
​
createdAt
string
​
updatedAt
string
​
createdBy
string