Pagination

Pagination

All list endpoints return paginated results. The API uses offset-based pagination with consistent query parameters and response shape across every resource.

Query Parameters

Order-specific endpoints (Purchase Orders, Shipping Orders, Work Orders) accept additional parameters:

Order endpoints have a smaller maximum page size of 50 instead of 250.

Response Shape

Every paginated response wraps results in a consistent object:

{
  "value": [
    { "partNo": 1, "shortID": "WIDGET-001", "description": "Standard Widget" },
    { "partNo": 2, "shortID": "GADGET-002", "description": "Premium Gadget" }
  ],
  "totalCount": 847,
  "page": 1,
  "pageSize": 25,
  "pageCount": 34,
  "hasMore": true
}

Response Headers

Paged responses also include these headers for clients that prefer header-based pagination:

Iterating All Pages

To retrieve all records, increment page until hasMore is false:

$page = 1
$allItems = @()

do {
    $response = Invoke-RestMethod -Uri "$baseUrl/Item?page=$page&pageSize=100" `
        -Headers @{ Authorization = "Bearer $token" }
    $allItems += $response.value
    $page++
} while ($response.hasMore)

Write-Host "Retrieved $($allItems.Count) items"

page=1
while true; do
  response=$(curl -s "$BASE_URL/Item?page=$page&pageSize=100" \
    -H "Authorization: Bearer $TOKEN")

  # Process items in .value
  echo "$response" | jq '.value[]'

  has_more=$(echo "$response" | jq '.hasMore')
  if [ "$has_more" = "false" ]; then break; fi
  page=$((page + 1))
done

Sorting

Pass sort with a column name and optionally direction:

GET /Item?sort=shortID&direction=DESC&page=1&pageSize=50

Available sort columns vary by endpoint. Invalid sort columns or directions return HTTP 400 (Invalid sort column or direction.). direction accepts only ASC or DESC (case-insensitive). Check the Swagger documentation on your instance for the sort options each endpoint supports.

Modified Since

Use modifiedSince for incremental sync. Only records with a Modified timestamp on or after your value are returned:

GET /Item?modifiedSince=2026-05-01T00:00:00Z&page=1&pageSize=250

The timestamp should be in ISO 8601 format (UTC recommended). Store the latest Modified value from each sync run and use it as modifiedSince on the next run.

Not all endpoints support modifiedSince. Endpoints backed by entities with a Modified column filter on it; others reject the parameter with HTTP 400 (modifiedSince is not supported on this endpoint.).

Note: On order endpoints (/PurchaseOrder, /ShippingOrder, /WorkOrder), modifiedSince filters on the order header’s Modified timestamp and may not reflect all line-level changes.

Page Size Limits

Requesting a pageSize above the maximum silently caps it at the limit. (The GET /Report/{id}/{count} convenience endpoint is the exception — it clamps count to 1–1000.)