Pagination

API Fundamentals

Pagination

LCE query models commonly use zero-based page indexes. Send pageIndex and pageSize in the JSON request body, then use the response counts to decide whether another page is required.

Pagination fields

pageIndex

Zero-based index of the requested page. The first page is 0, not 1.

pageSize

Maximum number of records requested for a single page.

Response counts

resultCount, totalCount and, where supplied, currentPageIndex.

Request a page

curl --request POST \
  --url "$LCE_BASE_URL/metadata/query/languages" \
  --header "Authorization: Bearer $LCE_TOKEN" \
  --header "Content-Type: application/json" \
  --data '{
    "tenantId": 1,
    "pageIndex": 0,
    "pageSize": 50,
    "sorting": "FieldName ASC"
  }'

Replace the sorting placeholder.FieldName ASC illustrates the documented sorting format. Use an actual field supported by the selected operation. Stable ordering reduces the chance of missing or repeating records while moving through pages.

Continue until the collection is complete

let pageIndex = 0;
const pageSize = 50;
const records = [];

while (true) {
  const response = await queryLanguages({ pageIndex, pageSize });
  const page = response.result ?? [];

  records.push(...page);

  if (page.length === 0) break;
  if (
    Number.isFinite(response.totalCount) &&
    records.length >= response.totalCount
  ) break;

  pageIndex += 1;
}

If totalCount is not populated by the selected operation, stop when the service returns fewer records than pageSize or an empty result.

Pagination practices

Start with pageIndex: 0
Use a moderate page size
Keep filters constant between pages
Use stable, supported sorting
Process each page before requesting the next
Record progress for resumable exports
Stop on an empty result
Protect batch jobs with timeouts

Maximum page size is operation-specific.The shared model describes pageSize but does not publish one platform-wide maximum. Do not assume that a size accepted by one service is valid for every service.