List objects of a definition in a space

GET

/spaces/:spaceId/objects/:definitionId

GET

/spaces/:spaceId/objects/:definitionId

$ curl https://api.cloudraker.com/spaces/spaceId/objects/definitionId \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json"

1 {
2   "objects": [
3     {
4       "_id": "a3f1c9d2-7b4e-4f8a-9c3d-2e5b7f1a9d8c",
5       "spaceId": "space_987654321",
6       "definitionId": "def_123456789",
7       "definitionVersion": 2,
8       "data": {
9         "firstName": "Alice",
10         "lastName": "Johnson",
11         "email": "[email protected]",
12         "status": "active",
13         "signupDate": "2023-11-20"
14       },
15       "fieldMeta": {
16         "email": {
17           "modifiedBy": "user_456",
18           "modifiedAt": "2024-01-10T14:22:00Z",
19           "source": "user_input",
20           "locked": false
21         },
22         "status": {
23           "modifiedBy": "user_789",
24           "modifiedAt": "2024-01-12T09:15:00Z",
25           "source": "system_update",
26           "locked": true
27         }
28       },
29       "createdAt": "2023-11-20T08:00:00Z",
30       "updatedAt": "2024-01-15T09:30:00Z",
31       "createdBy": "user_123",
32       "updatedBy": "user_789",
33       "deletedAt": null,
34       "provenance": {
35         "email": [
36           {
37             "sourceUrl": "https://signup.example.com/form/123",
38             "extractedAt": "2023-11-20T08:01:00Z"
39           }
40         ]
41       },
42       "review": {
43         "email": {
44           "status": "approved",
45           "by": "reviewer_001",
46           "at": "2023-11-21T10:00:00Z",
47           "note": "Verified email address"
48         }
49       },
50       "origin": {
51         "actionRunId": "actionrun_20240115_001",
52         "playbookRunId": "playbookrun_20240115_007"
53       }
54     }
55   ],
56   "nextOffset": 50
57 }

Lists the objects (records) of a definition within a space. Authorization: requires space:read on :spaceId — a caller who lacks it gets 404 (leak-guard, not 403). Query params: filter — a JSON array of filter entries ({ fieldKey, subField?, operand, value }, 14 operands); sort — a JSON array of sort entries ({ fieldKey, direction: asc|desc }); view — a saved-view id whose stored filters/sorts are applied instead, mutually exclusive with filter/sort (400 invalid_request); limit (1–200, default 50) and offset (default 0) for pagination. Default sort is createdAt desc. Unknown/archived field or a $-injection in filter/sort → 422; an unknown/wrong-scope view → 404 view_not_found. Returns { objects, nextOffset } — nextOffset is the offset of the next page or null when exhausted; each object carries inline data, fieldMeta, (when AI-imported) provenance/review, and (when produced by an action run) an origin { actionRunId?, playbookRunId? }.

Lists the objects (records) of a definition within a space. Authorization: requires `space:read` on `:spaceId` — a caller who lacks it gets **404** (leak-guard, not 403). Query params: `filter` — a JSON array of filter entries (`{ fieldKey, subField?, operand, value }`, 14 operands); `sort` — a JSON array of sort entries (`{ fieldKey, direction: asc|desc }`); `view` — a saved-view id whose stored filters/sorts are applied instead, **mutually exclusive with `filter`/`sort`** (400 `invalid_request`); `limit` (1–200, default 50) and `offset` (default 0) for pagination. Default sort is `createdAt` desc. Unknown/archived field or a `$`-injection in filter/sort → 422; an unknown/wrong-scope `view` → 404 `view_not_found`. Returns `{ objects, nextOffset }` — `nextOffset` is the offset of the next page or `null` when exhausted; each object carries inline `data`, `fieldMeta`, (when AI-imported) `provenance`/`review`, and (when produced by an action run) an `origin` `{ actionRunId?, playbookRunId? }`.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

spaceIdstringRequired

definitionIdstringRequired

Query parameters

filterstringOptional

Ad-hoc filter: a JSON array of { fieldKey, subField?, operand, value } entries.

sortstringOptional

Ad-hoc sort: a JSON array of { fieldKey, direction } entries.

viewstringOptional

A saved-view id whose stored filters and sorts are applied instead. Mutually exclusive with filter and sort.

limitintegerOptional1-200Defaults to 50

Page size, 1–200. Defaults to 50.

offsetintegerOptional>=0Defaults to 0

Row offset. Defaults to 0.

Response

A page of objects.

objectslist of objects

nextOffsetdouble or null

Offset of the next page, or null when the list is exhausted.

Errors

400

Bad Request Error

404

Not Found Error

422

Unprocessable Entity Error