Skip to main content

Pagination

Pagination is handled similarly across different resources.

Query parameters​

When retrieving lists of objects (keys, DIDs, credential schemas, and others), optionally pass two different query parameters to control what is returned and how: page and pageSize.

  • Passing a page value returns a specific page of the results. The first page is 0.
  • Passing a pageSize value controls how many items appear on each page. The default value for the Desk API is 30. For the Core API, a value must be specified.

Returned values​

When lists are returned, there are two pagination-related values returned: totalItems and totalPages.

  • The totalItems value is the total number of the associated items.
  • The totalPages value is the total number of pages the list has.