Pagination

Livepin APIs are not limited to a single pagination style. Depending on the endpoint, you will use page + limit, offset + limit, or receive non-paginated lists.

Check each endpoint description before implementing list traversal.

Pagination patterns

Common query parameters in the current collection:

Name
page
Type
integer
Description
1-based page index. Seen in admin endpoints.
Name
limit
Type
integer
Description
Maximum items per page.
Name
offset
Type
integer
Description
Start index for cursor-less pagination.
Name
status
Type
string
Description
Additional list filters, for example in support ticket listings.

Example: admin logs (page + limit)

curl -G "$LIVEPIN_API_BASE_URL/api/admin/devices/view-update-logs" \
  -H "Authorization: Bearer $JWT_TOKEN" \
  -d page=1 \
  -d limit=100

Example: dealers (offset + limit)

curl -G "$LIVEPIN_API_BASE_URL/api/dealers/me" \
  -H "Authorization: Bearer $JWT_TOKEN" \
  -d limit=50 \
  -d offset=0 \
  -d query="Home"

Typical response shape

{
  "data": [
    {
      "id": 1
      // ...
    }
  ],
  "meta": {
    "pagination": {
      "page": 1,
      "pageSize": 50,
      "pageCount": 10,
      "total": 500
    }
  }
}

Endpoints that return arrays directly

Some endpoints return plain arrays (for example latest locations). In those cases, pagination parameters may not apply.

Best practices

Default to conservative limit values and increase only when needed.
Stop paginating when no results are returned.
Persist cursors/page state when building sync jobs.