> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://docs.cloudraker.com/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.cloudraker.com/_mcp/server. # List data-object definitions GET https://api.cloudraker.com/objects/definitions 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`. Reference: https://docs.cloudraker.com/api/cloud-raker-api/workspace/data-objects/list-object-definitions ## OpenAPI Specification ```yaml openapi: 3.1.0 info: title: CloudRaker API version: 1.0.0 paths: /objects/definitions: get: operationId: list-object-definitions summary: List data-object definitions description: >- 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`. tags: - dataObjects parameters: - name: archived in: query description: >- Pass `true` to include soft-archived definitions. Omitted or `false` returns only active ones. required: false schema: $ref: '#/components/schemas/ObjectsDefinitionsGetParametersArchived' - name: Authorization in: header description: Bearer authentication required: true schema: type: string responses: '200': description: The definitions. content: application/json: schema: $ref: '#/components/schemas/ObjectDefinitionList' servers: - url: https://api.cloudraker.com description: Production - url: https://api.staging.raker.one description: Staging - url: https://api.dev.raker.one description: Development components: schemas: ObjectsDefinitionsGetParametersArchived: type: string enum: - 'true' - 'false' title: ObjectsDefinitionsGetParametersArchived ObjectDefinition: type: object properties: _id: type: string nameSingular: type: string namePlural: type: string labelSingular: type: string labelPlural: type: string description: type: string icon: type: string color: type: - string - 'null' labelFieldKey: type: string description: Field key whose value is the object’s display label. fields: type: array items: type: object additionalProperties: description: Any type description: >- The type-discriminated field model (13 field types plus composites). Emitted permissively so the resource stays navigable. fieldGroups: type: array items: type: object additionalProperties: description: Any type version: type: number format: double description: Bumps only on a schema-affecting change. archivedAt: type: - string - 'null' format: date-time createdAt: type: string format: date-time updatedAt: type: string format: date-time createdBy: type: string required: - _id - nameSingular - namePlural - labelSingular - labelPlural - description - icon - color - labelFieldKey - fields - fieldGroups - version - archivedAt - createdAt - updatedAt - createdBy title: ObjectDefinition ObjectDefinitionList: type: object properties: definitions: type: array items: $ref: '#/components/schemas/ObjectDefinition' required: - definitions title: ObjectDefinitionList securitySchemes: bearerAuth: type: http scheme: bearer ``` ## Examples **Request** ```json {} ``` **Response** ```json { "definitions": [ { "_id": "def_contract", "nameSingular": "contract", "namePlural": "contracts", "labelSingular": "Contract", "labelPlural": "Contracts", "description": "A legal agreement between two or more parties outlining terms and conditions.", "icon": "📄", "color": "#4A90E2", "labelFieldKey": "contractNumber", "fields": [ { "contractNumber": { "type": "string", "label": "Contract Number", "required": true, "unique": true } }, { "startDate": { "type": "date", "label": "Start Date", "required": true } }, { "endDate": { "type": "date", "label": "End Date", "required": false } }, { "parties": { "type": "array", "label": "Parties Involved", "items": { "type": "string" } } }, { "status": { "type": "string", "label": "Status", "enum": [ "draft", "active", "expired", "terminated" ], "default": "draft" } } ], "fieldGroups": [ { "general": { "label": "General Information", "fields": [ "contractNumber", "startDate", "endDate", "status" ] } }, { "participants": { "label": "Parties", "fields": [ "parties" ] } } ], "version": 1.1, "archivedAt": "2024-01-15T09:30:00Z", "createdAt": "2023-11-20T14:00:00Z", "updatedAt": "2024-01-10T16:45:00Z", "createdBy": "admin@cloudraker.com" } ] } ``` **SDK Code** ```typescript import { CloudRakerClient } from "@cloudraker/api"; async function main() { const client = new CloudRakerClient({ token: "YOUR_TOKEN_HERE", }); await client.dataObjects.listObjectDefinitions({}); } main(); ``` ```python from cloudraker import CloudRaker client = CloudRaker( token="YOUR_TOKEN_HERE", ) client.data_objects.list_object_definitions() ``` ```go package main import ( "fmt" "strings" "net/http" "io" ) func main() { url := "https://api.cloudraker.com/objects/definitions" payload := strings.NewReader("{}") req, _ := http.NewRequest("GET", url, payload) req.Header.Add("Authorization", "Bearer ") req.Header.Add("Content-Type", "application/json") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby require 'uri' require 'net/http' url = URI("https://api.cloudraker.com/objects/definitions") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Get.new(url) request["Authorization"] = 'Bearer ' request["Content-Type"] = 'application/json' request.body = "{}" response = http.request(request) puts response.read_body ``` ```java import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.get("https://api.cloudraker.com/objects/definitions") .header("Authorization", "Bearer ") .header("Content-Type", "application/json") .body("{}") .asString(); ``` ```php request('GET', 'https://api.cloudraker.com/objects/definitions', [ 'body' => '{}', 'headers' => [ 'Authorization' => 'Bearer ', 'Content-Type' => 'application/json', ], ]); echo $response->getBody(); ``` ```csharp using RestSharp; var client = new RestClient("https://api.cloudraker.com/objects/definitions"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Bearer "); request.AddHeader("Content-Type", "application/json"); request.AddParameter("application/json", "{}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let headers = [ "Authorization": "Bearer ", "Content-Type": "application/json" ] let parameters = [] as [String : Any] let postData = JSONSerialization.data(withJSONObject: parameters, options: []) let request = NSMutableURLRequest(url: NSURL(string: "https://api.cloudraker.com/objects/definitions")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "GET" request.allHTTPHeaderFields = headers request.httpBody = postData as Data let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```