MailcrateDocs
Organization

List workspaces

GET
/public/organization/workspaces

Requires the workspaces:read scope.

Authorization

OrganizationApiKey
headerAuthorization<token>

Api-Key mco_... — an organization management key.

Query Parameters

search?string
Lengthlength <= 200
type?string
Value in"production""sandbox"
sendingStatus?string
Value in"active""paused"
limit?integer
Range1 <= value <= 500
Default50
offset?integer
Range0 <= value
Default0
page?integer
Range1 <= value
sortBy?string
sortOrder?string
Value in"ASC""DESC"

Response Body

A page of results.

application/json
  1. response
data*array<>
total*integer

Matches across all pages.

limit*integer
offset*integer

The offset actually applied, also when you paginated with page.

Example Request
curl -X GET 'https://api.mailcrate.io/public/organization/workspaces' \  -H 'Authorization: Api-Key <api_key>'
Example Response
{  "data": [    {      "id": "string",      "name": "string",      "type": "production",      "sendingStatus": "active",      "sendingPausedReason": "bounce-rate",      "sendingPausedAt": "string",      "postalAddress": {},      "icon": "string",      "color": "string",      "created": "string"    }  ],  "total": 0,  "limit": 0,  "offset": 0}

List a workspace's API keys GET

Prefixes, scopes and expiry. Never key material. Requires the `workspace-keys:manage` scope.

Provision a workspace POST

Creates a tenant workspace and, when asked, its first API key. The key's plaintext is in this response and nowhere else. Requires the `workspaces:provision` scope.