> For the complete documentation index, see [llms.txt](https://docs.wproofreader.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.wproofreader.com/v6.12.0/api-reference/custom-dictionary-api/actions/list-dictionaries-getdicts.md).

# List dictionaries (getdicts)

Returns dictionary **metadata**.

It does not include the wordlist.

### What it does

* Lists all dictionaries if `id` is omitted.
* Filters to specific dictionaries when `id` is provided.
* Returns one `result[]` element per dictionary.

{% hint style="info" %}
`getdicts` returns metadata only.

Use `getwords` to fetch the word list.
{% endhint %}

### Required parameters

| Parameter | Type   | Notes               |
| --------- | ------ | ------------------- |
| `cmd`     | string | `custom_dictionary` |
| `action`  | string | `getdicts`          |

### Optional parameters

| Parameter  | Type                                | Notes                                |
| ---------- | ----------------------------------- | ------------------------------------ |
| `id`       | integer or comma-separated integers | If omitted, returns all dictionaries |
| `format`   | string                              | `json` (default) or `xml`            |
| `callback` | string                              | JSONP wrapper (JSON only)            |

### Request example (all dictionaries)

```
cmd=custom_dictionary&action=getdicts
```

### Request example (filter by ID)

```
cmd=custom_dictionary&action=getdicts&id=101565,101566
```

### Response example

```json
{
  "result": [
    {
      "id": 101565,
      "lang": "en_US",
      "description": "Engineering terms",
      "count": 3,
      "state": true,
      "status": "success",
      "message": ["Dictionaries extracted."]
    },
    {
      "id": 101566,
      "lang": "en_US",
      "description": "Brand names",
      "count": 12,
      "state": false,
      "status": "success",
      "message": ["Dictionaries extracted."]
    }
  ]
}
```

### Possible errors

* `getdicts` can return HTTP 404 when no dictionaries exist.

See [Errors reference](/v6.12.0/api-reference/custom-dictionary-api/errors-reference.md).

### Notes and edge cases

* `count` is the number of words.
* Use `state=false` dictionaries as a “soft delete”.