v19

latestOpenAPI 3.1.1raw.githubusercontent.com2026-08-017489931.2 KB

Get definitions for a custom object type

Returns field and relationship definitions for the specified custom object type.

get/v1/objects/{entitySlug}/definitions

entitySlugstring required

The slug of the custom object type.

Lightfield-Version'2026-03-01' required

Required API version header. Requests may error without it.

objectTypestring required

The object type these definitions belong to (e.g. account).

fieldDefinitionsobject required

Map of field keys to their definitions, including both system and custom fields.

relationshipDefinitionsobject required

Map of relationship keys to their definitions.