Paginating with limits and offsets

From DreamFactory
Jump to: navigation, search
DreamFactoryTutorialsPaginating with limits and offsets

Use limit and offset parameters to paginate records in a GET request. Try these examples in the 'API Docs' tab of the DreamFactory Admin Console or from the command line with cURL.

Note that offset i returns record i+1 as the first record in the set (for example, offset = 0 returns record 1 as the first record in the set, offset =10 returns record 11 as the first record in the set, and so forth).

API Endpoint

GET https://{url}/api/v2/{api_name}/_table/{table_name}?limit={record_limit}&offset={offset_number}

API Docs Screenshot

Swagger-limit.png
Swagger-offset.png

Example - GET the first set of ten contact records (records 1 through 10, inclusive)

  • Table name: contact
  • Limit parameter in API call:
    10
  • Offset parameter in API call:
    0
  • Request URL:
    https://foo.com/api/v2/db/_table/contact?limit=10&offset=0

Example - GET the second set of ten contact records (records 11 through 20, inclusive)

  • Table name: contact
  • Limit parameter in API call:
    10
  • Offset parameter in API call:
    10
  • Request URL:
    https://foo.com/api/v2/db/_table/contact?limit=10&offset=10