GET
/
rules
List
curl --request GET \
  --url https://api.beyondwords.io/v1/rules \
  --header 'X-Api-Key: <api-key>'
[
  {
    "id": 1,
    "key": "CO2",
    "value": "United States of America",
    "type": "Carbon dioxide",
    "project": {
      "id": 1,
      "name": "Test project"
    },
    "content": {
      "id": "d8414aee-4171-419e-be42-bd57e9e2ccd2",
      "title": "Unveiling the Catastrophic Consequences of Excess Carbon Dioxide Emissions"
    },
    "created": "2023-01-01 00:00:00 UTC",
    "updated": "2023-01-01 00:00:05 UTC"
  },
  {
    "id": 2,
    "key": "Ocasio",
    "value": "oʊˈkɑːsi.oʊ",
    "type": "ipa_transcription",
    "created": "2023-01-01 00:00:00 UTC",
    "updated": "2023-01-01 00:00:05 UTC"
  },
  {
    "id": 3,
    "key": "NATO",
    "type": "say_as_word",
    "created": "2023-01-01 00:00:00 UTC",
    "updated": "2023-01-01 00:00:05 UTC"
  },
  {
    "id": 4,
    "key": "IPO",
    "type": "say_as_letter_sequence",
    "created": "2023-01-01 00:00:00 UTC",
    "updated": "2023-01-01 00:00:05 UTC"
  }
]

Authorizations

​
X-Api-Key
string
header
required

Query Parameters

​
pagination[limit]
integer

'limit' sets the number of results to return in each page.

​
pagination[offset]
integer

'offset' sets the first position to return from the results of the query. The default is 0, which starts the page at the first result.

​
order[by]
enum<string>

This is used to order rules by type or key or value

Available options:
type,
key,
value,
created
​
order[dir]
enum<string>

This is used to order analytics in the ascending or descending order

Available options:
asc,
desc
​
filter[type]
string

filter by rule type

​
filter[preview_status]
string

filter by rule preview status

​
filter[key]
string

filter by rule key

​
filter[scopes]
object

filter items by scopes

​
filter[languages][]
string[]

filter by languages

​
filter[voices][]
integer[]

filter by voices

Response

OK

​
id
integer

Unique identifier for the rule

​
project
object | null
​
content
object | null
​
type
enum<string>

The rule type. Possible values are substitute, say_as_word, say_as_letter_sequence, ipa_transcription, pinyin_transcription, jyutping_transcription. Please note that not all voices support all rules

Available options:
substitute,
say_as_word,
say_as_letter_sequence,
ipa_transcription,
pinyin_transcription,
jyutping_transcription
​
preview_status
enum<string>

Status of preview generation for this rule

Available options:
processing,
processed,
error
​
language
object | null
​
preview_voice
object | null
​
preview_audio
object | null
​
key
string

The exact text to match in content when applying this rule

​
value
string | null

Replacement text or phonetic transcription (depending on rule type)

​
magic_ipa_used
boolean

When true, the Magic IPA feature was used to generate the transcription

​
created
string

Time at which the object was created (ISO 8601)

​
updated
string

Time at which the object was updated (ISO 8601)