Pagination

All list endpoints in the Management API paginate results using the standard limit/offset model. Pagination keeps response sizes predictable and makes it easy to iterate through large collections.

Response Format

Every paginated response follows the same JSON structure:

Paginated response

{
  "count": 22,
  "next": "https://api.foxnose.net/v1/7c9h4pwu/folders/?limit=10&offset=10",
  "previous": null,
  "results": [
    {
      "...": "resource payload"
    }
  ]
}

Name
count
Type
integer
Description
Total number of matching items across all pages.
Name
next
Type
string | null
Description
URL for the next page. The value is null when you are on the last page.
Name
previous
Type
string | null
Description
URL for the previous page. The value is null when you are on the first page.
Name
results
Type
array
Description
Array containing the items for the current page.

Use the next / previous URLs as-is: they already include the correct pagination parameters.

Query Parameters

Name
limit
Type
integer
Description
Maximum number of items per request. Defaults to 100 and cannot exceed 100.
Name
offset
Type
integer
Description
Number of items to skip before returning results. Defaults to 0.

Leaving both parameters empty returns the first page with the default page size.

Requesting a limit greater than 100 automatically falls back to 100 to prevent oversized responses.

Examples

First page (defaults)

curl "https://api.foxnose.net/v1/7c9h4pwu/folders/"

Custom limit and offset

curl "https://api.foxnose.net/v1/7c9h4pwu/folders/?limit=25&offset=50"

This request returns 25 items starting from the 51st record.

Follow the `next` link

curl "https://api.foxnose.net/v1/7c9h4pwu/folders/?limit=25&offset=75"

You typically obtain this URL directly from the previous response:

{
  "count": 22,
  "next": "https://api.foxnose.net/v1/7c9h4pwu/folders/?limit=25&offset=75",
  "previous": null,
  "results": [ ... ]
}

Best Practices

Always rely on next / previous to continue pagination instead of recalculating offsets manually.
Combine pagination with filters or ordering parameters to stay within the 100-item response window.
When syncing data, store the last offset you processed so you can resume if a request fails.
Treat count as informational; it may fluctuate if new items are created or deleted while you page through results.