Skip to content

Workspaces and members

A workspace holds app groups, members and a plan. People join one by invitation, and scripts reach it with an API key. Roles are explained in the overview.

GET/v1/mepeople only

The developer the dashboard token belongs to, the workspaces they are in, and the invitations waiting for them. An API key gets 403. This is also the list of workspaces: there is no other route that lists them.

Field Type Meaning
user object { id, email, name }
workspaces[] array { id, name, plan, role, suite, sole_owner }, one per workspace the developer has a role in. sole_owner is true where they are its only owner, which keeps them from deleting their account.
invitations[] array { id, workspace: { id, name }, role, invited_by_email, expires_at }. Listed only once the developer’s email address is verified.
{
"user": { "id": "…", "email": "[email protected]", "name": "Ada" },
"workspaces": [{ "id": "…", "name": "Acme", "plan": "free", "role": "owner", "suite": false, "sole_owner": true }],
"invitations": [
{
"id": "…",
"workspace": { "id": "…", "name": "Widgets" },
"role": "developer",
"invited_by_email": "[email protected]",
"expires_at": "…"
}
]
}
POST/v1/workspacespeople only
Field Type Meaning
name string 1 to 80 characters, trimmed, no control or invisible characters, and not one that passes for SeekAuth’s own products (see Slugs and hosts).

The new workspace starts on the deployment’s default plan, and its creator is its owner.

POST /v1/workspaces
{ "name": "Acme" }
201
{ "id": "…", "name": "Acme", "plan": "free", "role": "owner" }
Status code When
400 name_not_allowed The name holds control or invisible characters, passes for one of SeekAuth’s own products, or is made only of words such as support or admin.
409 conflict “this account owns as many workspaces as it may”: a developer owns at most 10.
429 rate_limited More than 30 creations in an hour by this developer.

There is no route to rename a workspace.

GET/v1/workspaces/:idviewer
{ "id": "…", "name": "Acme", "plan": "free", "role": "owner", "created_at": "…", "suite": false, "deletable": true }

role is the caller’s own role. suite says the workspace was made for an account of Seek and LinkPay. deletable is false for the two workspaces that cannot be deleted, whoever asks (and for every workspace while a deployment that names a suite cannot find it). A workspace the caller has no role in answers 404.

DELETE/v1/workspaces/:id?confirm=:nameowner, people only, a login from the last 10 minutes

Deletes the workspace and everything in it, at once and for good:

  • every app group, with its apps, both environments and every user in them, as deleting a group does: the environments’ audit logs stay, and lose the address and user agent of their events right after, in batches;
  • the members, the invitations and the API keys;
  • the subscriptions: before anything is deleted, LinkPay is asked what it has for the workspace (a payment it has not told of yet among it), and every subscription that could renew stops renewing. LinkPay ends a subscription at the end of the period paid for, so nothing more is charged; the workspace and its plan are gone at once, and the period already paid is not refunded. A checkout that was still open and is paid later becomes a subscription of a deleted workspace, which the next reconciliation (every ten minutes) stops in the same way; so does one whose first payment was still being made, which nothing can change until it goes through. One LinkPay no longer has is nothing to stop.

Deleting a workspace cannot be undone, so it needs a login from the last 10 minutes, as deleting an account does: an older one is answered 401 step_up_required with acr_values aal2 and max_age 600, and the dashboard asks for a new login and sends it again.

The groups’ slugs are retired for good: the workspace that held them is gone, so no workspace can answer on those login addresses again. The workspace’s name must be repeated, exactly, in the confirm query parameter. admin.workspace.deleted goes to the platform’s audit log with what went: groups, apps, environments, users, members, invitations, api_keys and subscriptions_canceled. Answers 204.

DELETE /v1/workspaces/{ws}?confirm=Acme
204
Status code When
400 bad_request confirm is missing or is not the workspace’s name.
401 step_up_required The login is more than 10 minutes old.
403 forbidden The caller is not an owner, or is an API key or a service.
404 not_found The caller has no role in the workspace.
409 conflict The Platform workspace, which holds the developer accounts, and the workspace that holds the Seek and LinkPay accounts cannot be deleted; nor can any while a deployment that names a suite (SUITE_ISSUER) cannot find it.
502 upstream_error LinkPay did not answer while a subscription renews. Nothing is deleted; try again.

In the dashboard, an owner deletes a workspace on its Settings page, with its name typed to confirm. A workspace that was made for an account of Seek and LinkPay is deleted by itself, in the background, when that account is deleted, unless it has another owner; see Data and retention.

GET/v1/workspaces/:id/membersviewer
{ "members": [{ "user_id": "…", "email": "[email protected]", "name": "Ada", "role": "owner", "created_at": "…" }] }
PATCH/v1/workspaces/:id/members/:user_idadmin
Field Type Meaning
role string viewer, developer, admin or owner.

Only an owner gives, changes or takes away the owner role. Setting a member’s role below admin revokes the API keys they made. The answer is { "user_id", "role" }.

Status code When
400 bad_request “unknown role”
403 forbidden The caller may not grant the new role, or change the current one.
404 not_found Not a member of this workspace.
409 conflict “a workspace needs at least one owner”
DELETE/v1/workspaces/:id/members/:user_idadmin

Answers 204. The member’s API keys are revoked. The same 403, 404 and 409 as above apply: the last owner cannot be removed. A developer who deletes their own account leaves every workspace this way, but their API keys are deleted, and the invitations they sent go with them; see Developer accounts.

People join a workspace only by saying yes to an invitation. An invitation lasts 7 days, holds a seat under the plan’s member limit while it waits, and can be accepted only while the person who sent it could still grant its role.

POST/v1/workspaces/:id/invitationsadmin, people only
Field Type Meaning
email string The address to invite. Trimmed and lowercased.
role string viewer, developer, admin or owner. Only an owner invites an owner.

An email goes to the address with a button to open the invitation. The answer has the same fields whether or not the address already has a developer account. Inviting the same address again replaces the invitation, with the new role and a new expiry. One address gets at most 5 invitation emails a day across all workspaces: past that the invitation is still made, and shown when the person signs in, but no email is sent, and the answer says so with "emailed": false.

POST /v1/workspaces/{ws}/invitations
{ "email": "[email protected]", "role": "developer" }
201
{
"id": "…",
"email": "[email protected]",
"role": "developer",
"invited_by": "…",
"invited_by_email": "[email protected]",
"created_at": "…",
"expires_at": "…",
"emailed": true
}
Status code When
400 bad_request “unknown role”, “invalid email”
402 plan_limit Members and pending invitations already fill the plan, for example “The Free plan includes 2 members. The Pro plan includes more.”
403 forbidden The caller may not grant this role.
409 conflict “already a member of this workspace”
429 rate_limited More than 30 invitations in an hour from this developer.
GET/v1/workspaces/:id/invitationsadmin

{ "invitations": [...] }: the invitations that have not expired, newest first, each shaped as above.

DELETE/v1/workspaces/:id/invitations/:invitation_idadmin

Answers 204, or 404 for an invitation of another workspace. An invitation to be owner can only be withdrawn by an owner (403).

POST/v1/invitations/:id/acceptthe invited developer

Works only for the developer signed in with the invited address, once it is verified, before the invitation expires; anyone else, or a second try, gets 404. The answer is the workspace joined:

{ "id": "…", "name": "Acme", "plan": "free", "role": "developer" }
Status code When
402 plan_limit The workspace has no seat left.
404 not_found Not this developer’s invitation, or it expired.
409 conflict “this invitation is no longer valid: ask for a new one” (its sender can no longer grant the role), or “you are already a member of this workspace”.
POST/v1/invitations/:id/declinethe invited developer

Answers 204, or 404 when the invitation is not the caller’s. It works even when the invitation is no longer valid.

See API keys for what a key may do. Keys are made and revoked by people: an API key cannot manage keys.

GET/v1/workspaces/:id/api-keysadmin

Every key of the workspace, revoked ones included, newest first. The key itself is never listed.

{
"api_keys": [
{
"id": "…",
"name": "CI",
"environment": "development",
"created_by": "…",
"created_by_email": "[email protected]",
"created_at": "…",
"last_used_at": null,
"revoked_at": null
}
]
}

last_used_at moves at most once a minute.

POST/v1/workspaces/:id/api-keysadmin, people only
Field Type Meaning
name string 1 to 80 characters, no control or invisible characters.
environment string development (a key sk_dev_…) or production (a key sk_live_…).

The answer is the key’s entry plus key, the secret itself. It is shown only here; SeekAuth keeps its SHA-256 hash.

POST /v1/workspaces/{ws}/api-keys
{ "name": "CI", "environment": "development" }
201
{
"id": "…",
"name": "CI",
"environment": "development",
"created_by": "…",
"created_by_email": "[email protected]",
"created_at": "…",
"last_used_at": null,
"revoked_at": null,
"key": "sk_dev_…"
}
Status code When
400 bad_request “environment must be development or production”
403 forbidden The caller is an API key, or below admin.
DELETE/v1/workspaces/:id/api-keys/:key_idadmin, people only

Answers 204; the key answers 401 from then on. An unknown key, or one already revoked, gets 404.

GET/v1/workspaces/:id/usageviewer

The month’s active users, kept for a minute. mau is the sum over the production environments, which is what the plan counts; each development environment is listed apart with its own limit. A development API key gets 403.

{
"month": "2026-11",
"mau": 312,
"groups": [{ "group_id": "…", "slug": "your-app", "name": "Your App", "environment_id": "…", "mau": 312 }],
"development": [
{ "group_id": "…", "slug": "your-app", "name": "Your App", "environment_id": "…", "mau": 4, "limit": 100 }
]
}

See Plans and limits for what is counted.