SparQDocs
GuidesAPI referencesparqhq.ai
API referenceAccess

List Members

GET
/v1/admin/workspaces/{workspace_id}/members

Not available yet. This operation is part of the published contract and answers 501 not_implemented until it is built. The request and response shapes below are final for this contract version.

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.

Path Parameters

workspace_id*Workspace Id
Formatuuid

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/497f6eca-6276-4993-bfeb-53cbbbba6f08/members'
Example Response
{  "next_cursor": "string",  "total": 0,  "items": [    {      "member_id": "435a4844-006a-4cfc-a644-e8eb2dd2ca43",      "workspace_id": "0967198e-ec7b-4c6b-b4d3-f71244cadbe9",      "email": "ana@example.com",      "name": "string",      "status": "invited",      "principal_id": "string",      "invited_by_credential_id": "5947e677-91b6-4847-b387-f6dea4b45eb2",      "invited_at": "2019-08-24T14:15:22Z",      "joined_at": "2019-08-24T14:15:22Z"    }  ]}

List Grants GET

> **Not available yet.** This operation is part of the published contract and answers `501 not_implemented` until it is built. The request and response shapes below are final for this contract version.

List My Memberships GET

> **Not available yet.** This operation is part of the published contract and answers `501 not_implemented` until it is built. The request and response shapes below are final for this contract version. Every workspace the signed-in person may open: joined memberships, and invitations that match their email and wait to be joined.