Developers
Open Swarmhit
DocumentationAPI Reference
Organization
DELETE
/workspaces/{id}/members/{memberId}

Removes a member from the workspace, or revokes a pending invite. Pass ?type=invite (with the invite email as memberId) to revoke an invite; type defaults to user. Organization members cannot be removed here.

Authorization

bearerAuth
AuthorizationBearer <token>

An API key created under Settings → API & Webhooks.

In: header

Path Parameters

id*string
memberId*string

The member's user id, or the invite email when type is invite.

Query Parameters

type?string

Whether memberId is a user (default) or a pending invite.

Default"user"

Value in

  • "user"
  • "invite"

Response Body

application/json

application/json

application/json

application/json

curl -X DELETE "https://example.com/workspaces/string/members/string"
{  "data": {    "ok": true  }}

List workspaces GET

For an organization workspace, lists the workspaces inside it with each one's sender-seat allocation, connected senders and member count, plus the organization's seat pool (`pool` / `allocated` / `available`). When the connected workspace is not an organization, returns `isOrganization: false` and an empty `workspaces` list.

Update a workspace PATCH

Updates any subset of a workspace's `name`, `avatar` (empty string clears it) and `seatAllocation`. Lowering the allocation below the workspace's connected senders, or over-allocating the organization pool, is rejected with `400`.