ApiAccessArea
- areastringrequired
The portal key, as used in scopes (`occupational-health:*`) and as the first part of event names (`occupational-health.request.submitted`).
Example:occupational-health
- labelstringrequired
The name of the area to show to people.
Example:Occupational Health
- statusstringrequired
Where your client stands: `not_required` (the area is open), `not_requested` (nothing asked yet), `pending` (a request waits for review), `approved` (calls and webhook events work), `rejected` (the last request was not approved) or `revoked` (staff withdrew an earlier approval). The reason for a rejection or a withdrawal is shown to your users in the Hub and in an email, never here.
enum: "not_required" | "not_requested" | "pending" | "approved" | "rejected" | "revoked"Example:approved
- sensitivebooleanrequired
Whether the area needs manual approval. Hub staff choose which areas do, so read it instead of assuming.
Example:true
- decided_atstring | null<date-time>required
When the current state was decided (approval, rejection or withdrawal), in UTC. Null for `not_required`, `not_requested` and `pending`.
Example:2026-11-03T10:15:00Z