Get dictionary content (getdict)

Return all words in a user dictionary.

Return the full wordlist for a dictionary.

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	getdict	Action name.
name	string	Yes		Dictionary name.
format	string	No	json	Some deployments support JSON only.
callback	string	No		JSONP callback name (JSON only).

Behavior

• Returns all words.

• Sorts output alphabetically.

• Removes duplicates.

Response

Returns the full dictionary in wordlist.

See Response format.

Errors

Common errors:

• Dictionary name is missing, invalid, or longer than 50 characters.

See Errors reference.

Examples

Get dictionary content

Request body (JSON):

{
  "cmd": "user_dictionary",
  "action": "getdict",
  "name": "my_dict"
}

Response (JSON):

{
  "name": "my_dict",
  "action": "getdict",
  "wordlist": ["API", "DevOps", "SDK"],
  "modificationTime": 1772124069
}