Pagination

Both list endpoints — GET /api/v1/companies and GET /api/v1/offerings — support pagination via two query parameters:

Parameter	Description
`limit`	Maximum number of elements to return
`offset`	Number of elements to skip before the result window

Neither parameter has a spec-defined default or maximum value — if you omit limit or offset, or need to know the effective bounds the server applies, confirm the current server-side behavior directly with Augment; it is not part of the published contract.

Response shape

Every paginated response includes a page_info object alongside the list of results:

Field	Description
`limit`	The `limit` that was applied to this response
`offset`	The `offset` that was applied to this response
`total_count`	Total number of elements matching the request
`has_next`	Whether a following window of results exists

Worked example

Request the second page of 25 companies:

GET /api/v1/companies?limit=25&offset=25
x-api-key: <your-api-key>

Response:

{
  "companies": [ /* ... */ ],
  "page_info": {
    "limit": 25,
    "offset": 25,
    "total_count": 137,
    "has_next": true
  }
}

has_next: true means requesting offset=50 with the same limit returns another page. Keep incrementing offset by limit until has_next is false.

Get Started

Reference

Response shape

Worked example

​Response shape

​Worked example

Response shape

Worked example