FlexyAPI documentation

Basics

Pagination

Endpoints that return lists return them in pages.

Request a specific page with two query parameters:

ParameterDescription
pageThe page number, starting at 1.
page_sizeHow many results you want per page. Each endpoint has its own default and maximum.

The pagination part of the response looks like this:

{
  "metadata": {
    "count": 42,
    "next_cursor": "https://provider-api.flexy.gr/api/v1/...?page=2",
    "previous_cursor": null,
    "page_size": 20
  },
  "results": [
    // the objects on this page
  ]
}
FieldDescription
metadata.countThe total number of results, across all pages.
metadata.next_cursorThe full URL of the next page, or null on the last page.
metadata.previous_cursorThe full URL of the previous page, or null on the first page.
metadata.page_sizeThe page size.
resultsThe results on this page.