Get Key

See what the calling API key is and what it can reach.

GET/api/v1/key

Returns the scope and access of the key in the x-api-key header. Use it to check a key is configured correctly.

Example request

bash
curl https://anderro.com/api/v1/key \
  -H "x-api-key: sk_org_your_key"

Responses

200The calling key
json
{
  "data": {
    "scope": "organization",
    "access": "read",
    "name": "Partner portal",
    "product_id": null,
    "account_id": null,
    "organization_id": "org_abc123",
    "expires_at": null
  }
}

scope is organization, account or product. account_id is set for account and product keys, product_id for product keys. access is read or full; product keys always have full access.