Skip to main content
GET
List Countrys

Authorizations

Authorization
string
header
required

API key for authentication. Make sure to include the word apikey, followed by a single space and then your token. Example: apikey 1234_abcdef

Query Parameters

code
string
disabled
boolean
limit
integer

Number of results to return per page. Maximum is 100. Default is 20.

name
string
offset
integer

The initial index from which to return the results.

order_by
enum<string>[]

Ordering of the results.

For ascending sort order use field.asc, for descending sort order use field.desc.

For sorting by multiple parameters write them as comma separated string: client_id.asc,id.desc.

Final stable tiebreak ordering is added except when pk sorting used.

  • code.asc - Code
  • code.desc - Code (descending)
  • zone.asc - Zone
  • zone.desc - Zone (descending)
  • name.asc - Name
  • name.desc - Name (descending)
Available options:
code.asc,
code.desc,
name.asc,
name.desc,
zone.asc,
zone.desc
ordering
enum<string>[]

Ordering of the results.

This field is left for compatibility and can be deprecated in future versions. Use order_by instead.

Default sort order is ascending. Put - before value for descending sort order: -id.

For sorting by multiple parameters write them as comma separated string: -client_id,id.

Final stable tiebreak ordering is added except when pk sorting used.

  • code - Code
  • -code - Code (descending)
  • zone - Zone
  • -zone - Zone (descending)
  • name - Name
  • -name - Name (descending)
Available options:
-code,
-name,
-zone,
code,
name,
zone
zone
enum<string>

Country zone

  • RU - RU
  • EU - EU
  • OTHER - OTHER
Available options:
EU,
OTHER,
RU

Response

Request successful.

count
integer
required
Example:

123

results
object[]
required
next
string<uri> | null
Example:

"http://api.example.org/accounts/?offset=400&limit=100"

previous
string<uri> | null
Example:

"http://api.example.org/accounts/?offset=200&limit=100"