Skip to main content
This schema describes objects returned by the Workspace endpoints.
A workspace entity representing a workspace

Fields

FieldTypeRequiredDescription
idstring (uuid)YesUnique identifier for the workspace (read-only)
timestamp_createdstring (date-time)YesTimestamp when the workspace was created (read-only)
timestamp_updatedstring (date-time)YesTimestamp when the workspace was last updated (read-only)
ownerstring (uuid)YesUser ID of the workspace owner (read-only)
namestringYesName of the workspace
plan_idstring, nullableNoPlan ID for workspace (read-only)
add_unsub_to_blockboolean, nullableNoWhether to add unsubscribes to block list
default_opportunity_valuenumber, nullableNoDefault value for opportunities
plan_id_leadfinderstring, nullableNoPlan ID for leadfinder (read-only)
plan_id_verificationobjectNoPlan ID for verification service (read-only)
plan_id_verification.quantitynumberNo
plan_id_verification.product_idstringNo
plan_id_verification.timestamp_updatedstring (date-time)No
org_logo_urlstring, nullableNoURL to workspace logo
org_client_domainstring, nullableNoThe domain for the white label agency mode (read-only)
plan_id_crmstring, nullableNoPlan ID for CRM (read-only)
plan_id_website_visitorstring, nullableNoPlan ID for website visitor tracking (read-only)
plan_id_inbox_placementstring, nullableNoPlan ID for inbox placement (read-only)