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

# List all symbols in the vocabulary

> Returns all symbols currently in the NSR Machine's vocabulary, including their IDs, names, and whether they have associated programs…

Returns all symbols currently in the NSR Machine's vocabulary, including
their IDs, names, and whether they have associated programs.
**Example**

```bash theme={null}
curl -X GET 'https://api.nsr.stateset.com/api/v1/nsr/symbols' \
-H 'X-API-Key: your-api-key'
```

**Required scope:** `read`

### Response

`ListSymbolsResponse`

<ResponseField name="symbols" type="SymbolResponse[]" required>
  List of symbols

  <Expandable title="SymbolResponse">
    <ResponseField name="has_program" type="boolean" required>
      Whether the symbol has an associated program
    </ResponseField>

    <ResponseField name="id" type="integer (int64)" required>
      Symbol ID
    </ResponseField>

    <ResponseField name="name" type="string" required>
      Symbol name
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="total" type="integer" required>
  Total count
</ResponseField>

### Status codes

| Code  | Meaning                                            |
| ----- | -------------------------------------------------- |
| `200` | List of all symbols in vocabulary                  |
| `401` | Unauthorized — missing or invalid credentials      |
| `403` | Forbidden — the key/token lacks the required scope |
| `429` | Rate limited — see Retry-After / X-RateLimit-Reset |

<RequestExample>
  ```bash cURL theme={null}
  curl --request GET \
    --url 'https://api.nsr.stateset.com/api/v1/nsr/symbols' \
    --header 'X-API-Key: YOUR_API_KEY'
  ```
</RequestExample>

<ResponseExample>
  ```json 200 theme={null}
  {
    "symbols": [
      {
        "has_program": true,
        "id": 1001,
        "name": "Two-Person Tent"
      }
    ],
    "total": 102
  }
  ```
</ResponseExample>
