Pagination

Most top-level API resources have support for bulk resource fetches through "list" API methods. The number of resources returned by the API endpoint and the current page of the result can both be sent specified in the query string section, as described:

Query parameters

Name	Type	Description
limit	number default 10	Number of results to be retrieved
page	number default 1	Current page in the result set.

Response

{
  "meta": {
    "current_page": 2,  // tells the current page in the result set
    "next_page": 3,     // optional, present if there are additional resources available
    "prev_page": 1      // optional, present if there is a previous page to go to
  },
  "result": []          // array of resources accessed
}

Example

curl --request GET \
  --url https://partners.clym.io/api/portal/domains?limit=30&page=2 \
  --header 'Authorization: {YOUR_API_KEY}'

{
    "meta": {
        "current_page": 2,
        "next_page": 3,
        "prev_page": 1
    },
    "result": [
        {
            "id": "....."
        }
    ]
}