Developers
Open Swarmhit
Smart APIRaw API
API referenceOrganization
GET
/workspaces/{id}

JavaScript SDK: swarmhit.workspaces.get(workspaceId)

Returns one workspace inside the connected organization, including its members, the organization managers granted access via the organization (read-only), and pending invites.

Authorization

bearerAuth
AuthorizationBearer <token>

An API key created on the Access tokens page.

In: header

Path Parameters

id*string

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/workspaces/string"
{  "data": {    "id": "string",    "name": "string",    "avatar": "string",    "seatAllocation": 0,    "sendersUsed": 0,    "mailboxesUsed": 0,    "seatsUsed": 0,    "ownerId": "string",    "members": [      {        "id": "string",        "email": "string",        "username": "string",        "role": "owner"      }    ],    "orgMembers": [      {        "id": "string",        "email": "string",        "username": "string"      }    ],    "invites": [      {        "identifier": "string",        "role": "admin",        "createdAt": "2019-08-24T14:15:22Z"      }    ]  }}

Delete a workspace DELETE

**JavaScript SDK:** [`swarmhit.workspaces.delete(workspaceId)`](/smart-api/sdk/methods#workspaces) Removes the workspace from the organization. Rejected with `400` while it still has connected sender accounts or mailboxes, disconnect them first.

Invite a member to a workspace POST

**JavaScript SDK:** [`swarmhit.workspaces.members.invite(workspaceId, params)`](/smart-api/sdk/methods#workspaces.members) Sends an invite (by email) into the workspace. Role defaults to `member`.