Skip to main content
The DevHelm API uses three pagination patterns depending on the endpoint. All paginated responses include metadata to navigate between pages.

Offset pagination

Most list endpoints use offset pagination with page and size parameters.

Request

Response

Offset endpoints return one of two response shapes: With total count (PageResult):
Without total count (TableValueResult):

Iterating through pages

Cursor pagination

Time-series and append-only data uses cursor pagination for consistent results.

Request

Response

Iterating with cursors

Endpoints using cursor pagination

  • Check results (/api/v1/monitors/{id}/check-results)
  • Service catalog (/api/v1/services)
  • Service poll results
  • Webhook deliveries

Single value responses

Some endpoints return a single item wrapped in a data field:

Sorting

For offset-paginated endpoints that accept sort, pass the field name. Common sortable fields:
  • createdAt — creation timestamp (most common default)
  • name — alphabetical
  • updatedAt — last modified
  • status — resource status
Spring-style multi-sort is supported on some endpoints: sort=name,asc&sort=createdAt,desc.