Get an optional object definition by handle

GET/api/unstable/objects/definitions/{handle}/optional

Returns the object definition for a handle or null when it does not exist.

Response Body

`application/json`

curl -X GET "https://loading/api/unstable/objects/definitions/{handle}/optional"

{
  "id": "objdef_123",
  "name": "Projects",
  "handle": "projects",
  "description": "Projects tracked by the sales team.",
  "workspaceId": "ws_123",
  "createdAt": "2026-03-10T12:00:00.000Z",
  "updatedAt": "2026-03-10T12:05:00.000Z",
  "data": {
    "fields": [
      {
        "name": "name",
        "type": "text"
      }
    ],
    "objectNameHandle": "name",
    "pinned": true,
    "columnConfig": [
      {
        "key": "name",
        "visible": true
      }
    ],
    "titleColumn": "name",
    "activityEnabled": true
  }
}

{
  "issues": [
    {
      "_tag": "Pointer",
      "path": [
        "string"
      ],
      "message": "string"
    }
  ],
  "message": "string",
  "_tag": "HttpApiDecodeError"
}

Empty

{
  "message": "string",
  "_tag": "ApiForbiddenError"
}

{
  "message": "string",
  "_tag": "ApiNotFoundError"
}

{
  "message": "string",
  "_tag": "ApiConflictError"
}

{
  "message": "string",
  "_tag": "ApiUnprocessableEntityError"
}

Empty

{
  "message": "string",
  "_tag": "ApiTimeoutError"
}

Get an optional object definition by handle

Response Body

200application/json

400application/json

401

403application/json

404application/json

409application/json

422application/json

503

504application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`