Skip to main content
Endpoints that return lists support pagination using limit and offset query parameters.

Parameters

ParameterTypeDefaultConstraintsDescription
limitinteger1001 to 100Maximum number of results to return
offsetinteger00 or greaterNumber of results to skip

Usage

Append limit and offset as query parameters:
# First 25 results
curl "https://assess.ayliea.com/api/v1/recommendations?limit=25" \
  -H "X-API-Key: ayliea_pk_YOUR_API_KEY"

# Next 25 results
curl "https://assess.ayliea.com/api/v1/recommendations?limit=25&offset=25" \
  -H "X-API-Key: ayliea_pk_YOUR_API_KEY"

Paginated endpoints

The following endpoints support pagination:
EndpointPagination applies to
GET /api/v1/recommendationsRecommendation list
GET /api/v1/discoveryDiscovered platforms list
The GET /api/v1/scores endpoint returns one score per framework and does not support pagination.

Validation errors

Invalid pagination parameters return a 400 response:
// limit out of range
{ "error": "limit must be an integer between 1 and 100" }

// negative offset
{ "error": "offset must be a non-negative integer" }

Tips

  • Start with the default limit of 100 and add pagination only if you need smaller pages
  • If you receive fewer results than your limit, you have reached the end of the list
  • Results are ordered by the endpoint’s default sort (e.g., recommendations are sorted by priority ascending, then created date descending)