> ## 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 access policy

> Read how Wordsmith staff may reach your organisation's data.

Returns your organisation's support settings. The defaults are the loosest: one person who may give access decides alone, and nothing else is required.

* `allowed_sign_in_modes`: which kinds of [support member](https://wordsmithai.mintlify.site/api-reference/support-access/list-support-members.md) you allow. Empty allows none, which is the default.
* `approvals`: who must approve a grant.
  * `requester` (the default): a member who manages support access gives access at once.
  * `another_person`: an admin other than the requester approves.
  * `data_owner_and_another`: the data owner and an admin approve. They are different people, and neither is the requester.
* `require_ticket`, `require_justification` and `require_data_owner`: whether every grant needs a ticket, a justification and a data owner. `data_owner_and_another` needs a data owner whatever `require_data_owner` says.
* `max_grant_minutes`: the longest window one grant may cover. `null` means no limit, so a grant may run until revoked.
* `allow_customer_scope`: whether a grant may cover your whole organisation rather than named items.
* `support_role_ids`: the custom roles a grant may use. Empty means no access can be given. A role with administrative permissions is allowed only if you list it.
* `get_support`: whether members may ask for support from an item's share menu. The person asking picks one of `support_role_ids`.
* `get_support_default_role_id`: the role the Get support form picks first. It is always one of `support_role_ids`, or `null` when that list is empty.
* `approval_window_minutes`: how long a request waits for its approvals before it lapses.
* `min_duration_minutes` and `max_duration_minutes`: the range both durations must fall in.

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

## Response

Returns `200` with the policy.

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

```json Response theme={"theme":{"light":"github-light","dark":"github-dark"}}
{
  "allowed_sign_in_modes": [
    "customer_identity"
  ],
  "approvals": "another_person",
  "require_ticket": true,
  "require_justification": true,
  "require_data_owner": false,
  "max_grant_minutes": 480,
  "allow_customer_scope": false,
  "support_role_ids": [
    "72f02d30-2d67-40b0-b5cb-859dbb45d485"
  ],
  "get_support": true,
  "get_support_default_role_id": "72f02d30-2d67-40b0-b5cb-859dbb45d485",
  "approval_window_minutes": 720,
  "min_duration_minutes": 15,
  "max_duration_minutes": 10080
}
```

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