Workspace Group Member

API Explorer (2.0.0)

The entire API V2 documentation is interactive and can be tested here. To the right side of every endpoint you will see a box with an example request. You can click on the "Try it" button to send a request to the server right from the docs. You will need to provide an API key by clicking the ApiKeyAuth_token blue text.

Workspace

A workspace entity representing a workspace

idstring(uuid)read-onlyrequired

Unique identifier for the workspace

Example: "01959271-1f84-7174-aa83-67493f9a32b9"

timestamp_createdstring(date-time)read-onlyrequired

Timestamp when the workspace was created

Example: "2025-03-14T02:17:22.052Z"

timestamp_updatedstring(date-time)read-onlyrequired

Timestamp when the workspace was last updated

Example: "2025-03-14T02:17:22.052Z"

ownerstring(uuid)required

User ID of the workspace owner

Example: "01959271-1f84-7174-aa83-674a21e6bb74"

namestringrequired

Name of the workspace

Example: "My Workspace"

plan_idstringread-only

Plan ID for workspace

Example: "pid_hg_v1"

add_unsub_to_blockboolean

Whether to add unsubscribes to block list

Example: false

default_opportunity_valuenumber

Default value for opportunities

Example: 250

plan_id_leadfinderstringread-only

Plan ID for leadfinder

Example: "pid_lf_ls_v1"

plan_id_verificationstringread-only

Plan ID for verification service

Example: "pid_vf_v1"

org_logo_urlstringread-only

URL to workspace logo

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

org_client_domainstringread-only

The domain for the white label agency mode

Example: "example.com"

plan_id_crmstringread-only

Plan ID for CRM

Example: "pid_crm_v1"

plan_id_website_visitorstringread-only

Plan ID for website visitor tracking

Example: "pid_wvw_v1"

plan_id_inbox_placementstringread-only

Plan ID for inbox placement

Example: "pid_ip_v1"

{
  "id": "01959271-1f84-7174-aa83-67493f9a32b9",
  "timestamp_created": "2025-03-14T02:17:22.052Z",
  "timestamp_updated": "2025-03-14T02:17:22.052Z",
  "owner": "01959271-1f84-7174-aa83-674a21e6bb74",
  "name": "My Workspace",
  "plan_id": "pid_hg_v1",
  "add_unsub_to_block": false,
  "default_opportunity_value": 250,
  "plan_id_leadfinder": "pid_lf_ls_v1",
  "plan_id_verification": "pid_vf_v1",
  "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"
}

Workspace Group Member

A member of a workspace group. You can use the endpoints within this entity to manage the members of a workspace group.

idstring(uuid)read-onlyrequired

The unique identifier of the workspace group member

Example: "01959271-1f88-71d0-ba32-12ecd4b94337"

admin_workspace_idstring(uuid)read-onlyrequired

The id of the admin workspace

Example: "01959271-1f88-71d0-ba32-12ed4caffd2d"

sub_workspace_idstring(uuid)required

The id of the sub workspace

Example: "01959271-1f89-765d-8e8e-80faceb9c304"

statusstringrequired

Enum Value	Description
pending	The member has been invited to the workspace group but has not yet accepted the invitation.
accepted	The member has accepted the invitation to the workspace group.
rejected	The member has rejected the invitation to the workspace group.

Example: "accepted"

timestamp_createdstring(date-time)read-onlyrequired

Example: "2025-03-14T02:17:22.057Z"

timestamp_updatedstring(date-time)read-onlyrequired

Example: "2025-03-14T02:17:22.057Z"

sub_workspace_namestringread-only

The name of the sub workspace.

Example: "My Workspace"

admin_workspace_namestringread-only

The name of the admin workspace.

Example: "My Workspace"

{
  "id": "01959271-1f88-71d0-ba32-12ecd4b94337",
  "admin_workspace_id": "01959271-1f88-71d0-ba32-12ed4caffd2d",
  "sub_workspace_id": "01959271-1f89-765d-8e8e-80faceb9c304",
  "status": "accepted",
  "timestamp_created": "2025-03-14T02:17:22.057Z",
  "timestamp_updated": "2025-03-14T02:17:22.057Z",
  "sub_workspace_name": "My Workspace",
  "admin_workspace_name": "My Workspace"
}

Workspace Member

A member of a workspace with associated user details

idstring(uuid)read-onlyrequired

Unique identifier for the workspace member

Example: "01959271-1f8b-75f2-be1d-5be4942ab332"

emailstring(email)required

Email address of the workspace member

Example: "user@example.com"

user_idstring(uuid)read-onlyrequired

User ID of the workspace member

Example: "01959271-1f8b-75f2-be1d-5be578ad3a68"

rolestringrequired

THe role of the workspace member defining their access level. While the "owner" role is listed in the enum, it cannot be created via the API, and is only assigned to the user who creates the workspace.

Enum Value	Description
owner	Owner - Full access and workspace management
admin	Admin - Full access except workspace deletion
editor	Editor - Can edit but not manage workspace settings
view	View - Read-only access
any	Any - Special role for permission checks

Example: "editor"

timestamp_createdstring(date-time)read-onlyrequired

Timestamp when the workspace member was created

Example: "2025-03-14T02:17:22.059Z"

workspace_idstring(uuid)read-onlyrequired

ID of the workspace this member belongs to

Example: "01959271-1f8b-75f2-be1d-5be63d29ce8b"

acceptedbooleanread-onlyrequired

Whether the member has accepted the workspace invitation

Example: false

issuer_idstring(uuid)read-only

ID of the user who added this member to the workspace

Example: "01959271-1f8b-75f2-be1d-5be7c8ea52f5"

{
  "id": "01959271-1f8b-75f2-be1d-5be4942ab332",
  "email": "user@example.com",
  "user_id": "01959271-1f8b-75f2-be1d-5be578ad3a68",
  "role": "editor",
  "timestamp_created": "2025-03-14T02:17:22.059Z",
  "workspace_id": "01959271-1f8b-75f2-be1d-5be63d29ce8b",
  "accepted": false,
  "issuer_id": "01959271-1f8b-75f2-be1d-5be7c8ea52f5"
}

API Explorer (2.0.0)

Analytics

Account

Campaign

Email

Email Verification

Lead List

Inbox Placement Test

Inbox Placement Analytics

Inbox Placement Blacklist & SpamAssassin Report

API Key

Account Campaign Mapping

Lead

Background Job

Custom Tag

Block List Entry

Lead Label

Workspace