> ## Documentation Index
> Fetch the complete documentation index at: https://wordsmithai.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Get support record

> Get the record of one support engagement: approvals, engineer, access window, actions, data accessed and revocation.

Returns the support record of one [support access grant](https://wordsmithai.mintlify.site/api-reference/support-access/get-support-grant.md): one document per support engagement, for a vendor-access review.

* `grant` is the grant as [Get support access grant](https://wordsmithai.mintlify.site/api-reference/support-access/get-support-grant.md) 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

**grant\_id** `string` *required*

The grant's id.

## Response

Returns `200` with the record.

```bash cURL theme={"theme":{"light":"github-light","dark":"github-dark"}}
curl "https://api.wordsmith.ai/api/v1/support-access/grants/9d4c2b7a-1f3e-4a5b-8c6d-7e8f9a0b1c2d/record" \
  -H "Authorization: Bearer sk-ws-api1-your_api_key_here"
```

```json Response theme={"theme":{"light":"github-light","dark":"github-dark"}}
{
  "generated_at": "2026-11-17T15:00:00Z",
  "grant": {
    "id": "9d4c2b7a-1f3e-4a5b-8c6d-7e8f9a0b1c2d",
    "member_id": "5b0e6f1e-8a43-4f0e-9d0a-3e2c51f8a7b4",
    "requested_by": "4c98ef69-d5ef-4471-a2b8-89ded5b7b121",
    "requested_by_wordsmith": false,
    "ticket_ref": "SUP-1042",
    "ticket_url": "https://support.example.com/tickets/1042",
    "justification": "Reproduce the export failure on the Q3 supplier contracts repository.",
    "data_owner_id": "828b17cf-5f09-4edd-bcba-9d1de130a2e6",
    "scope": "resources",
    "resources": [
      {
        "kind": "repository",
        "id": "0f6a3c1e-2b4d-4e8f-9a1b-3c5d7e9f1a2b",
        "name": "Supplier contracts Q3"
      }
    ],
    "role_id": "72f02d30-2d67-40b0-b5cb-859dbb45d485",
    "starts_at": "2026-11-17T10:00:00Z",
    "ends_at": "2026-11-17T14:00:00Z",
    "separate_approvers": false,
    "required_approvals": ["admin"],
    "requested_at": "2026-11-17T09:55:00Z",
    "approval_expires_at": "2026-11-18T09:55:00Z",
    "status": "revoked",
    "phase": "closed",
    "approvals": [
      {
        "role": "admin",
        "user_id": "1d7e3a52-6b8c-4f9d-a0e1-2b3c4d5e6f70",
        "approved": true,
        "decided_at": "2026-11-17T09:59:00Z",
        "comment": "Approved for the export bug only."
      }
    ],
    "closed_by": "1d7e3a52-6b8c-4f9d-a0e1-2b3c4d5e6f70",
    "closed_by_wordsmith": false,
    "closed_at": "2026-11-17T12:30:00Z",
    "close_reason": "Fix shipped."
  },
  "engineer": { "user_id": null, "name": "Alex Morgan", "email": "alex@wordsmith.ai" },
  "sign_in_mode": "customer_identity",
  "requested_by": { "user_id": "4c98ef69-d5ef-4471-a2b8-89ded5b7b121", "name": "Sam Admin", "email": "sam@example.com" },
  "data_owner": { "user_id": "828b17cf-5f09-4edd-bcba-9d1de130a2e6", "name": "Olive Owner", "email": "olive@example.com" },
  "approvals": [
    {
      "role": "admin",
      "approved": true,
      "decided_at": "2026-11-17T09:59:00Z",
      "approver": { "user_id": "1d7e3a52-6b8c-4f9d-a0e1-2b3c4d5e6f70", "name": "Ada Admin", "email": "ada@example.com" },
      "comment": "Approved for the export bug only."
    }
  ],
  "role_name": "Support engineer",
  "access": {
    "outcome": "revoked",
    "ended_at": "2026-11-17T12:30:00Z",
    "closed_by": { "user_id": "1d7e3a52-6b8c-4f9d-a0e1-2b3c4d5e6f70", "name": "Ada Admin", "email": "ada@example.com" },
    "closed_by_wordsmith": false,
    "closed_by_system": false
  },
  "activity": {
    "audit_log_enabled": true,
    "truncated": false,
    "event_count": 2,
    "untagged_events": 0,
    "engineers": ["Alex Morgan (alex@wordsmith.ai)"],
    "actions": [{ "action": "file.viewed", "count": 2 }],
    "data_accessed": [
      {
        "resource_type": "file",
        "resource_id": "5f1c0e3a-2b4d-4e8f-9a1b-3c5d7e9f1a2b",
        "resource_name": "Supplier agreement.pdf",
        "actions": ["file.viewed"],
        "count": 2,
        "first_at": "2026-11-17T10:05:00Z",
        "last_at": "2026-11-17T10:20:00Z"
      }
    ],
    "events": [
      {
        "occurred_at": "2026-11-17T10:05:00Z",
        "action": "file.viewed",
        "resource_type": "file",
        "resource_id": "5f1c0e3a-2b4d-4e8f-9a1b-3c5d7e9f1a2b",
        "resource_name": "Supplier agreement.pdf",
        "outcome": "succeeded",
        "engineer": "Alex Morgan (alex@wordsmith.ai)"
      }
    ]
  },
  "revocation": {
    "ever_approved": true,
    "access_released": true,
    "released_at": "2026-11-17T12:31:00Z",
    "outstanding_shares": 0,
    "role_assignment_outstanding": false,
    "sessions_started": 0,
    "sessions_ended": 0
  },
  "markdown": "# Wordsmith support record: SUP-1042\n..."
}
```

## Errors

| Status | `error_code` | When |
| - | - | - |
| 403 | `insufficient_scope` | The OAuth token does not hold `directory:admin`. |
| 403 | `forbidden` | The caller lacks the view support access permission, is a Wordsmith support member, or support access is off for your organisation. |
| 404 | `resource_not_found` | No grant in your organisation has this id. |


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.