Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: updated "Request Query Parameters" table and geoLevel filter information

...

Parameter NameTypeRequiredDescription
pageNumberIntegerOptional

Page number to be fetched in case of multiple pages.
Its default value is 1.

pageSizeIntegerOptional

Maximum number of rows to be included in the response.
Its default value is 100.

filterStringOptionalFilter the response based on provided criteria (see example below)
sortStringOptionalSort the response by field(s)

Response


Header NameType
Content-type application/json

...

FilterDescription
countryCode

Use to limit the search to a specific country code (ISO 2 characters); for example, filters=countryCode%20eq%20ES.

geoLevel

Use to set the response scope to one of the following:

  • COUNTRY
  • CITY

    • 1 (Country)
    • 2 (Region)
    • 3 (City)
    nameSearch criteria; for example, name%20like%20*spain*.

    ...