> ## 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.

# List support access grants

> List the requests and grants that let Wordsmith engineers see your data.

A support access grant lets one [support member](https://wordsmithai.mintlify.site/api-reference/support-access/list-support-members.md) see named resources for one support ticket and one window. By default a member who manages support access gives it at once. Your [support settings](https://wordsmithai.mintlify.site/api-reference/support-access/get-support-access-policy.md) can instead ask for an admin other than the requester to approve it, or for both the data owner and an admin. Then the approvers are different people, and none of them is whoever raised the request. Newest requests come first.

Approving and rejecting a waiting request are not available through the API or the MCP server. Both need a recent sign-in, which an API key or token cannot prove, so the data owner and an admin decide in the web app, under **Settings > Support access**.

`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 also hold a role with the view support access permission; the predefined admin role holds both. A Wordsmith support member is always refused, whatever role it holds. Support access must be turned on for your organisation.

## Query parameters

**open** `boolean` (default: false)

`true` returns only requests and grants that can still give access: `awaiting_approval`, `scheduled` or `active`.

**cursor** `string`

The `cursor` from the previous page.

**limit** `integer` (default: 50)

Grants per page, up to 200.

## Response

Returns `200` with a page of grants.

```bash cURL theme={"theme":{"light":"github-light","dark":"github-dark"}}
curl "https://api.wordsmith.ai/api/v1/support-access/grants?open=true" \
  -H "Authorization: Bearer sk-ws-api1-your_api_key_here"
```

```json Response theme={"theme":{"light":"github-light","dark":"github-dark"}}
{
  "items": [
    {
      "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": "approved",
      "phase": "active",
      "approvals": [
        {
          "role": "data_owner",
          "user_id": "828b17cf-5f09-4edd-bcba-9d1de130a2e6",
          "approved": true,
          "decided_at": "2026-11-17T09:58:00Z",
          "comment": null
        },
        {
          "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": null,
      "closed_by_wordsmith": false,
      "closed_at": null,
      "close_reason": null
    }
  ],
  "cursor": null
}
```

## Errors

| Status | `error_code` | When |
| - | - | - |
| 403 | `insufficient_scope` | The OAuth token does not hold `directory:admin`. |
| 403 | `forbidden` | The caller lacks the support access permission, is a Wordsmith support member, or support access is off for your organisation. |


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