Workspaces

List workspaces

Changed on
get/api/v2/workspaces

Request

  • Base URL
    / (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /api/v2/workspaces
  • Auth
    API key in header Coder-Session-Token

Query parameters

qstring

Search query in the format key:value. Available keys are: owner, template, name, status, has-agent, dormant, last_used_after, last_used_before, has_external_agent, healthy, include_agent_metadata (expands each agent with the named metadata keys rather than filtering; repeat the key for multiple items).

limitinteger

Page limit

offsetinteger

Page offset

Response

OK

countinteger

Changes