Skip to main content

Pagination Scheme Support

What are the changes?​

As part of our strategy of improving the performance and reliability of our APIs, we have identified that some APIs require pagination scheme to fully support large data sets without creating performance issues. In order to do so, we have made critical architectural changes in these APIs.

https://api.qualtrics.com/docs/list-contacts-in-mailing-list https://api.qualtrics.com/docs/list-directory-contacts https://api.qualtrics.com/docs/list-mailing-lists-1

Current input: The default offset for pagination is 0 (that is, start from the beginning of the mailing list). If there are additional pages, the offset value for the next page will be appended to the value of the nextPage parameter in the response.

offset:          integer0

Optional pagination size to determine how many contacts are returned in a single request.

Default: 100,    Minimum: 1,    Maximum: 10000

pageSize:          integer100

Current Response contains:

{
  "nextPage": "https://yourdatacenter.qualtrics.com/API/v3/directories/POOL_012345678901234/mailinglists/CG_012345678901234/contacts?pageSize=2&offset=0"
}

When listing a contacts requires multiple pages to listing them, the second page of the call is requested by providing, the nextPage value returned by the first call. The format of the url returned by this call will replace the offset value with skipToken.

If your automation is already using the value from nextPage to request the following page, this change will not impact you.

However, if your automation is manually constructing the values for requesting the next page, and is manually setting an offset, this will no longer work.

What actions do I need to take?​

Remove the offset parameter, and replace it with skipToken parameter. You should update your API call if you are planning to use these APIs to fully support pagination.

What if I have questions?​

If you have a question about pagination scheme support, please visit the Public API documentation site. It’s also always worth checking the XM Community to see if any other users have the same question. If you’d rather speak to a specialist, our Support Team is always ready to assist. To contact them, please log into your Support Portal