Developer portal
GET /admin/tenants/{tenant_id}
Full tenant detail: subscription, settings, memberships, keys, and recent scans.
GET /admin/tenants/{tenant_id}Auth: admin
Summary
Full tenant detail: subscription, settings, memberships, keys, and recent scans.
Example
Response
{
"status": "success",
"tenantId": "acme-bank",
"name": "Acme Bank",
"subscription": {
"tier": "monitor"
},
"settings": {
"scanAllowlist": [
"acmebank.com"
],
"orgType": "customer",
"msspParentTenantId": null
},
"memberships": [
{
"email": "security@acmebank.com",
"role": "admin"
}
],
"apiKeys": [
{
"keyId": "key_01",
"label": "automation",
"revoked": false
}
]
}Errors
| Code | Meaning | Typical cause | Suggested fix |
|---|---|---|---|
| 404 | Not found | Scan, schedule, share link, or resource id does not exist or expired. | Verify id and tenant scope; share links expire per expiresHours. |
| 422 | Unprocessable entity | Invalid payload shape, unsupported scenario, or infeasible constraints. | Fix field errors in response detail; relax constraints and retry. |
| 429 | Too many requests | Per-key rate limit exceeded (default 300 requests per minute) or public endpoint limit. | Backoff with jitter; cache results; request higher limit for production. |
| 500 | Internal server error | Unexpected backend failure; includes requestId in response. | Retry with exponential backoff; contact support with requestId if persistent. |
See the full errors reference.
Found an issue? Report documentation feedback