Sort Results
This parameter allows you to specify the order in which objects of a particular type are retrieved.
Relative URL
HTTP Request Method
/api/v4/app-instance-id/objects/model.json?sort[field]=direction
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 field with the desired field name.
  • Replace direction with a value defined below.

Parameters

Sort criteria are specified as a URL-encoded sort hash. Valid keys for this hash are names of the fields in that model. Sort directions can expressed in javascript style - 1 or -1 - or human-readable: asc, ASC, desc or DESC

Response

The response will contain a list of objects sorted by the specified field. The format of the objects is the same as for listing all objects (please refer to the Retrieve all Objects section).

Examples

When using curl with queries you have to either escape the square brackets with a backslash \ or add the -g option to turn off curl's globbing functionality.

Sort order - human readable:

http
GET https://run-testing-us.journeyapps.com/api/v4/533bda53027894f69b001055/objects/tasks.json?sort[updated_at]=desc
curl
curl "https://run-testing-us.journeyapps.com/api/v4/533bda53027894f69b001055/objects/tasks.json?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"}}

Sort order - JavaScript style:

http
GET https://run-testing-us.journeyapps.com/api/v4/533bda53027894f69b001055/objects/tasks.json?sort[updated_at]=-1
curl
curl "https://run-testing-us.journeyapps.com/api/v4/533bda53027894f69b001055/objects/tasks.json?sort[updated_at]=-1" \
-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=>-1}}
Copy link
On this page
Parameters
Response
Examples