Get meeting field definitions

client.Meeting.Definitions(ctx) (*MeetingDefinitionsResponse, error)

GET/v1/meetings/definitions

Returns the schema for the field and relationship definitions available on meetings. Useful for understanding the shape of meeting data before creating or updating records. See Fields and relationships for more details.

Required scope: meetings:read

Rate limit category: Read

ReturnsExpand Collapse

type MeetingDefinitionsResponse struct{…}

FieldDefinitions map[string, MeetingDefinitionsResponseFieldDefinition]

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 MeetingDefinitionsResponseFieldDefinitionTypeConfiguration

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

Currency stringOptional

ISO 4217 3-letter currency code.

HandleService stringOptional

Social platform associated with this handle field.

One of the following:

const MeetingDefinitionsResponseFieldDefinitionTypeConfigurationHandleServiceTwitter MeetingDefinitionsResponseFieldDefinitionTypeConfigurationHandleService = "TWITTER"

const MeetingDefinitionsResponseFieldDefinitionTypeConfigurationHandleServiceLinkedin MeetingDefinitionsResponseFieldDefinitionTypeConfigurationHandleService = "LINKEDIN"

const MeetingDefinitionsResponseFieldDefinitionTypeConfigurationHandleServiceFacebook MeetingDefinitionsResponseFieldDefinitionTypeConfigurationHandleService = "FACEBOOK"

const MeetingDefinitionsResponseFieldDefinitionTypeConfigurationHandleServiceInstagram MeetingDefinitionsResponseFieldDefinitionTypeConfigurationHandleService = "INSTAGRAM"

MultipleValues boolOptional

Whether this field accepts multiple values.

Options []MeetingDefinitionsResponseFieldDefinitionTypeConfigurationOptionOptional

Available options for select fields.

ID string

Unique identifier of the select option.

Label string

Human-readable display name of the option.

Description stringOptional

Description of the option, or null.

Unique boolOptional

Whether values for this field must be unique.

ValueType string

Data type of the field.

One of the following:

const MeetingDefinitionsResponseFieldDefinitionValueTypeAddress MeetingDefinitionsResponseFieldDefinitionValueType = "ADDRESS"

const MeetingDefinitionsResponseFieldDefinitionValueTypeCheckbox MeetingDefinitionsResponseFieldDefinitionValueType = "CHECKBOX"

const MeetingDefinitionsResponseFieldDefinitionValueTypeCurrency MeetingDefinitionsResponseFieldDefinitionValueType = "CURRENCY"

const MeetingDefinitionsResponseFieldDefinitionValueTypeDatetime MeetingDefinitionsResponseFieldDefinitionValueType = "DATETIME"

const MeetingDefinitionsResponseFieldDefinitionValueTypeEmail MeetingDefinitionsResponseFieldDefinitionValueType = "EMAIL"

const MeetingDefinitionsResponseFieldDefinitionValueTypeFullName MeetingDefinitionsResponseFieldDefinitionValueType = "FULL_NAME"

const MeetingDefinitionsResponseFieldDefinitionValueTypeMarkdown MeetingDefinitionsResponseFieldDefinitionValueType = "MARKDOWN"

const MeetingDefinitionsResponseFieldDefinitionValueTypeMultiSelect MeetingDefinitionsResponseFieldDefinitionValueType = "MULTI_SELECT"

const MeetingDefinitionsResponseFieldDefinitionValueTypeNumber MeetingDefinitionsResponseFieldDefinitionValueType = "NUMBER"

const MeetingDefinitionsResponseFieldDefinitionValueTypeSingleSelect MeetingDefinitionsResponseFieldDefinitionValueType = "SINGLE_SELECT"

const MeetingDefinitionsResponseFieldDefinitionValueTypeSocialHandle MeetingDefinitionsResponseFieldDefinitionValueType = "SOCIAL_HANDLE"

const MeetingDefinitionsResponseFieldDefinitionValueTypeTelephone MeetingDefinitionsResponseFieldDefinitionValueType = "TELEPHONE"

const MeetingDefinitionsResponseFieldDefinitionValueTypeText MeetingDefinitionsResponseFieldDefinitionValueType = "TEXT"

const MeetingDefinitionsResponseFieldDefinitionValueTypeURL MeetingDefinitionsResponseFieldDefinitionValueType = "URL"

const MeetingDefinitionsResponseFieldDefinitionValueTypeHTML MeetingDefinitionsResponseFieldDefinitionValueType = "HTML"

ID stringOptional

Unique identifier of the field definition.

ReadOnly boolOptional

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, MeetingDefinitionsResponseRelationshipDefinition]

Map of relationship keys to their definitions.

Cardinality string

Whether this is a has_one or has_many relationship.

One of the following:

const MeetingDefinitionsResponseRelationshipDefinitionCardinalityHasOne MeetingDefinitionsResponseRelationshipDefinitionCardinality = "HAS_ONE"

const MeetingDefinitionsResponseRelationshipDefinitionCardinalityHasMany MeetingDefinitionsResponseRelationshipDefinitionCardinality = "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 stringOptional

Unique identifier of the relationship definition.

Get meeting field definitions

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"),
  )
  meetingDefinitionsResponse, err := client.Meeting.Definitions(context.TODO())
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", meetingDefinitionsResponse.FieldDefinitions)
}

{
  "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"
    }
  }
}

Returns Examples

{
  "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"
    }
  }
}