API Reference

Object

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

List custom object types

$ lightfield object list-definitions

GET/v1/objects

Returns all custom object types available to the caller, sorted alphabetically by objectType.

ReturnsExpand Collapse

object_list_definitions_response: object { data }

data: array of object { label, objectType }

All object types available to the caller.

label: string

Human-readable display name.

objectType: string

The slug used to reference this object type in the API.

List custom object types

CLI Tool

HTTP

TypeScript

Python

Go

CLI Tool

lightfield object list-definitions \
  --api-key 'My API Key'

200 example

{
  "data": [
    {
      "label": "label",
      "objectType": "objectType"
    }
  ]
}

Returns Examples

200 example

{
  "data": [
    {
      "label": "label",
      "objectType": "objectType"
    }
  ]
}