General
GET
/

Returns API metadata and the workspace the key belongs to, including its effective plan, sender-seat usage and whether it is an organization or a workspace inside one. Handy for verifying a key works.

Authorization

bearerAuth
AuthorizationBearer <token>

An API key created under Settings → API & Webhooks.

In: header

Response Body

application/json

application/json

curl -X GET "https://example.com"
{  "data": {    "name": "Swarmhit API",    "version": "v1",    "workspace": {      "id": "aBc123",      "name": "Acme",      "plan": "scale",      "isOrganization": true,      "isSubWorkspace": false,      "seatLimit": 10,      "seatsUsed": 3    }  }}