Pagination and Sorting

List endpoints use offset pagination. Not every endpoint supports every sort field, so check the endpoint reference before building a query.

Pagination parameters

ParameterTypeRequiredDefaultDescription
limitnumberNo100Maximum number of records to return.
offsetnumberNo0Number of records to skip.

Sorting parameters

ParameterTypeRequiredDefaultDescription
sortenumNonameField used for sorting. Supported values depend on the endpoint.
directionenumNoascSort direction, `asc` or `desc`.

Example

bash
curl "https://api.geodash.pl/api/v1/gminy?limit=25&offset=50&sort=name&direction=asc"

Filtering

Administrative list endpoints support relationship filters such as wojewodztwo, wojewodztwo_id, powiat, powiat_id and admin_unit. Search endpoints use a simpler q parameter.