Skip to main content
GET
Returns one support access grant. Its data owner and whoever requested it can read it without the view permission. scope is resources (the role applies on the listed resources only) or organisation (across your organisation). ends_at is null for access until revoked. required_approvals lists the approvals the grant needs: admin, or data_owner and admin when your support settings ask for the data owner’s approval. separate_approvers says whether each approver must be someone other than the requester and the other approver. It is false when your support settings had approvals: requester. Both are fixed from your support settings when the grant is created. phase says where the grant is now, worked out from status and the clock: awaiting_approval, lapsed (not approved in time), scheduled, active, expired or closed. A grant gives access only while it is active, and it expires on time without anyone acting. requested_by is null when a Wordsmith engineer raised the request (requested_by_wordsmith), because their account is not in your organisation. closed_by is null while the grant is open, and when Wordsmith support management closed it (closed_by_wordsmith).

Authentication

Requires an API key, or an OAuth token with directory:admin. directory:admin is never granted by default. The caller must hold a role with the view support access permission, or be the grant’s data owner or the member who requested it. A Wordsmith support member is always refused, whatever role it holds. Support access must be turned on for your organisation.

Path parameters

string
required
The grant’s id.

Response

Returns 200 with the grant.

Errors