List Workspaces

GET
/v1/admin/workspaces

Every workspace for an operator; a workspace admin's own workspace otherwise.

Authorization

HTTPBearer
headerAuthorizationBearer <token>

Bearer credential. API keys look like sqk_<geo>_<key_id>_<secret>: treat them as opaque and never put one in a browser. Older keys without the geo part stay valid until rotated. Find a geo's endpoints through GET /.well-known/sparq-discovery before sending a key.

Query Parameters

limit?Limit

Items per page (default 50, at most 200).

Range1 <= value <= 200
Default50
cursor?|

Opaque next_cursor from the previous page.

sort?|

Field to sort by; '-' for descending. Ties break on the id.

Header Parameters

Sparq-Workspace?string

For a person signed in to a console with several workspaces: the workspace this call is for, one of their memberships (listMyMemberships). Without it such a person gets workspace_required (400); a workspace they are not a member of is forbidden. It never grants anything, and other callers' credentials ignore it.

Formatuuid

Response Body

Successful Response

application/json
  1. response
next_cursor*|

Pass as cursor for the next page; empty at the end.

total?|

Number of matching items, only when cheap to count.

items*array<>
Example Request
curl -X GET 'http://dev-sparq.centralindia.cloudapp.azure.com:8000/v1/admin/workspaces'
Example Response
{  "next_cursor": "string",  "total": 0,  "items": [    {      "workspace_id": "0967198e-ec7b-4c6b-b4d3-f71244cadbe9",      "slug": "string",      "name": "string",      "status": "active",      "created_at": "2019-08-24T14:15:22Z",      "home_region": "westeurope",      "allowed_regions": [        "westeurope"      ],      "geo_id": "eu",      "api_endpoint": "http://example.com",      "admin_endpoint": "http://example.com"    }  ]}