List workspaces

GET/api/v1/list_workspaces

Features

List your Docsbook documentation projects — one line each: id, repo, name, live URL, plan, whether the assistant is on, and when it last published. This is the PICKER for 'which projects do I have'. When the user already NAMED the project, do not start here: pass the name to get_workspace (or as workspace_id on any tool) and the server resolves it. With query, returns only the projects matching a name, repo, domain or URL fragment, best match first — the fallback when a name did not resolve. For a project's full settings call get_workspace on the one you picked.

Price — free, never metered.

Also reachable by name at POST /api/v1/tools/list_workspaces.

Input2

Authorizationheaderrequired

Your API key, sent as Authorization: Bearer dbk_YOUR_API_KEY.Sent from your browser straight to the API — never to Docsbook, never stored.

querystring · query

Narrow to projects matching this — part of a name, a repo, a domain or a URL. Best match first. Omit to list everything.

limitinteger · query

Rows to return (default 50). The answer says how many matched in total.

Output3

okboolean

Whether the tool itself succeeded. A tool that ran and refused — an exhausted balance, a plan restriction, a bad argument — answers 200 with ok: false: the call was made and billed, and that refusal is its answer.

resultobject

The tool's own JSON answer, already parsed — not a string to parse a second time.

Show child attributes6

totalnumber

matchednumber

shownnumber

querystring

workspacesobject[]

{ id, repoFullName, customName, site_url, customDomain, plan, visibility, aiEnabled, lastPublishedAt, lastUsedAt, createdAt, publish_mismatch_warning?, site_url_collision_warning? }.

notestring

duration_msinteger

Server-side wall time for the call.

Responses

200The tool ran. Read ok to see whether it succeeded.

401Missing or invalid API key.

Example input

curl 'https://docsbook.io/api/v1/list_workspaces' \
  -H 'Authorization: Bearer dbk_YOUR_API_KEY'

Example output

{
  "ok": true,
  "result": {
    "total": 0,
    "matched": 0,
    "shown": 0,
    "query": "<query>",
    "workspaces": [],
    "note": "<note>"
  },
  "duration_ms": 0
}

更新日 Sep 24, 2026