JourneyApps API - Docs & Resources

Retrieving All Objects

This function allows you to retrieve a list of all objects of the given type.

Relative URL	HTTP Request Method
/api/v1/object-type.format	GET

Note: Replace object-type 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 format with the response data format (json or xml), or leave it out.

Parameters

This function does not take any parameters.

Response

The response includes a list of all the objects of the given type. Each item in the list represents a single object. Each item contains:

Object ID:	This is a globally unique UUID that is automatically assigned by JourneyApps to each object.
Attributes:	The attributes for the object.
Relationships:	The IDs of related objects that the object belongs to (for your belongs_to relationships) (You can optionally embed the related objects directly — refer to Retrieving Related Objects).
Photo and Signature Attributes:	A `display_attachments` field that includes relative URLs for different sizes of pictures or signatures on the object (refer to the Attribute Representation section for more details).
Display Name:	The display name of the object as defined in the Data Model.
Metadata:	`_updated_at` — a timestamp indicating when last the object was updated by any means (e.g. from mobile device, API, data browser, etc.)

For the format of all the different attribute types, see the Attribute Representation section.

Also take a look at the the example below.

Example

Tip: curl is a command-line tool that allows you to make HTTP requests easily, which is useful for playing around with an API. It usually comes standard on Linux and OS X, and for Windows you can download it here from the official website (choose Win32). The -u parameter in the examples below specify the username and password for authentication (refer to the Enabling the API section).

JSON:

curl https://run-testing.journeyapps.com/api/v1/user.json \
     -u '503c976fd6fb302278000002:RL5xPQJTRQUNtFzC0EKs'

[
  {
    "_updated_at": "2012-08-29T06:46:10Z",
    "name": "Lena Deberon",
    "id": "9a700bdc-f115-11e1-bac8-001cc01904e3",
    "display_name": "Lena Deberon",
    "display_attachments": {
    }
  },
  {
    "_updated_at": "2012-08-29T06:46:17Z",
    "name": "Sara Heandy",
    "id": "3c2db07a-f1a5-11e1-a7df-001cc01904e3",
    "display_name": "Sara Heandy",
    "display_attachments": {
    }
  },
  {
    "_updated_at": "2012-08-29T06:46:38Z",
    "name": "John Brewart",
    "id": "485e0cdc-f1a5-11e1-a7df-001cc01904e3",
    "display_name": "John Brewart",
    "display_attachments": {
    }
  }
]

XML:

curl https://run-testing.journeyapps.com/api/v1/user.xml \
     -u'503c976fd6fb302278000002:RL5xPQJTRQUNtFzC0EKs'

<?xml version="1.0" encoding="UTF-8"?>
<users type="array">
  <user>
    <_updated-at type="datetime">2012-08-29T08:46:10+02:00</_updated-at>
    <name>Lena Deberon</name>
    <id>9a700bdc-f115-11e1-bac8-001cc01904e3</id>
    <display-name>Lena Deberon</display-name>
    <display-attachments>
    </display-attachments>
  </user>
  <user>
    <_updated-at type="datetime">2012-08-29T08:46:17+02:00</_updated-at>
    <name>Sara Heandy</name>
    <id>3c2db07a-f1a5-11e1-a7df-001cc01904e3</id>
    <display-name>Sara Heandy</display-name>
    <display-attachments>
    </display-attachments>
  </user>
  <user>
    <_updated-at type="datetime">2012-08-29T08:46:38+02:00</_updated-at>
    <name>John Brewart</name>
    <id>485e0cdc-f1a5-11e1-a7df-001cc01904e3</id>
    <display-name>John Brewart</display-name>
    <display-attachments>
    </display-attachments>
  </user>
</users>

How do I filter these objects?

To filter the objects that you're retrieving, see the Queries section.

How do I count the number of objects?

See the Counting, Limiting and Skipping section.

Next Section: 3. Creating New Objects