All endpoints that list resources support pagination.

The pagination feature allows you to retrieve a subset of resources from the API. This is useful when you have a large number of resources and you want to retrieve them in smaller chunks. These list API methods share a common set of parameters that allow you to control the number of items returned and the page number. For example, you can:

Parameters

string

default:"1"

The page number to retrieve. By default, the first page is returned.

string

default:"100"

The number of items to retrieve per page. The default value varies by endpoint.

Here is how pagination response data looks like:

{
  "pageInfo": {
    "page": 1,
    "pages": 10,
    "total": 100,
    "pageTotal": 10,
    "hasNextPage": true,
    "hasPrevPage": false
  }
}

Example

The following example demonstrates how to retrieve the first page of 10 links:

curl --request GET \
  --url 'https://api.dock.us/v1/accounts?page=1&limit=10' \
  --header 'Authorization: Bearer <token>'

const options = { method: 'GET', headers: { Authorization: 'Bearer <token>' } };

fetch('https://api.dock.us/v1/accounts?page=1&limit=10', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

import requests

url = "https://api.dock.us/v1/accounts"

querystring = {"page":"1","limit":"10"}

headers = {"Authorization": "Bearer <token>"}

response = requests.request("GET", url, headers=headers, params=querystring)

print(response.text)

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://api.dock.us/v1/accounts?page=1&limit=10"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Getting Started

API Reference

Clients

Workspaces

Library

General

Guides

Pagination

Parameters

Example

​Parameters

​Example

Parameters

Example