Support access
Get support record
Get the record of one support engagement: approvals, engineer, access window, actions, data accessed and revocation.
GET
Returns the support record of one support access grant: one document per support engagement, for a vendor-access review.
grantis the grant as Get support access grant returns it: ticket, justification, scope, items, role and window.engineeris the Wordsmith engineer the support member belongs to, andsign_in_modehow that member signs in.requested_by,data_ownerand each approval’sapprovername the people involved.user_idisnullfor a Wordsmith engineer, whose account is not in your organisation.access.outcomesays how the grant stands or ended:awaiting_approval,scheduled,active,lapsed,rejected,expired,revoked,withdrawnorended.access.ended_atis when access stopped.closed_by_wordsmithmeans Wordsmith support management closed it;closed_by_systemmeans Wordsmith revoked it because it no longer held, for example an item moved.activitycomes from your audit log: every event the support member caused under this grant.actionscounts each action,data_accessedlists each item the engineer touched and what they did to it, from successful events only (a refused request stays inevents). The audit log does not record every read, sodata_accessedis what was recorded, not proof that nothing else was opened.eventslists the events in order, withresource_typein the audit log’s vocabulary.event_countis the number of events read.untagged_eventscounts 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_enabledis 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 showtrueand no activity. Events recorded while it was on are always listed.truncatedistruewhen 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_releasedistrueonce the grant can no longer be active and every permission and role it applied is removed.ever_approvedisfalsefor a grant that never got every approval, which gave no access.released_atis when removal was recorded, and can benulleven onceaccess_releasedistrue.outstanding_sharesandrole_assignment_outstandingsay what is still being removed.sessions_startedandsessions_endedcount the act on behalf support sessions the audit log recorded; like every activity field, they cover only what it recorded.markdownis the same record as a Markdown document, ready to keep with your evidence.
support_access.record_downloaded in your audit log.
Authentication
Requires an API key, or an OAuth token withdirectory: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
Response
Returns200 with the record.