Get an object definition by handle

GET/api/objects/definitions/{handle}

Returns the object definition that matches the provided handle.

Path Parameters

handle*string

Stable handle used in routes and lookups.

Example"projects"

Response Body

`application/json`

curl -X GET "https://example.com/api/objects/definitions/projects"

{  "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,    "presentation": {      "subtitleTemplate": "{opportunity} - {NombreConstructora}",      "subtitleFields": [        "opportunity",        "NombreConstructora"      ],      "searchFields": [        "Name",        "opportunity",        "NombreConstructora",        "id_zoho"      ]    }  }}

{  "_tag": "ApiBadRequestError",  "code": "PRICE_IMPORT_DUPLICATE_SKUS",  "message": "The request payload is invalid.",  "description": "Remove duplicate SKU rows before importing the file.",  "details": null}

{  "_tag": "Unauthorized"}

{  "_tag": "ApiForbiddenError",  "message": "You do not have permission to perform this action."}

{  "_tag": "ApiNotFoundError",  "message": "The requested resource was not found."}

{  "_tag": "ApiConflictError",  "message": "A resource with this handle already exists."}

{  "_tag": "ApiUnprocessableEntityError",  "message": "The order cannot be submitted without items."}

{  "_tag": "ServiceUnavailable"}

{  "_tag": "ApiTimeoutError",  "message": "The upstream operation timed out."}

Get an object definition by handle

Path Parameters

Response Body

200application/json

400application/json

401application/json

403application/json

404application/json

409application/json

422application/json

503application/json

504application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`