## Get note field definitions

`client.Note.Definitions(ctx) (*NoteDefinitionsResponse, error)`

**get** `/v1/notes/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](/using-the-api/fields-and-relationships/)</u> for more details.

**[Required scope](/using-the-api/scopes/):** `notes:read`

**[Rate limit category](/using-the-api/rate-limits/):** Read

### Returns

- `type NoteDefinitionsResponse struct{…}`

  - `FieldDefinitions map[string, NoteDefinitionsResponseFieldDefinition]`

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

    - `Description string`

      Description of the field, or null.

    - `Label string`

      Human-readable display name of the field.

    - `TypeConfiguration NoteDefinitionsResponseFieldDefinitionTypeConfiguration`

      Type-specific configuration (e.g. select options, currency code).

      - `Currency string`

        ISO 4217 3-letter currency code.

      - `HandleService string`

        Social platform associated with this handle field.

        - `const NoteDefinitionsResponseFieldDefinitionTypeConfigurationHandleServiceTwitter NoteDefinitionsResponseFieldDefinitionTypeConfigurationHandleService = "TWITTER"`

        - `const NoteDefinitionsResponseFieldDefinitionTypeConfigurationHandleServiceLinkedin NoteDefinitionsResponseFieldDefinitionTypeConfigurationHandleService = "LINKEDIN"`

        - `const NoteDefinitionsResponseFieldDefinitionTypeConfigurationHandleServiceFacebook NoteDefinitionsResponseFieldDefinitionTypeConfigurationHandleService = "FACEBOOK"`

        - `const NoteDefinitionsResponseFieldDefinitionTypeConfigurationHandleServiceInstagram NoteDefinitionsResponseFieldDefinitionTypeConfigurationHandleService = "INSTAGRAM"`

      - `MultipleValues bool`

        Whether this field accepts multiple values.

      - `Options []NoteDefinitionsResponseFieldDefinitionTypeConfigurationOption`

        Available options for select fields.

        - `ID string`

          Unique identifier of the select option.

        - `Label string`

          Human-readable display name of the option.

        - `Description string`

          Description of the option, or null.

      - `Unique bool`

        Whether values for this field must be unique.

    - `ValueType string`

      Data type of the field.

      - `const NoteDefinitionsResponseFieldDefinitionValueTypeAddress NoteDefinitionsResponseFieldDefinitionValueType = "ADDRESS"`

      - `const NoteDefinitionsResponseFieldDefinitionValueTypeCheckbox NoteDefinitionsResponseFieldDefinitionValueType = "CHECKBOX"`

      - `const NoteDefinitionsResponseFieldDefinitionValueTypeCurrency NoteDefinitionsResponseFieldDefinitionValueType = "CURRENCY"`

      - `const NoteDefinitionsResponseFieldDefinitionValueTypeDatetime NoteDefinitionsResponseFieldDefinitionValueType = "DATETIME"`

      - `const NoteDefinitionsResponseFieldDefinitionValueTypeEmail NoteDefinitionsResponseFieldDefinitionValueType = "EMAIL"`

      - `const NoteDefinitionsResponseFieldDefinitionValueTypeFullName NoteDefinitionsResponseFieldDefinitionValueType = "FULL_NAME"`

      - `const NoteDefinitionsResponseFieldDefinitionValueTypeMarkdown NoteDefinitionsResponseFieldDefinitionValueType = "MARKDOWN"`

      - `const NoteDefinitionsResponseFieldDefinitionValueTypeMultiSelect NoteDefinitionsResponseFieldDefinitionValueType = "MULTI_SELECT"`

      - `const NoteDefinitionsResponseFieldDefinitionValueTypeNumber NoteDefinitionsResponseFieldDefinitionValueType = "NUMBER"`

      - `const NoteDefinitionsResponseFieldDefinitionValueTypeSingleSelect NoteDefinitionsResponseFieldDefinitionValueType = "SINGLE_SELECT"`

      - `const NoteDefinitionsResponseFieldDefinitionValueTypeSocialHandle NoteDefinitionsResponseFieldDefinitionValueType = "SOCIAL_HANDLE"`

      - `const NoteDefinitionsResponseFieldDefinitionValueTypeTelephone NoteDefinitionsResponseFieldDefinitionValueType = "TELEPHONE"`

      - `const NoteDefinitionsResponseFieldDefinitionValueTypeText NoteDefinitionsResponseFieldDefinitionValueType = "TEXT"`

      - `const NoteDefinitionsResponseFieldDefinitionValueTypeURL NoteDefinitionsResponseFieldDefinitionValueType = "URL"`

      - `const NoteDefinitionsResponseFieldDefinitionValueTypeHTML NoteDefinitionsResponseFieldDefinitionValueType = "HTML"`

    - `ID string`

      Unique identifier of the field definition.

    - `ReadOnly bool`

      `true` for fields that are not writable via the API (e.g. AI-generated summaries). `false` or absent for writable fields.

  - `ObjectType string`

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

  - `RelationshipDefinitions map[string, NoteDefinitionsResponseRelationshipDefinition]`

    Map of relationship keys to their definitions.

    - `Cardinality string`

      Whether this is a `has_one` or `has_many` relationship.

      - `const NoteDefinitionsResponseRelationshipDefinitionCardinalityHasOne NoteDefinitionsResponseRelationshipDefinitionCardinality = "HAS_ONE"`

      - `const NoteDefinitionsResponseRelationshipDefinitionCardinalityHasMany NoteDefinitionsResponseRelationshipDefinitionCardinality = "HAS_MANY"`

    - `Description string`

      Description of the relationship, or null.

    - `Label string`

      Human-readable display name of the relationship.

    - `ObjectType string`

      The type of the related object (e.g. `account`, `contact`).

    - `ID string`

      Unique identifier of the relationship definition.

### Example

```go
package main

import (
  "context"
  "fmt"

  "github.com/Lightfld/lightfield-go"
  "github.com/Lightfld/lightfield-go/option"
)

func main() {
  client := githubcomlightfldlightfieldgo.NewClient(
    option.WithAPIKey("My API Key"),
  )
  noteDefinitionsResponse, err := client.Note.Definitions(context.TODO())
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", noteDefinitionsResponse.FieldDefinitions)
}
```

#### Response

```json
{
  "fieldDefinitions": {
    "foo": {
      "description": "description",
      "label": "label",
      "typeConfiguration": {
        "currency": "currency",
        "handleService": "TWITTER",
        "multipleValues": true,
        "options": [
          {
            "id": "id",
            "label": "label",
            "description": "description"
          }
        ],
        "unique": true
      },
      "valueType": "ADDRESS",
      "id": "id",
      "readOnly": true
    }
  },
  "objectType": "objectType",
  "relationshipDefinitions": {
    "foo": {
      "cardinality": "HAS_ONE",
      "description": "description",
      "label": "label",
      "objectType": "objectType",
      "id": "id"
    }
  }
}
```