List data-object definitions

GET

/objects/definitions

GET

/objects/definitions

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

200Retrieved

1 {
2   "definitions": [
3     {
4       "_id": "def_contract",
5       "nameSingular": "contract",
6       "namePlural": "contracts",
7       "labelSingular": "Contract",
8       "labelPlural": "Contracts",
9       "description": "A legal agreement between two or more parties outlining terms and conditions.",
10       "icon": "📄",
11       "color": "#4A90E2",
12       "labelFieldKey": "contractNumber",
13       "fields": [
14         {
15           "contractNumber": {
16             "type": "string",
17             "label": "Contract Number",
18             "required": true,
19             "unique": true
20           }
21         },
22         {
23           "startDate": {
24             "type": "date",
25             "label": "Start Date",
26             "required": true
27           }
28         },
29         {
30           "endDate": {
31             "type": "date",
32             "label": "End Date",
33             "required": false
34           }
35         },
36         {
37           "parties": {
38             "type": "array",
39             "label": "Parties Involved",
40             "items": {
41               "type": "string"
42             }
43           }
44         },
45         {
46           "status": {
47             "type": "string",
48             "label": "Status",
49             "enum": [
50               "draft",
51               "active",
52               "expired",
53               "terminated"
54             ],
55             "default": "draft"
56           }
57         }
58       ],
59       "fieldGroups": [
60         {
61           "general": {
62             "label": "General Information",
63             "fields": [
64               "contractNumber",
65               "startDate",
66               "endDate",
67               "status"
68             ]
69           }
70         },
71         {
72           "participants": {
73             "label": "Parties",
74             "fields": [
75               "parties"
76             ]
77           }
78         }
79       ],
80       "version": 1.1,
81       "archivedAt": "2024-01-15T09:30:00Z",
82       "createdAt": "2023-11-20T14:00:00Z",
83       "updatedAt": "2024-01-10T16:45:00Z",
84       "createdBy": "[email protected]"
85     }
86   ]
87 }

Lists the org-level data-object definitions (the schemas that objects conform to: fields, types, groups, labels). Authorization: any authenticated org member (no role gate). Query: archived — pass true to include soft-archived definitions; omitted or false returns only active ones. Returns { definitions: [...] }; each definition carries _id, nameSingular/namePlural, labels, fields[], fieldGroups[], and version.

Lists the org-level data-object definitions (the schemas that objects conform to: fields, types, groups, labels). Authorization: any authenticated org member (no role gate). Query: `archived` — pass `true` to include soft-archived definitions; omitted or `false` returns only active ones. Returns `{ definitions: [...] }`; each definition carries `_id`, `nameSingular`/`namePlural`, labels, `fields[]`, `fieldGroups[]`, and `version`.

Authentication

AuthorizationBearer

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

Query parameters

archivedenumOptional

Pass true to include soft-archived definitions. Omitted or false returns only active ones.

Allowed values:

Response

The definitions.

definitionslist of objects