Skip to content

List custom object types

object.list_definitions() -> ObjectListDefinitionsResponse
GET/v1/objects

Returns all custom object types available to the caller.

ReturnsExpand Collapse
class ObjectListDefinitionsResponse:
data: List[Data]

All object types available to the caller.

label: str

Human-readable display name.

object_type: str

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

List custom object types

from lightfield import Lightfield

client = Lightfield(
    api_key="My API Key",
)
object_list_definitions_response = client.object.list_definitions()
print(object_list_definitions_response.data)
{
  "data": [
    {
      "label": "label",
      "objectType": "objectType"
    }
  ]
}
Returns Examples
{
  "data": [
    {
      "label": "label",
      "objectType": "objectType"
    }
  ]
}