List

get

https://api.beyondwords.io/v1/rules

Lists rules in a organization

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

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]

string

enum

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

Allowed:

order[dir]

string

enum

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

Allowed:

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][]

array of strings

filter by languages

filter[languages][]

filter[voices][]

array of integers

filter by voices

filter[voices][]

Responses

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK

401Invalid authentication token