Get Workspace

Retrieve a summary of the workspace associated with your Developer API key. The workspace is resolved from the bearer token, so this endpoint does not accept a workspace UUID.

GET
/v1/workspace

Retrieve the authenticated workspace overview

Request
cURL
curl "https://api.leadpush.io/v1/workspace" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer {token}"
Response Example
{
  "data": {
    "workspace": {
      "uuid": "<workspace_uuid>",
      "name": "Acme",
      "state": "active"
    },
    "role": "owner",
    "counts": {
      "contacts": 1250,
      "campaigns": 12,
      "segments": 8,
      "newsletters": 24,
      "verified_domains": 2
    },
    "sending": {
      "workspace_setup": true,
      "has_verified_domain": true
    }
  }
}

Workspace Scope

How the endpoint determines which workspace to return

  • Developer API keys are scoped to one workspace.
  • A workspace UUID cannot be supplied in the path or query string.
  • Access is checked against the current workspace membership and read policy.