Skip to content

List custom object types

$ lightfield object list-definitions
GET/v1/objects

Returns all custom object types available to the caller.

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

lightfield object list-definitions \
  --api-key 'My API Key'
{
  "data": [
    {
      "label": "label",
      "objectType": "objectType"
    }
  ]
}
Returns Examples
{
  "data": [
    {
      "label": "label",
      "objectType": "objectType"
    }
  ]
}