Get details of a specific workspace

GET

api

workspaces

{uuid}

{
  "success": true,
  "data": {
    "uuid": "550e8400-e29b-41d4-a716-446655440000",
    "name": "ACME Inc.",
    "url": "https://acme.com",
    "tracking_script_id": "123",
    "tracking_script_snippet": "<script>...</script>",
    "available_tags": [
      "marketing",
      "design"
    ],
    "status": "active"
  }
}

Authorizations

Authorization

string

header

required

Enter your personal access token (PAT) to authenticate

Path Parameters

uuid

string

required

UUID of the workspace

Example:

"550e8400-e29b-41d4-a716-446655440000"

Response

200

application/json

Workspace details

success

boolean

Example:

true

data

object

Representation of a workspace

data.uuid

string

Example:

"550e8400-e29b-41d4-a716-446655440000"

data.name

string

Example:

"ACME Inc."

data.url

string

Example:

"https://acme.com"

data.tracking_script_id

string

Example:

"123"

data.tracking_script_snippet

string

Example:

"<script>...</script>"

data.available_tags

string[]

Example:

["marketing", "design"]

data.status

enum<string>

The current status of the entity. Possible values: 'on_trial', 'active', 'inactive'.

Available options:

on_trial,

active,

inactive

Example:

"active"

Create a new workspace Delete a workspace

{
  "success": true,
  "data": {
    "uuid": "550e8400-e29b-41d4-a716-446655440000",
    "name": "ACME Inc.",
    "url": "https://acme.com",
    "tracking_script_id": "123",
    "tracking_script_snippet": "<script>...</script>",
    "available_tags": [
      "marketing",
      "design"
    ],
    "status": "active"
  }
}

Get Started

Contacts

Organisations

Sessions

Workspaces

Authorizations

Path Parameters

Response