Workspaces

Every campaign endpoint is workspace-scoped — start by finding your workspaceId.

Every Campaign Agent endpoint is scoped to a single workspace. The workspace id is the first path segment of every campaign URL:

https://api.acquisity.ai/v1/workspaces/{workspaceId}/campaigns

So before you can list campaigns, read metrics, or work with leads, you need a {workspaceId}. This page is the first call you make.

List the workspaces your token can access

GET /v1/workspaces returns exactly the workspaces your token can use — resolved from your membership and where Public API access is enabled, not every workspace in the system. Start here.

curl -H "Authorization: Bearer <token>" \
  https://api.acquisity.ai/v1/workspaces

{
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "Acme Inc",
      "slug": "acme-inc",
      "logoUrl": null,
      "role": "owner",
      "createdAt": "2026-05-22T10:00:00.000Z",
      "updatedAt": "2026-05-22T10:00:00.000Z",
      "links": {
        "self": "https://api.acquisity.ai/v1/workspaces/123e4567-e89b-12d3-a456-426614174000"
      }
    }
  ],
  "links": { "self": "...", "next": null },
  "meta": { "pagination": { "nextCursor": null, "hasMore": false, "limit": 50 } }
}

Copy the id of the workspace you want and use it as {workspaceId} on every other endpoint. role tells you your access level in that workspace.

What each token type sees

• Workspace API keys (acq_org_...) — list returns only the single workspace that owns the key.
• Personal access tokens (acq_live_...) — list returns every workspace you are an active member of where Public API access is enabled.

Either way, the response is only what your token is actually allowed to reach, so there is nothing extra to enumerate.

Scope

Listing workspaces requires the workspaces:read scope on your key. See Scopes for the full list, and Authentication to create a key.

Pagination

The list is cursor-paginated. Omit cursor for the first page, then follow links.next (or pass meta.pagination.nextCursor) until links.next is null. Most integrations have a small number of workspaces and never page. See Rate limits for pagination and limit headers.

Next step

Once you have a {workspaceId}, head to the endpoint reference to list campaigns in that workspace.