You are viewing the Resources for the older version of JourneyApps (V3). JourneyApps V4 is the new default for all new apps since July 1, 2016.


The JourneyApps API allows you to integrate or "sync" your own databases or systems with your JourneyApps application. In other words, it allows you to connect one of your own systems to your app in a way that the two can "talk" to each other behind the scenes.

On a technical level, the API takes the form of a HTTP REST API, and uses standard HTTP authentication.


The API documentation is split into sections to make it easier to navigate:

1. Getting Started

Details on enabling the API; which HTTP endpoints to connect to; how to authenticate; what data formats to use, and how to handle errors.

2. Retrieving All Objects

How to use the API to retrieve a list of all objects of a given type in the cloud datastore of one your JourneyApps applications.

3. Creating New Objects

How to use the API to create new objects.

4. Retrieving a Single Object

How to use the API to retrieve a single object.

5. Updating an Object

How to use the API to update a single object.

6. Deleting an Object

How to use the API to delete a single object

7. Queries/Filtering & Searching

How to filter objects that you retrieve from the API (based on criteria); How to search all attributes of a given type.

8. Sorting

Sorting objects retrieved from the API (by attribute, ascending or descending).

9. Counting, Limiting & Skipping

How to limit the number of objects retrieved, and how to skip forward in the set of objects that would be returned.

10. Attribute Representation

Details on how various attribute types are formatted with the JourneyApps API. In other words, the format that you must put data in when creating or deleting objects, and the format you'll receive it in when retrieving objects.

11. Retrieving Photos/Signatures

How to use the API to retrieve photos/signatures (attachments) for an object.

12. Managing Mobile Users

How to use the API to create mobile users, get their enrollment barcodes and reset their enrollment status.

13. Oplog

The JourneyApps API Oplog provides a log of all create, update and delete operations that occurred on the cloud datastore for one of your JourneyApps applications. Polling the Oplog allows you to sync your own database with JourneyApps.

14. Getting an App's Data Model

How to retrieve the Data Model for a particular JourneyApps application, in order to know what the structure of the data is that will be returned by the JourneyApps API.