List dictionaries (getdicts)

List dictionaries or fetch metadata for specific IDs.

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.

getdicts returns metadata only.

Use getwords to fetch the word list.

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

{
  "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.

Notes and edge cases

• count is the number of words.

• Use state=false dictionaries as a “soft delete”.