Pagination

All top-level API resources have support for pagination. For example, you can list projects, clients, and messages. These API methods share a common structure, taking optional pagination parameters: per_page, and page.

Example request

GET /v1/projects?per_page=20&page=1

curl 'https://{workspace}.kitchen.co/api/v1/projects?per_page=20&page=1'
 -H 'Accept: application/json'
 -H 'Authorization: Bearer {AUTH_TOKEN}'
1
2
3

Parameters

per_page int

Number of results to be returned, default is 20. This value must be between 1 and 100.


page int

The number of the page to be returned.


Response

{
    "data": [
        {
        },
    ],
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "path": "https://{workspace}.kitchen.co/api/v1/projects",
        "per_page": 20,
        "to": 17,
        "total": 17
    }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15