Retrieve all Regions

Retrieve a paginated list of all Regions and their details. You can apply filters to narrow down the results based on specific criteria.

Query Params
string

Implemented filter mappings:
status - active or inactive
name - Region's name (e.g. "EMEA")
language - 4 digit code (Language Code ISO (ISO 639-1) and COUNTRY Code ISO (ISO 3166-1))
For example, when you need to find a Region with name "EMEA" you need to run this query
filter=name=EMEA

Condition values have to be escaped if they contain whitespace or operator symbols. To do so, enclose the whole value in double quotation marks
e.g. filter=name="EMEA Region".


The following operators are supported in a filter term


The Equal (=) and Not-Equal (!=) operators can be used together with wildcards to match partial strings. A single asterisk (*) can be placed at the very start or end of a value to match any number of characters there.

Usage Name Description
name=foo* or name="foo"* Starts with Matches any string starting with the value.
name=*foo or name=*"foo" Ends with Matches any string ending with the value.
name=*foo* or name=*"foo"* Like Matches any string containing the value.


integer
Defaults to 1

Specify which page of results to return, one-based i.e. starts from 1

integer
Defaults to 50

specifies the number of items per page

Responses

Language
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json