Pagination

Requests that return multiple results are paginated to 50 items, with the exception of List Conversation requests, which are paginated to 25 items. The response contains page information and links to fetch the other pages:

 "_links": {
        "self": {
            "href": "https://api.helpscout.net/v2/conversations?page=2"
        },
        "next": {
            "href": "https://api.helpscout.net/v2/conversations?page=3"
        },
        "previous": {
            "href": "https://api.helpscout.net/v2/conversations?page=1"
        },
        "first": {
            "href": "https://api.helpscout.net/v2/conversations?page=1"
        },
        "last": {
            "href": "https://api.helpscout.net/v2/conversations?page=11"
        },
        "page": {
            "href": "https://api.helpscout.net/v2/conversations{?page}",
            "templated": true
        }
    },
    "page": {
        "size": 50,
        "totalElements": 511,
        "totalPages": 11,
        "number": 2
    }

You can use the provided links to navigate through the result set. Please note that not all links will be present every time. For example, there will not be a next link if the end of the result set has been reached.

↑Back to top

Help Scout Developers