Note

Notes represent free-form text records in Lightfield. Each note can be associated with zero or more accounts, opportunities, and contacts.

Get note field definitions

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

GET/v1/notes/definitions

Create a note

client.Note.New(ctx, body) (*NoteCreateResponse, error)

POST/v1/notes

Update a note

client.Note.Update(ctx, id, body) (*NoteUpdateResponse, error)

POST/v1/notes/{id}

Retrieve a note

client.Note.Get(ctx, id) (*NoteRetrieveResponse, error)

GET/v1/notes/{id}

List notes

client.Note.List(ctx, query) (*NoteListResponse, error)

GET/v1/notes

Delete a note

client.Note.Delete(ctx, id, body) (*NoteDeleteResponse, error)

DELETE/v1/notes/{id}

ModelsExpand Collapse

type NoteCreateResponse struct{…}

ID string

Unique identifier for the entity.

CreatedAt string

ISO 8601 timestamp of when the entity was created.

Fields map[string, NoteCreateResponseField]

Map of field names to their typed values. System fields are prefixed with $ (e.g. $name, $email); custom attributes use their bare slug.

Value NoteCreateResponseFieldValueUnion

The field value, or null if unset.

One of the following:

string

float64

bool

type NoteCreateResponseFieldValueArray []string

type NoteCreateResponseFieldValueAddress struct{…}

City stringOptional

City name.

Country stringOptional

2-letter ISO 3166-1 alpha-2 country code.

Latitude float64Optional

Latitude coordinate.

Longitude float64Optional

Longitude coordinate.

PostalCode stringOptional

Postal or ZIP code.

State stringOptional

State or province.

Street stringOptional

Street address line 1.

Street2 stringOptional

Street address line 2.

type NoteCreateResponseFieldValueFullName struct{…}

FirstName stringOptional

The contact’s first name.

LastName stringOptional

The contact’s last name.

ValueType string

The data type of the field.

One of the following:

const NoteCreateResponseFieldValueTypeAddress NoteCreateResponseFieldValueType = "ADDRESS"

const NoteCreateResponseFieldValueTypeCheckbox NoteCreateResponseFieldValueType = "CHECKBOX"

const NoteCreateResponseFieldValueTypeCurrency NoteCreateResponseFieldValueType = "CURRENCY"

const NoteCreateResponseFieldValueTypeDatetime NoteCreateResponseFieldValueType = "DATETIME"

const NoteCreateResponseFieldValueTypeEmail NoteCreateResponseFieldValueType = "EMAIL"

const NoteCreateResponseFieldValueTypeFullName NoteCreateResponseFieldValueType = "FULL_NAME"

const NoteCreateResponseFieldValueTypeMarkdown NoteCreateResponseFieldValueType = "MARKDOWN"

const NoteCreateResponseFieldValueTypeMultiSelect NoteCreateResponseFieldValueType = "MULTI_SELECT"

const NoteCreateResponseFieldValueTypeNumber NoteCreateResponseFieldValueType = "NUMBER"

const NoteCreateResponseFieldValueTypeSingleSelect NoteCreateResponseFieldValueType = "SINGLE_SELECT"

const NoteCreateResponseFieldValueTypeSocialHandle NoteCreateResponseFieldValueType = "SOCIAL_HANDLE"

const NoteCreateResponseFieldValueTypeTelephone NoteCreateResponseFieldValueType = "TELEPHONE"

const NoteCreateResponseFieldValueTypeText NoteCreateResponseFieldValueType = "TEXT"

const NoteCreateResponseFieldValueTypeURL NoteCreateResponseFieldValueType = "URL"

const NoteCreateResponseFieldValueTypeHTML NoteCreateResponseFieldValueType = "HTML"

HTTPLink string

URL to view the entity in the Lightfield web app, or null.

Relationships map[string, NoteCreateResponseRelationship]

Map of relationship names to their associated entities. System relationships are prefixed with $ (e.g. $owner, $contact).

Cardinality string

Whether the relationship is has_one or has_many.

ObjectType string

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

Values []string

IDs of the related entities.

UpdatedAt string

ISO 8601 timestamp of when the entity was last updated, or null.

ExternalID stringOptional

External identifier for the entity, or null if unset.

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 stringOptional

ISO 4217 3-letter currency code.

HandleService stringOptional

Social platform associated with this handle field.

One of the following:

const NoteDefinitionsResponseFieldDefinitionTypeConfigurationHandleServiceTwitter NoteDefinitionsResponseFieldDefinitionTypeConfigurationHandleService = "TWITTER"

const NoteDefinitionsResponseFieldDefinitionTypeConfigurationHandleServiceLinkedin NoteDefinitionsResponseFieldDefinitionTypeConfigurationHandleService = "LINKEDIN"

const NoteDefinitionsResponseFieldDefinitionTypeConfigurationHandleServiceFacebook NoteDefinitionsResponseFieldDefinitionTypeConfigurationHandleService = "FACEBOOK"

const NoteDefinitionsResponseFieldDefinitionTypeConfigurationHandleServiceInstagram NoteDefinitionsResponseFieldDefinitionTypeConfigurationHandleService = "INSTAGRAM"

MultipleValues boolOptional

Whether this field accepts multiple values.

Options []NoteDefinitionsResponseFieldDefinitionTypeConfigurationOptionOptional

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

Map of relationship keys to their definitions.

Cardinality string

Whether this is a has_one or has_many relationship.

One of the following:

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 stringOptional

Unique identifier of the relationship definition.

type NoteDeleteResponse struct{…}

ID string

Unique identifier for the entity.

CreatedAt string

ISO 8601 timestamp of when the entity was created.

Fields map[string, NoteDeleteResponseField]

Map of field names to their typed values. System fields are prefixed with $ (e.g. $name, $email); custom attributes use their bare slug.

Value NoteDeleteResponseFieldValueUnion

The field value, or null if unset.

One of the following:

string

float64

bool

type NoteDeleteResponseFieldValueArray []string

type NoteDeleteResponseFieldValueAddress struct{…}

City stringOptional

City name.

Country stringOptional

2-letter ISO 3166-1 alpha-2 country code.

Latitude float64Optional

Latitude coordinate.

Longitude float64Optional

Longitude coordinate.

PostalCode stringOptional

Postal or ZIP code.

State stringOptional

State or province.

Street stringOptional

Street address line 1.

Street2 stringOptional

Street address line 2.

type NoteDeleteResponseFieldValueFullName struct{…}

FirstName stringOptional

The contact’s first name.

LastName stringOptional

The contact’s last name.

ValueType string

The data type of the field.

One of the following:

const NoteDeleteResponseFieldValueTypeAddress NoteDeleteResponseFieldValueType = "ADDRESS"

const NoteDeleteResponseFieldValueTypeCheckbox NoteDeleteResponseFieldValueType = "CHECKBOX"

const NoteDeleteResponseFieldValueTypeCurrency NoteDeleteResponseFieldValueType = "CURRENCY"

const NoteDeleteResponseFieldValueTypeDatetime NoteDeleteResponseFieldValueType = "DATETIME"

const NoteDeleteResponseFieldValueTypeEmail NoteDeleteResponseFieldValueType = "EMAIL"

const NoteDeleteResponseFieldValueTypeFullName NoteDeleteResponseFieldValueType = "FULL_NAME"

const NoteDeleteResponseFieldValueTypeMarkdown NoteDeleteResponseFieldValueType = "MARKDOWN"

const NoteDeleteResponseFieldValueTypeMultiSelect NoteDeleteResponseFieldValueType = "MULTI_SELECT"

const NoteDeleteResponseFieldValueTypeNumber NoteDeleteResponseFieldValueType = "NUMBER"

const NoteDeleteResponseFieldValueTypeSingleSelect NoteDeleteResponseFieldValueType = "SINGLE_SELECT"

const NoteDeleteResponseFieldValueTypeSocialHandle NoteDeleteResponseFieldValueType = "SOCIAL_HANDLE"

const NoteDeleteResponseFieldValueTypeTelephone NoteDeleteResponseFieldValueType = "TELEPHONE"

const NoteDeleteResponseFieldValueTypeText NoteDeleteResponseFieldValueType = "TEXT"

const NoteDeleteResponseFieldValueTypeURL NoteDeleteResponseFieldValueType = "URL"

const NoteDeleteResponseFieldValueTypeHTML NoteDeleteResponseFieldValueType = "HTML"

HTTPLink string

URL to view the entity in the Lightfield web app, or null.

Relationships map[string, NoteDeleteResponseRelationship]

Map of relationship names to their associated entities. System relationships are prefixed with $ (e.g. $owner, $contact).

Cardinality string

Whether the relationship is has_one or has_many.

ObjectType string

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

Values []string

IDs of the related entities.

UpdatedAt string

ISO 8601 timestamp of when the entity was last updated, or null.

ExternalID stringOptional

External identifier for the entity, or null if unset.

type NoteListResponse struct{…}

Data []NoteListResponseData

Array of entity objects for the current page.

ID string

Unique identifier for the entity.

CreatedAt string

ISO 8601 timestamp of when the entity was created.

Fields map[string, NoteListResponseDataField]

Map of field names to their typed values. System fields are prefixed with $ (e.g. $name, $email); custom attributes use their bare slug.

Value NoteListResponseDataFieldValueUnion

The field value, or null if unset.

One of the following:

string

float64

bool

type NoteListResponseDataFieldValueArray []string

type NoteListResponseDataFieldValueAddress struct{…}

City stringOptional

City name.

Country stringOptional

2-letter ISO 3166-1 alpha-2 country code.

Latitude float64Optional

Latitude coordinate.

Longitude float64Optional

Longitude coordinate.

PostalCode stringOptional

Postal or ZIP code.

State stringOptional

State or province.

Street stringOptional

Street address line 1.

Street2 stringOptional

Street address line 2.

type NoteListResponseDataFieldValueFullName struct{…}

FirstName stringOptional

The contact’s first name.

LastName stringOptional

The contact’s last name.

ValueType string

The data type of the field.

One of the following:

const NoteListResponseDataFieldValueTypeAddress NoteListResponseDataFieldValueType = "ADDRESS"

const NoteListResponseDataFieldValueTypeCheckbox NoteListResponseDataFieldValueType = "CHECKBOX"

const NoteListResponseDataFieldValueTypeCurrency NoteListResponseDataFieldValueType = "CURRENCY"

const NoteListResponseDataFieldValueTypeDatetime NoteListResponseDataFieldValueType = "DATETIME"

const NoteListResponseDataFieldValueTypeEmail NoteListResponseDataFieldValueType = "EMAIL"

const NoteListResponseDataFieldValueTypeFullName NoteListResponseDataFieldValueType = "FULL_NAME"

const NoteListResponseDataFieldValueTypeMarkdown NoteListResponseDataFieldValueType = "MARKDOWN"

const NoteListResponseDataFieldValueTypeMultiSelect NoteListResponseDataFieldValueType = "MULTI_SELECT"

const NoteListResponseDataFieldValueTypeNumber NoteListResponseDataFieldValueType = "NUMBER"

const NoteListResponseDataFieldValueTypeSingleSelect NoteListResponseDataFieldValueType = "SINGLE_SELECT"

const NoteListResponseDataFieldValueTypeSocialHandle NoteListResponseDataFieldValueType = "SOCIAL_HANDLE"

const NoteListResponseDataFieldValueTypeTelephone NoteListResponseDataFieldValueType = "TELEPHONE"

const NoteListResponseDataFieldValueTypeText NoteListResponseDataFieldValueType = "TEXT"

const NoteListResponseDataFieldValueTypeURL NoteListResponseDataFieldValueType = "URL"

const NoteListResponseDataFieldValueTypeHTML NoteListResponseDataFieldValueType = "HTML"

HTTPLink string

URL to view the entity in the Lightfield web app, or null.

Relationships map[string, NoteListResponseDataRelationship]

Map of relationship names to their associated entities. System relationships are prefixed with $ (e.g. $owner, $contact).

Cardinality string

Whether the relationship is has_one or has_many.

ObjectType string

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

Values []string

IDs of the related entities.

UpdatedAt string

ISO 8601 timestamp of when the entity was last updated, or null.

ExternalID stringOptional

External identifier for the entity, or null if unset.

Object string

The object type, always "list".

TotalCount int64

Total number of entities matching the query.

minimum0

maximum9007199254740991

type NoteRetrieveResponse struct{…}

ID string

Unique identifier for the entity.

CreatedAt string

ISO 8601 timestamp of when the entity was created.

Fields map[string, NoteRetrieveResponseField]

Map of field names to their typed values. System fields are prefixed with $ (e.g. $name, $email); custom attributes use their bare slug.

Value NoteRetrieveResponseFieldValueUnion

The field value, or null if unset.

One of the following:

string

float64

bool

type NoteRetrieveResponseFieldValueArray []string

type NoteRetrieveResponseFieldValueAddress struct{…}

City stringOptional

City name.

Country stringOptional

2-letter ISO 3166-1 alpha-2 country code.

Latitude float64Optional

Latitude coordinate.

Longitude float64Optional

Longitude coordinate.

PostalCode stringOptional

Postal or ZIP code.

State stringOptional

State or province.

Street stringOptional

Street address line 1.

Street2 stringOptional

Street address line 2.

type NoteRetrieveResponseFieldValueFullName struct{…}

FirstName stringOptional

The contact’s first name.

LastName stringOptional

The contact’s last name.

ValueType string

The data type of the field.

One of the following:

const NoteRetrieveResponseFieldValueTypeAddress NoteRetrieveResponseFieldValueType = "ADDRESS"

const NoteRetrieveResponseFieldValueTypeCheckbox NoteRetrieveResponseFieldValueType = "CHECKBOX"

const NoteRetrieveResponseFieldValueTypeCurrency NoteRetrieveResponseFieldValueType = "CURRENCY"

const NoteRetrieveResponseFieldValueTypeDatetime NoteRetrieveResponseFieldValueType = "DATETIME"

const NoteRetrieveResponseFieldValueTypeEmail NoteRetrieveResponseFieldValueType = "EMAIL"

const NoteRetrieveResponseFieldValueTypeFullName NoteRetrieveResponseFieldValueType = "FULL_NAME"

const NoteRetrieveResponseFieldValueTypeMarkdown NoteRetrieveResponseFieldValueType = "MARKDOWN"

const NoteRetrieveResponseFieldValueTypeMultiSelect NoteRetrieveResponseFieldValueType = "MULTI_SELECT"

const NoteRetrieveResponseFieldValueTypeNumber NoteRetrieveResponseFieldValueType = "NUMBER"

const NoteRetrieveResponseFieldValueTypeSingleSelect NoteRetrieveResponseFieldValueType = "SINGLE_SELECT"

const NoteRetrieveResponseFieldValueTypeSocialHandle NoteRetrieveResponseFieldValueType = "SOCIAL_HANDLE"

const NoteRetrieveResponseFieldValueTypeTelephone NoteRetrieveResponseFieldValueType = "TELEPHONE"

const NoteRetrieveResponseFieldValueTypeText NoteRetrieveResponseFieldValueType = "TEXT"

const NoteRetrieveResponseFieldValueTypeURL NoteRetrieveResponseFieldValueType = "URL"

const NoteRetrieveResponseFieldValueTypeHTML NoteRetrieveResponseFieldValueType = "HTML"

HTTPLink string

URL to view the entity in the Lightfield web app, or null.

Relationships map[string, NoteRetrieveResponseRelationship]

Map of relationship names to their associated entities. System relationships are prefixed with $ (e.g. $owner, $contact).

Cardinality string

Whether the relationship is has_one or has_many.

ObjectType string

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

Values []string

IDs of the related entities.

UpdatedAt string

ISO 8601 timestamp of when the entity was last updated, or null.

ExternalID stringOptional

External identifier for the entity, or null if unset.

type NoteUpdateResponse struct{…}

ID string

Unique identifier for the entity.

CreatedAt string

ISO 8601 timestamp of when the entity was created.

Fields map[string, NoteUpdateResponseField]

Map of field names to their typed values. System fields are prefixed with $ (e.g. $name, $email); custom attributes use their bare slug.

Value NoteUpdateResponseFieldValueUnion

The field value, or null if unset.

One of the following:

string

float64

bool

type NoteUpdateResponseFieldValueArray []string

type NoteUpdateResponseFieldValueAddress struct{…}

City stringOptional

City name.

Country stringOptional

2-letter ISO 3166-1 alpha-2 country code.

Latitude float64Optional

Latitude coordinate.

Longitude float64Optional

Longitude coordinate.

PostalCode stringOptional

Postal or ZIP code.

State stringOptional

State or province.

Street stringOptional

Street address line 1.

Street2 stringOptional

Street address line 2.

type NoteUpdateResponseFieldValueFullName struct{…}

FirstName stringOptional

The contact’s first name.

LastName stringOptional

The contact’s last name.

ValueType string

The data type of the field.

One of the following:

const NoteUpdateResponseFieldValueTypeAddress NoteUpdateResponseFieldValueType = "ADDRESS"

const NoteUpdateResponseFieldValueTypeCheckbox NoteUpdateResponseFieldValueType = "CHECKBOX"

const NoteUpdateResponseFieldValueTypeCurrency NoteUpdateResponseFieldValueType = "CURRENCY"

const NoteUpdateResponseFieldValueTypeDatetime NoteUpdateResponseFieldValueType = "DATETIME"

const NoteUpdateResponseFieldValueTypeEmail NoteUpdateResponseFieldValueType = "EMAIL"

const NoteUpdateResponseFieldValueTypeFullName NoteUpdateResponseFieldValueType = "FULL_NAME"

const NoteUpdateResponseFieldValueTypeMarkdown NoteUpdateResponseFieldValueType = "MARKDOWN"

const NoteUpdateResponseFieldValueTypeMultiSelect NoteUpdateResponseFieldValueType = "MULTI_SELECT"

const NoteUpdateResponseFieldValueTypeNumber NoteUpdateResponseFieldValueType = "NUMBER"

const NoteUpdateResponseFieldValueTypeSingleSelect NoteUpdateResponseFieldValueType = "SINGLE_SELECT"

const NoteUpdateResponseFieldValueTypeSocialHandle NoteUpdateResponseFieldValueType = "SOCIAL_HANDLE"

const NoteUpdateResponseFieldValueTypeTelephone NoteUpdateResponseFieldValueType = "TELEPHONE"

const NoteUpdateResponseFieldValueTypeText NoteUpdateResponseFieldValueType = "TEXT"

const NoteUpdateResponseFieldValueTypeURL NoteUpdateResponseFieldValueType = "URL"

const NoteUpdateResponseFieldValueTypeHTML NoteUpdateResponseFieldValueType = "HTML"

HTTPLink string

URL to view the entity in the Lightfield web app, or null.

Relationships map[string, NoteUpdateResponseRelationship]

Map of relationship names to their associated entities. System relationships are prefixed with $ (e.g. $owner, $contact).

Cardinality string

Whether the relationship is has_one or has_many.

ObjectType string

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

Values []string

IDs of the related entities.

UpdatedAt string

ISO 8601 timestamp of when the entity was last updated, or null.

ExternalID stringOptional

External identifier for the entity, or null if unset.