MCP

workspace/get

Tool: read

List all workspaces under the authenticated agency.

Returns a paginated list of Workspace objects. Available on all plans. apiKey is redacted — see schemas/workspace.

Needs an organization-level key. A workspace- or clientspace-scoped key gets 403 SCOPE_NOT_ALLOWED — that session is already inside one workspace, so read its campaigns, senders and prospects directly, without a workspaceId.

A deleted workspace stops appearing here immediately, while its contents are still purged in the background for up to ~1 hour — absence from this list does not mean that purge has finished. See workspace/delete_by_id.

Arguments

name type req notes
page integer Page number, 1-indexed (default 1)
limit integer limit default 30, max 30; see schemas/pagination
startingAfter integer Cursor for next page (int64)

Response

200 — Paginated list; object: {items: Workspace[], pagination}; each item: see schemas/workspace. Deltas: none.

Pagination: see schemas/pagination.

Errors: 400, 401, 403, 406, 422, 429, 500 — shared schema: schemas/errors.

Invoke

Call read with name: "workspace/get".