Limit and Skip

This parameter allows you to control the number of objects that are retrieved in a request.
Relative URL
HTTP Request Method
/api/v4/backend-deployment-id/objects/model.json?limit=x
GET
/api/v4/backend-deployment-id/objects/model.json?limit=x&skip=y
GET
Replace model with the type of object that you wish to retrieve (as defined in your app's Data Model) for example person, job or asset.
Replace x and y with integers.
Parameters
skip and limit parameters are specified as non-negative integer values.
Response
The response will contain a list of objects numbering no more than the limit, and offset by the value of skip. For example, limit=10&skip=10 will skip the first ten objects and return no more than ten objects, i.e. the eleventh through the twentieth.
Examples
BASE-URL
The below examples contain a BASE-URL placeholder. Please refer to the HTTP Endpoints section to get the base URL relevant to your deployment.
Retrieve the 5th page of 10 objects:
HTTP
curl
ruby
GET BASE-URL/api/v4/533bda53027894f69b001055/objects/tasks.json?limit=10&skip=40
curl "BASE-URL/api/v4/533bda53027894f69b001055/objects/tasks.json?limit=10&skip=40" \
    -u "533bda53027894f69b001055:7Ajj5htRY1uzw7b4w23V"
require 'rest-client'
journey = RestClient::Resource.new "BASE-URL/api/v4", "533bda53027894f69b001055", "7Ajj5htRY1uzw7b4w23V"
journey["533bda53027894f69b001055/objects/tasks.json"].get :params => {:limit=>10, :skip=>40}
Retrieve the five most recently modified objects:
HTTP
curl
ruby
GET BASE-URL/api/v4/533bda53027894f69b001055/objects/tasks.json?limit=5&sort[updated_at]=desc
curl "BASE-URL/api/v4/533bda53027894f69b001055/objects/tasks.json?limit=5&sort[updated_at]=desc" \
    -g -u "533bda53027894f69b001055:7Ajj5htRY1uzw7b4w23V"
require 'rest-client'
journey = RestClient::Resource.new "BASE-URL/api/v4", "533bda53027894f69b001055", "7Ajj5htRY1uzw7b4w23V"
journey["533bda53027894f69b001055/objects/tasks.json"].get :params => {:sort=>{:updated_at=>"desc"}, :limit=>5}

Relative URL	HTTP Request Method
`/api/v4/``backend-deployment-id``/objects/``model``.json?limit=``x`	GET
`/api/v4/``backend-deployment-id``/objects/``model``.json?limit=``x``&skip=``y`	GET

Sort Results

Count Objects

Last modified 6mo ago