Retrieve All Objects
Last updated
Last updated
/api/v4/
backend-deployment-id
/objects/
model
.json
GET
This function does not take any parameters.
The response includes a list of up to 1000 objects of the given type, as well as pagination data. Each item in the list represents a single object. Each item contains:
id
type
The name of the model for the object.
updated_at
A timestamp indicating when last the object on the server was updated by any means (e.g. from mobile device, API, data browser, etc.).
display
The display label for the object, as defined in the data model.
Fields
Relationships
Pagination data (see the and section for more details):
count
The number of objects in the response.
total
The total number of objects matched by the query.
more
true
if there are more remaining objects.
Also, take a look at the example below.
Sample request:
Sample response:
To filter the objects that you are retrieving, see the Querying Objects section.
See the Counting, Limiting and Skipping section.
This is a globally unique that is automatically assigned by JourneyApps to each object.
All the fields included in the object, including attachments. For the format of all the different field types, see the section.
The IDs of related objects that the object belongs to (for your relationships).
You can optionally embed the related objects directly — refer to .
The below examples contain a BASE-URL
placeholder. Please refer to the section to get the base URL relevant to your deployment.
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 from the official website (choose *Win32*). The -u
parameter in the examples below specify the username and password for authentication (refer to the section).