Get Workspace

Retrieve the workspace associated with your API key, including workspace settings, billing information, plan limits, and current usage.

---

Endpoint

GET https://api.campaignlark.com/v1/workspace

---

Sample Request

GET https://api.campaignlark.com/v1/workspace

---

Response

Success — 200 OK

{
  "error": null,
  "data": {
    "workspace": {
      "id": 42,
      "name": "Acme Marketing",
      "conversion_tracking": true,
      "interaction_tracking": true,
      "is_approved": true,
      "is_suspended": false,
      "created_at": "2025-01-15T10:30:00Z"
    },
    "billing": {
      "subscription": {
        "plan_id": 2,
        "plan_name": "Pro",
        "status": "active",
        "current_period_start": "2025-02-01T00:00:00Z",
        "current_period_end": "2025-03-01T00:00:00Z",
        "cancel_at_period_end": false,
        "next_invoice_total": 99.99,
        "addons": [
          {
            "id": 7,
            "addon_id": 3,
            "name": "Additional Contacts",
            "price": 25,
            "quantity": 2
          }
        ]
      },
      "resources": [
        {
          "name": "contacts",
          "used": 1250,
          "allowed": 10000
        },
        {
          "name": "monthly_emails",
          "used": 18400,
          "allowed": 50000
        },
        {
          "name": "domains",
          "used": 2,
          "allowed": 5
        },
        {
          "name": "users",
          "used": 4,
          "allowed": 10
        },
        {
          "name": "segments",
          "used": 8,
          "allowed": 25
        },
        {
          "name": "automations",
          "used": 6,
          "allowed": 20
        },
        {
          "name": "events",
          "used": 3190,
          "allowed": 100000
        },
        {
          "name": "hourly_emails",
          "used": 184,
          "allowed": 1000
        }
      ]
    }
  }
}

The subscription value is null when the workspace has no active subscription.

---

Workspace Object

Field	Type	Description
id	integer	Unique workspace ID.
name	string	Workspace name.
conversion_tracking	boolean	Whether conversion tracking is enabled for the workspace.
interaction_tracking	boolean	Whether open and click tracking is enabled for the workspace. Enabled by default. When false, no tracking pixel is inserted into emails and links in emails and SMS messages are not rewritten, so opens and clicks are not recorded.
is_approved	boolean	Whether the workspace has been approved.
is_suspended	boolean	Whether the workspace is suspended.
created_at	string	Workspace creation timestamp in ISO 8601 format.

---

Subscription Object

Field	Type	Description
plan_id	integer	Subscription plan ID.
plan_name	string	Human-readable subscription plan name.
status	string	Current subscription status.
current_period_start	string	Start of the current billing period in ISO 8601 format.
current_period_end	string or null	End of the current billing period in ISO 8601 format.
cancel_at_period_end	boolean	Whether the subscription will be canceled at the end of the current period.
next_invoice_total	number	Estimated total for the next invoice.
addons	array	Add-ons attached to the subscription.

Subscription Add-on Object

Field	Type	Description
id	integer	Subscription add-on ID.
addon_id	integer	Add-on catalog ID.
name	string	Add-on name.
price	number	Unit price of the add-on.
quantity	integer	Number of add-on units.

---

Resources

Each resource contains the current usage and the allowed amount for that resource.

Field	Type	Description
name	string	Resource name: contacts, monthly_emails, domains, users, segments, automations, events, or hourly_emails.
used	integer	Current usage for the resource.
allowed	integer	Maximum allowed usage for the resource.

The hourly_emails resource tracks emails sent during the current hour and resets every hour.