List dictionaries (getdicts)

Return the names of all user dictionaries.

Return the names of all user dictionaries.

An access key is required for this action. See Access key.

Parameters

These parameters work with any cmd.

Name	Type	Required	Description
serviceid	string	Cloud only	Cloud API key. Required for Cloud requests. Not used on-premises.
format	string	No	Response format. Values: json (default), xml.
callback	string	No	JSONP wrapper function name. Use only with format=json.
short_answer	boolean	No	JSON only. When true, shortens JSON keys to reduce payload size. See boolean parameters.

See Overview for details.

Command specific parameters

Parameter	Type	Required	Default	Notes
cmd	string	Yes	user_dictionary	Command name.
action	string	Yes	getdicts	Action name.
access_key	string	Yes		Access key that authorizes this request.

Behavior

• Returns dictionary names only.

• Returns up to 1000 names per request.

• Adds a warning field when more dictionaries exist.

getdicts doesn't return the words.

Use getdict to fetch the wordlist of a dictionary.

Response

getdicts uses its own structure. See Response format for the structure that the other actions return.

Field	Type (JSON)	Notes
action	string	Executed action name.
dictionaries	string[]	Dictionary names.
warning	string	Present only when the API truncates the response.

Errors

Common errors:

• access_key is missing or invalid.

See Errors reference.

Examples

List all dictionaries

Request body (JSON):

{
  "cmd": "user_dictionary",
  "action": "getdicts",
  "access_key": "<your-access-key>"
}

Response (JSON):

{
  "action": "getdicts",
  "dictionaries": ["my_dict_1", "my_dict_2"]
}

List all dictionaries in XML

Request body (JSON):

{
  "cmd": "user_dictionary",
  "action": "getdicts",
  "access_key": "<your-access-key>",
  "format": "xml"
}

Response (XML):

<user_dictionary>
  <action>getdicts</action>
  <dictionaries>
    <dictionary>my_dict_1</dictionary>
    <dictionary>my_dict_2</dictionary>
  </dictionaries>
</user_dictionary>

Truncated response

When you have more than 1000 dictionaries, the API returns the first 1000 names and adds a warning.

Response (JSON):

{
  "action": "getdicts",
  "dictionaries": ["my_dict_1", "my_dict_2"],
  "warning": "Only the first 1000 dictionaries are returned. Delete the unused ones to see the rest."
}

To see the rest, delete the dictionaries that you no longer use.