Skip to main content
GET
/
orgs
/
me
/
workspace-health
cURL
curl --request GET \
  --url https://api.useanima.sh/v1/orgs/me/workspace-health \
  --header 'Authorization: Bearer <token>'
{
  "org": {
    "id": "<string>",
    "name": "<string>",
    "tier": "<string>",
    "signupStatus": "<string>"
  },
  "auth": {
    "agentId": "<string>",
    "scopes": [
      "<string>"
    ]
  },
  "capabilities": {
    "canSendEmail": true,
    "canSendSms": true
  },
  "inventory": {
    "agents": 1,
    "agentsReadyToSend": 1,
    "domains": 1,
    "domainsVerified": 1,
    "phoneNumbers": 1
  },
  "blockers": [
    {
      "code": "<string>",
      "hint": "<string>"
    }
  ]
}

Authorizations

Authorization
string
header
required

JWT Bearer token obtained from authentication. Pass as: Authorization: Bearer

Response

200 - application/json

OK

Per-workspace health summary callable by any authenticated credential

status
enum<string>
required

Overall workspace status. degraded if any blocker is present.

Available options:
ok,
degraded
org
object
required

Organization context

auth
object
required

Credential context — same data Who_Am_I would surface

capabilities
object
required

Cross-cutting send capability summary

inventory
object
required

Inventory counts useful for self-diagnosis

blockers
object[]
required

All currently-blocking conditions; empty array means status:'ok'