Listing resources

Pagination

The API lists resources in pages. Depending on the resource, the number of resources-per-page varies. To scroll over results, pass the after parameter in queries.

For example, skills are listed in batches of 20:

Listing skills
$ curl -H "X-Planado-API-Key:XXX" https://api.planadoapp.com/v2/skills | jq
{
  "skills": [
    ..., // 19 skills skipped
    {
      "uuid": "3f5aa459-0a35-414f-9f13-42a044bab354",
      "name": "Fusion splicing"
    }
  ]
}

To see the next results, pass after as a GET-parameter with uuid of the last skill:

Listing next skills
$ curl -H "X-Planado-API-Key:XXX" https://api.planadoapp.com/v2/skills?after=3f5aa459-0a35-414f-9f13-42a044bab354 | jq
{
  "skills": [
    ... // next skills
  ]
}

To retrieve all skills, repeat the process until the API returns an empty list.

Results obtained with after passed are stable, except removed entities. That is requests with the same after value list the same resources.

Results order

Different resources are presented in a different order. Entities used as references like skills, territories, or users are listed from oldest to newest.

Regularly added resources like jobs, clients, and sites go from newest to oldest.