Show / Hide Table of Contents

Pagination

If we retrieve the list of translations and provide no pagination parameters, the first page of 25 items will be returned:

curl -u <api-key>: "https://controller-host:8001/api/v2/translations"

To return the second page of 50 items:

curl -u <api-key>: "https://controller-host:8001/api/v2/translations?page=2&perPage=50"

All top-level resources have a list endpoint that retrieves a set of items of that resource-type. Some resources (language pairs, hosts) return all items in a single call, while the rest (translations, dictionaries, users) return only a page of items at a time.

List endpoints of resources that support pagination return the first page by default, and 25 items per page by default. Both the page number and the page size can be overriden using the optional page and perPage parameters, respectively. Those two values will be returned in the response, as well as two additional fields: totalItems and totalPages, which indicate the total number of items and pages there are, respectively.

In This Page
Back to top