Skip to main content
GET
Returns the support record of one support access grant: one document per support engagement, for a vendor-access review.
  • grant is the grant as Get support access grant returns it: ticket, justification, scope, items, role and window.
  • engineer is the Wordsmith engineer the support member belongs to, and sign_in_mode how that member signs in. requested_by, data_owner and each approval’s approver name the people involved. user_id is null for a Wordsmith engineer, whose account is not in your organisation.
  • access.outcome says how the grant stands or ended: awaiting_approval, scheduled, active, lapsed, rejected, expired, revoked, withdrawn or ended. access.ended_at is when access stopped. closed_by_wordsmith means Wordsmith support management closed it; closed_by_system means Wordsmith revoked it because it no longer held, for example an item moved.
  • activity comes from your audit log: every event the support member caused under this grant. actions counts each action, data_accessed lists each item the engineer touched and what they did to it, from successful events only (a refused request stays in events). The audit log does not record every read, so data_accessed is what was recorded, not proof that nothing else was opened. events lists the events in order, with resource_type in the audit log’s vocabulary. event_count is the number of events read. untagged_events counts the support member’s events in the window that name no grant, such as a sign-in refused after the grant closed; they are not listed. audit_log_enabled is your audit log setting when the record was generated. Activity while the log was off was never recorded, so a record for a grant that ran while it was off can show true and no activity. Events recorded while it was on are always listed. truncated is true when the activity was too large for one record; the lists then hold the latest events, and an audit log export from Settings has the rest.
  • revocation.access_released is true once the grant can no longer be active and every permission and role it applied is removed. ever_approved is false for a grant that never got every approval, which gave no access. released_at is when removal was recorded, and can be null even once access_released is true. outstanding_shares and role_assignment_outstanding say what is still being removed. sessions_started and sessions_ended count the act on behalf support sessions the audit log recorded; like every activity field, they cover only what it recorded.
  • markdown is the same record as a Markdown document, ready to keep with your evidence.
Each call records support_access.record_downloaded in your audit log.

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; unlike the grant itself, the data owner and the requester need it too. 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 record.

Errors