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/app-instance-id/objects/model.json?limit=x
GET
/api/v4/app-instance-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 the 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 twentieth.

Examples

Retrieve the 5th page of 10 objects:

html
GET https://run-testing-us.journeyapps.com/api/v4/533bda53027894f69b001055/objects/tasks.json?limit=10&skip=40
curl
curl "https://run-testing-us.journeyapps.com/api/v4/533bda53027894f69b001055/objects/tasks.json?limit=10&skip=40" \
-u "533bda53027894f69b001055:7Ajj5htRY1uzw7b4w23V"
ruby
require 'rest-client'
journey = RestClient::Resource.new "https://run-testing-us.journeyapps.com/api/v4", "533bda53027894f69b001055", "7Ajj5htRY1uzw7b4w23V"
journey["533bda53027894f69b001055/objects/tasks.json"].get :params => {:limit=>10, :skip=>40}

Retrieve the five most recently modified objects:

html
GET https://run-testing-us.journeyapps.com/api/v4/533bda53027894f69b001055/objects/tasks.json?limit=5&sort[updated_at]=desc
curl
curl "https://run-testing-us.journeyapps.com/api/v4/533bda53027894f69b001055/objects/tasks.json?limit=5&sort[updated_at]=desc" \
-g -u "533bda53027894f69b001055:7Ajj5htRY1uzw7b4w23V"
ruby
require 'rest-client'
journey = RestClient::Resource.new "https://run-testing-us.journeyapps.com/api/v4", "533bda53027894f69b001055", "7Ajj5htRY1uzw7b4w23V"
journey["533bda53027894f69b001055/objects/tasks.json"].get :params => {:sort=>{:updated_at=>"desc"}, :limit=>5}
Copy link
On this page
Parameters
Response
Examples