Workspace

{
  "id": "019f985c-634d-7bcd-8be3-7b6dae1efe70",
  "timestamp_created": "2026-07-25T08:20:19.405Z",
  "timestamp_updated": "2026-07-25T08:20:19.405Z",
  "owner": "019f985c-634d-7bcd-8be3-7b6eabf24937",
  "name": "My Workspace",
  "scheduled_for_removal_at": "2026-07-25T08:20:19.405Z",
  "plan_id": "pid_hg_v1",
  "plan_id_bundle": "pid_bundle_scale_v1",
  "add_unsub_to_block": false,
  "default_opportunity_value": 250,
  "plan_id_leadfinder": "pid_lf_ls_v1",
  "plan_id_verification": {
    "quantity": 5,
    "product_id": "pid_verify_v1_monthly",
    "timestamp_updated": "2024-07-22T05:56:58.667Z"
  },
  "org_logo_url": "https://example.com/logo.png",
  "org_client_domain": "example.com",
  "plan_id_crm": "pid_crm_v1",
  "plan_id_website_visitor": "pid_wvw_v1",
  "plan_id_inbox_placement": "pid_ip_v1"
}

This schema describes objects returned by the Workspace endpoints.

A workspace entity representing a workspace

string<uuid>

required

read-only

Unique identifier for the workspace

Example:

"019f985c-634d-7bcd-8be3-7b6dae1efe70"

timestamp_created

string<date-time>

required

read-only

Timestamp when the workspace was created

Example:

"2026-07-25T08:20:19.405Z"

timestamp_updated

string<date-time>

required

read-only

Timestamp when the workspace was last updated

Example:

"2026-07-25T08:20:19.405Z"

owner

string<uuid>

required

read-only

User ID of the workspace owner

Example:

"019f985c-634d-7bcd-8be3-7b6eabf24937"

name

string

required

Name of the workspace

Example:

"My Workspace"

scheduled_for_removal_at

null | string<date-time>

Timestamp when this workspace is scheduled to be removed

Example:

"2026-07-25T08:20:19.405Z"

plan_id

null | string

Plan ID for workspace

Example:

"pid_hg_v1"

plan_id_bundle

null | string

Plan ID for workspace bundle

Example:

"pid_bundle_scale_v1"

add_unsub_to_block

null | boolean

Whether to add unsubscribes to block list

Example:

false

default_opportunity_value

null | number

Default value for opportunities

Example:

250

plan_id_leadfinder

null | string

Plan ID for leadfinder

Example:

"pid_lf_ls_v1"

plan_id_verification

object

read-only

Plan ID for verification service

Show child attributes

org_logo_url

null | string

URL to workspace logo

Example:

"https://example.com/logo.png"

org_client_domain

null | string

The domain for the white label agency mode

Example:

"example.com"

plan_id_crm

null | string

Plan ID for CRM

Example:

"pid_crm_v1"

plan_id_website_visitor

null | string

Plan ID for website visitor tracking

Example:

"pid_wvw_v1"

plan_id_inbox_placement

null | string

Plan ID for inbox placement

Example:

"pid_ip_v1"

⌘I

Overview

Getting Started

Guides

Resources

Schemas