v19

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

Get note field definitions

Returns the schema for the field and relationship definitions available on notes. Useful for understanding the shape of note data before creating or updating records. See <u>Fields and relationships</u> for more details.

Required scope: notes:read

Rate limit category: Read

get/v1/notes/definitions

Headers

Lightfield-Version'2026-03-01' required

Required API version header. Requests may error without it.

Response

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.