Skip to Content
CallMitraDocs
API referenceWorkspace

Check an API key

Returns the workspace the request runs in, the key that sent it (access, resources, expiry) and its rate limit. Every key can call this, including read-only keys and keys limited to other resources. With `X-Workspace-Id`, an agency key sees the client workspace.

GET
/api/v1/workspace

Returns the workspace the request runs in, the key that sent it (access, resources, expiry) and its rate limit. Every key can call this, including read-only keys and keys limited to other resources. With X-Workspace-Id, an agency key sees the client workspace.

Authorization

headerX-API-Key<token>

Create in the console: Settings → API & webhooks.

Response Body

OK

application/json
  1. response
apiKey*|

The key that authenticated the request.

rateLimit*
success?Success
Defaulttrue
workspace*|

Workspace the request runs in.

[key: string]?any
Example Request
curl -X GET 'https://api.callmitra.ai/api/v1/workspace'
Example Response
{  "apiKey": {    "id": "0d9e8f7a-6b5c-4d3e-2f1a-0b9c8d7e6f5a",    "name": "CRM sync",    "prefix": "vk_live_Ab3dE6",    "scopes": {      "access": "read",      "resources": [        "calls",        "leads"      ]    }  },  "rateLimit": {    "limit": 300,    "windowSeconds": 60  },  "success": true,  "workspace": {    "id": "7b1c2f0e-1d2a-4c3b-9a8e-5f6d7c8b9a01",    "name": "Acme Realty"  }}