Returns API metadata and the workspace the key belongs to, including its effective plan, seat usage per channel and whether it is an organization or a workspace inside one. Handy for verifying a key works.
Authorization
bearerAuth 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, "usage": { "linkedin": { "used": 3, "capacity": 10 }, "email": { "used": 8, "capacity": null } } } }}Run a deliverability test POST
Send one ordinary email from the mailbox to our test inbox. Within a few minutes the mailbox's `deliverabilityTest` reports whether it landed in the inbox or in spam (or did not arrive within 10 minutes), SPF, DKIM and DMARC as the receiving server saw them, and Spamhaus answers for the sending server and the domain. Read the mailbox to follow it (`status` goes from `running` to `done` or `failed`). One test runs at a time per mailbox, and a mailbox can run 10 a day.
Service health GET
Public service health check. This is the only endpoint that does not require an API key, so uptime monitors get a real status code instead of the `401` every other path returns without one. Returns `200` when the API is serving and its database is reachable, and `503` when it is not. The body carries no workspace or account data. Intended for external monitoring, not for polling before each request. Results are cached briefly, so a burst of calls returns the same verdict.