Retrieve All Objects
/api/v4/
backend-deployment-id
/objects/
model
.json
GET
Parameters
This function does not take any parameters.
Response
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
This is a globally unique UUID that is automatically assigned by JourneyApps to each object.
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
All the fields included in the object, including attachments. For the format of all the different field types, see the Field Representation section.
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 Retrieve a Single Object.
Pagination data (see the Counting and Limiting and Skipping 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.
Example
Sample request:
GET BASE-URL/api/v4/533bda53027894f69b001055/objects/task.json
Sample response:
{
"objects": [
{
"id": "42059e2e-d2a2-11e3-a9f3-001e6733fe3c",
"type": "task",
"updated_at": "2015-02-05T08:17:01Z",
"display": "Wash Dishes",
"name": "Wash Dishes",
"instructions": "",
"status": {
"key": 0,
"display": "Open"
},
"category_id": "71fafc16-ba4f-11e3-8de0-001e6733fe3c"
},
{
"id": "c3d3db52-ba4a-11e3-a567-001e6733fe3c",
"type": "task",
"updated_at": "2015-02-05T08:17:41Z",
"display": "Do Laundry",
"name": "Do Laundry",
"instructions": "Separate light and dark colors",
"status": {
"key": 1,
"display": "Closed"
},
"category_id": "71fafc16-ba4f-11e3-8de0-001e6733fe3c"
},
{
"id": "c3d59ff0-ba4a-11e3-a567-001e6733fe3c",
"type": "task",
"updated_at": "2015-02-05T08:17:58Z",
"display": "Buy Groceries",
"name": "Buy Groceries",
"instructions": "Not too much",
"status": {
"key": 1,
"display": "Closed"
},
"category_id": "71fafc16-ba4f-11e3-8de0-001e6733fe3c"
}
],
"count": 3,
"total": 3,
"more": false
}
FAQs
How do I filter these objects?
To filter the objects that you are retrieving, see the Querying Objects section.
How do I count the number of objects?
See the Counting, Limiting and Skipping section.
Last updated