SparQDocs
GuidesAPI referencesparqhq.ai
API referenceAccess

Join Memberships

POST
/v1/admin/me/join

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.

Join every invitation that matches the signed-in person's email, binding it to this person; audited member.join in each workspace. Joining again changes nothing, so the call is safe to repeat without an Idempotency-Key.

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.

Header Parameters

Idempotency-Key?string

Makes a retry safe: the same key, route and body within 24 hours returns the stored response and the same result id. The same key with a different body or route is idempotency_conflict; while the first request runs, idempotency_in_progress.

Length8 <= length <= 128

Response Body

Successful Response

application/json
  1. response

The signed-in person's memberships through the sign-in issuer of their token. Send one workspace_id as the Sparq-Workspace header when there is more than one.

items*array<>
Example Request
curl -X POST 'http://dev-sparq.centralindia.cloudapp.azure.com:8000/v1/admin/me/join'
Example Response
{  "items": [    {      "workspace_id": "0967198e-ec7b-4c6b-b4d3-f71244cadbe9",      "workspace_name": "string",      "member_id": "435a4844-006a-4cfc-a644-e8eb2dd2ca43",      "status": "invited",      "operators": true,      "roles": [        "project_admin"      ]    }  ]}

Invite Member POST

> **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 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.