Spelling dictionary API

How to fetch words from the spelling dictionary via API

Andrew Waite avatar
Written by Andrew Waite
Updated over a week ago

This page explains how to use the spelling dictionary API to view the words added to the dictionary.

Get the dictionary

Method: GET

The following query params are optional, but if provided must be valid:

Property

Definition

Example

grouping

String – defines how the results are grouped. Must be one of “report_id”, “word” or “added_by”. The default is “report_id”.

?grouping=report_id

added_since

String – will only return words added after this date. Must be in a valid date format. By default all words will be returned.

?added_since=2022-08-17

Expected response

If successful, you would expect a 200 response, with a body like this:

{ 
"status":"success",
"spellingDictionary": [DICTIONARY DATA]
}

Did this answer your question?