academyFIVE API icon

academyFIVE API

Interact with academyFIVE API

Actions549

Countries → List countries

AI-generated

Summary

Retrieve a list of countries with optional filtering, sorting, and pagination parameters to tailor the results.

Inputs

  • page(number) — Specify the page number for pagination, starting at 1. Defaults to 1 if omitted.
  • page(size) — Specify the number of results per page for pagination. Defaults to 50 if omitted.
  • filter(id) — Filter the list to include only the country with the specified ID.
  • filter(nameDe) — Filter countries by their German name, supporting SQL wildcard (%) for pattern matching.
  • filter(nameEn) — Filter countries by their English name, supporting SQL wildcard (%) for pattern matching.
  • sort — Define a comma-separated list of fields to sort the results by. Prefix a field with '-' for descending order.

Output shape

a list of country records as a JSON array

The results are returned as JSON objects in an array. Pagination parameters control the page and size of returned results. Filtering and sorting parameters refine the output. Errors during execution can be returned inline if 'Continue On Fail' is enabled, otherwise the node will throw an error to halt execution.

Examples

Example 1: Fetch the first 25 countries sorted by English name ascending

Set 'page[number]' to 1, 'page[size]' to 25, and 'sort' to 'nameEn'.

Links

Discussion