Skip to content

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, query) (*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}
Restore a note
client.Note.Restore(ctx, id, body) (*NoteRestoreResponse, error)
POST/v1/notes/{id}/restore
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 NoteCreateResponseFieldValueTypeDate NoteCreateResponseFieldValueType = "DATE"
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"
Relationships map[string, NoteCreateResponseRelationship]

Map of relationship names to their associated entities. System relationships are prefixed with $ (e.g. $owner, $contact). A self-referential relationship keeps its merged values and includes optional directional values. List filters select the current record’s role with :asSource or :asDestination, for example ?parent:asSource[contains]=account_id.

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.

Directions NoteCreateResponseRelationshipDirectionsOptional

Directional values for a self-referential relationship. List filters use the relationship key with :asSource or :asDestination; writes continue to use the bare key.

AsDestination NoteCreateResponseRelationshipDirectionsAsDestination

The current record is the destination (incoming) endpoint.

Cardinality string

Whether this endpoint direction is HAS_ONE or HAS_MANY.

One of the following:
const NoteCreateResponseRelationshipDirectionsAsDestinationCardinalityHasOne NoteCreateResponseRelationshipDirectionsAsDestinationCardinality = "HAS_ONE"
const NoteCreateResponseRelationshipDirectionsAsDestinationCardinalityHasMany NoteCreateResponseRelationshipDirectionsAsDestinationCardinality = "HAS_MANY"
Values []string

IDs of the related entities in this direction.

AsSource NoteCreateResponseRelationshipDirectionsAsSource

The current record is the source (outgoing) endpoint.

Cardinality string

Whether this endpoint direction is HAS_ONE or HAS_MANY.

One of the following:
const NoteCreateResponseRelationshipDirectionsAsSourceCardinalityHasOne NoteCreateResponseRelationshipDirectionsAsSourceCardinality = "HAS_ONE"
const NoteCreateResponseRelationshipDirectionsAsSourceCardinalityHasMany NoteCreateResponseRelationshipDirectionsAsSourceCardinality = "HAS_MANY"
Values []string

IDs of the related entities in this direction.

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.

Archived bool

Whether the field definition is archived.

ArchivedAt Time

When the field definition was archived, or null if active.

formatdate-time
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). A key the field type does not support is absent; a supported key with nothing set is null.

Currency stringOptional

ISO 4217 3-letter currency code. Present on CURRENCY fields, absent on every other type.

DecimalPlaces int64Optional

Number of decimal places values carry, or null when none is set. Present on NUMBER and CURRENCY fields, absent on every other type.

minimum-9007199254740991
maximum9007199254740991
HandleService stringOptional

Social platform associated with this handle field, or null when none is set. Present on SOCIAL_HANDLE fields, absent on every other type.

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. Present on EMAIL, TELEPHONE and URL fields, absent on every other type.

Options []NoteDefinitionsResponseFieldDefinitionTypeConfigurationOptionOptional

Available options. Always present on SINGLE_SELECT and MULTI_SELECT fields, as an empty list when there are none. Absent on every other type.

ID string

Unique identifier of the select option.

Label string

Human-readable display name of the option.

Category stringOptional

Lifecycle group of the option, in-progress (ACTIVE) or done (COMPLETED), or null when none is set. Absent on selects whose options are not grouped.

One of the following:
const NoteDefinitionsResponseFieldDefinitionTypeConfigurationOptionCategoryActive NoteDefinitionsResponseFieldDefinitionTypeConfigurationOptionCategory = "ACTIVE"
const NoteDefinitionsResponseFieldDefinitionTypeConfigurationOptionCategoryCompleted NoteDefinitionsResponseFieldDefinitionTypeConfigurationOptionCategory = "COMPLETED"
Color stringOptional

Color the option is displayed in, GRAY when none was chosen. Absent on selects whose options take no color.

One of the following:
const NoteDefinitionsResponseFieldDefinitionTypeConfigurationOptionColorRed NoteDefinitionsResponseFieldDefinitionTypeConfigurationOptionColor = "RED"
const NoteDefinitionsResponseFieldDefinitionTypeConfigurationOptionColorOrange NoteDefinitionsResponseFieldDefinitionTypeConfigurationOptionColor = "ORANGE"
const NoteDefinitionsResponseFieldDefinitionTypeConfigurationOptionColorYellow NoteDefinitionsResponseFieldDefinitionTypeConfigurationOptionColor = "YELLOW"
const NoteDefinitionsResponseFieldDefinitionTypeConfigurationOptionColorLime NoteDefinitionsResponseFieldDefinitionTypeConfigurationOptionColor = "LIME"
const NoteDefinitionsResponseFieldDefinitionTypeConfigurationOptionColorGreen NoteDefinitionsResponseFieldDefinitionTypeConfigurationOptionColor = "GREEN"
const NoteDefinitionsResponseFieldDefinitionTypeConfigurationOptionColorBlue NoteDefinitionsResponseFieldDefinitionTypeConfigurationOptionColor = "BLUE"
const NoteDefinitionsResponseFieldDefinitionTypeConfigurationOptionColorIndigo NoteDefinitionsResponseFieldDefinitionTypeConfigurationOptionColor = "INDIGO"
const NoteDefinitionsResponseFieldDefinitionTypeConfigurationOptionColorPurple NoteDefinitionsResponseFieldDefinitionTypeConfigurationOptionColor = "PURPLE"
const NoteDefinitionsResponseFieldDefinitionTypeConfigurationOptionColorCopper NoteDefinitionsResponseFieldDefinitionTypeConfigurationOptionColor = "COPPER"
const NoteDefinitionsResponseFieldDefinitionTypeConfigurationOptionColorGray NoteDefinitionsResponseFieldDefinitionTypeConfigurationOptionColor = "GRAY"
Description stringOptional

Description of the option, or null.

ForecastPercentage float64Optional

Forecast weighting of the option from 0 to 100, or null when none is set. Absent on selects whose options take no forecast.

Icon stringOptional

Icon the option is displayed with, or null when none is set. Present only on $stage.

One of the following:
const NoteDefinitionsResponseFieldDefinitionTypeConfigurationOptionIconBacklog NoteDefinitionsResponseFieldDefinitionTypeConfigurationOptionIcon = "BACKLOG"
const NoteDefinitionsResponseFieldDefinitionTypeConfigurationOptionIconQualification NoteDefinitionsResponseFieldDefinitionTypeConfigurationOptionIcon = "QUALIFICATION"
const NoteDefinitionsResponseFieldDefinitionTypeConfigurationOptionIconDiscovery NoteDefinitionsResponseFieldDefinitionTypeConfigurationOptionIcon = "DISCOVERY"
const NoteDefinitionsResponseFieldDefinitionTypeConfigurationOptionIconActive NoteDefinitionsResponseFieldDefinitionTypeConfigurationOptionIcon = "ACTIVE"
const NoteDefinitionsResponseFieldDefinitionTypeConfigurationOptionIconNegotiation NoteDefinitionsResponseFieldDefinitionTypeConfigurationOptionIcon = "NEGOTIATION"
const NoteDefinitionsResponseFieldDefinitionTypeConfigurationOptionIconClosedWon NoteDefinitionsResponseFieldDefinitionTypeConfigurationOptionIcon = "CLOSED_WON"
const NoteDefinitionsResponseFieldDefinitionTypeConfigurationOptionIconClosedLost NoteDefinitionsResponseFieldDefinitionTypeConfigurationOptionIcon = "CLOSED_LOST"
ParentID stringOptional

For a dependent select, the ID of the option in the parent field named by typeConfiguration.parentFieldKey that owns this option. Absent for ordinary selects.

ParentFieldKey stringOptional

For a dependent select, the field key whose selected option determines which of this field’s options apply. Absent for ordinary selects.

Unique boolOptional

Whether values for this field must be unique, or null when not set. Present on EMAIL, TELEPHONE, URL and SOCIAL_HANDLE fields, absent on every other type.

ValueType string

Data type of the field.

One of the following:
const NoteDefinitionsResponseFieldDefinitionValueTypeAddress NoteDefinitionsResponseFieldDefinitionValueType = "ADDRESS"
const NoteDefinitionsResponseFieldDefinitionValueTypeCheckbox NoteDefinitionsResponseFieldDefinitionValueType = "CHECKBOX"
const NoteDefinitionsResponseFieldDefinitionValueTypeCurrency NoteDefinitionsResponseFieldDefinitionValueType = "CURRENCY"
const NoteDefinitionsResponseFieldDefinitionValueTypeDate NoteDefinitionsResponseFieldDefinitionValueType = "DATE"
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.

AIFillable stringOptional

Whether AI fills this field automatically (ON), only suggests values (SUGGEST), or leaves it alone (OFF). Absent on built-in fields that have no id.

One of the following:
const NoteDefinitionsResponseFieldDefinitionAIFillableOn NoteDefinitionsResponseFieldDefinitionAIFillable = "ON"
const NoteDefinitionsResponseFieldDefinitionAIFillableOff NoteDefinitionsResponseFieldDefinitionAIFillable = "OFF"
const NoteDefinitionsResponseFieldDefinitionAIFillableSuggest NoteDefinitionsResponseFieldDefinitionAIFillable = "SUGGEST"
AIFillablePrompt stringOptional

Instructions AI follows when filling this field, or null when none are set. Absent on built-in fields that have no id.

Formula stringOptional

Formula a calculated field evaluates, with fields and relationships referenced by key. Null for fields that are not calculated. Absent on built-in fields that have no id.

ReadOnly boolOptional

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

ValueSource stringOptional

Whether values are entered (MANUAL) or calculated from a formula (COMPUTED). Absent on built-in fields that have no id.

One of the following:
const NoteDefinitionsResponseFieldDefinitionValueSourceManual NoteDefinitionsResponseFieldDefinitionValueSource = "MANUAL"
const NoteDefinitionsResponseFieldDefinitionValueSourceComputed NoteDefinitionsResponseFieldDefinitionValueSource = "COMPUTED"
ObjectType string

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

RelationshipDefinitions map[string, NoteDefinitionsResponseRelationshipDefinition]

Map of relationship keys to their definitions. Self-referential relationships include optional directional metadata on the bare definition.

Archived bool

Whether the relationship definition is archived.

ArchivedAt Time

When the relationship definition was archived, or null if active.

formatdate-time
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, as it reads from this object type.

ObjectType string

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

ID stringOptional

Unique identifier of the relationship definition.

Directions NoteDefinitionsResponseRelationshipDefinitionDirectionsOptional

Directional metadata for a self-referential relationship. List filters use the relationship key with :asSource or :asDestination; writes continue to use the bare key.

AsDestination NoteDefinitionsResponseRelationshipDefinitionDirectionsAsDestination

The current record is the destination (incoming) endpoint.

Cardinality string

Whether this endpoint direction is HAS_ONE or HAS_MANY.

One of the following:
const NoteDefinitionsResponseRelationshipDefinitionDirectionsAsDestinationCardinalityHasOne NoteDefinitionsResponseRelationshipDefinitionDirectionsAsDestinationCardinality = "HAS_ONE"
const NoteDefinitionsResponseRelationshipDefinitionDirectionsAsDestinationCardinalityHasMany NoteDefinitionsResponseRelationshipDefinitionDirectionsAsDestinationCardinality = "HAS_MANY"
Label string

Human-readable display name for this endpoint direction.

AsSource NoteDefinitionsResponseRelationshipDefinitionDirectionsAsSource

The current record is the source (outgoing) endpoint.

Cardinality string

Whether this endpoint direction is HAS_ONE or HAS_MANY.

One of the following:
const NoteDefinitionsResponseRelationshipDefinitionDirectionsAsSourceCardinalityHasOne NoteDefinitionsResponseRelationshipDefinitionDirectionsAsSourceCardinality = "HAS_ONE"
const NoteDefinitionsResponseRelationshipDefinitionDirectionsAsSourceCardinalityHasMany NoteDefinitionsResponseRelationshipDefinitionDirectionsAsSourceCardinality = "HAS_MANY"
Label string

Human-readable display name for this endpoint direction.

GroupKey stringOptional

Key of the relationship group this relationship belongs to, as listed under relationshipGroupDefinitions. Absent when the relationship is not in a group.

Inverse NoteDefinitionsResponseRelationshipDefinitionInverseOptional

How the same relationship reads from the related object type.

Cardinality string

Whether this endpoint direction is HAS_ONE or HAS_MANY.

One of the following:
const NoteDefinitionsResponseRelationshipDefinitionInverseCardinalityHasOne NoteDefinitionsResponseRelationshipDefinitionInverseCardinality = "HAS_ONE"
const NoteDefinitionsResponseRelationshipDefinitionInverseCardinalityHasMany NoteDefinitionsResponseRelationshipDefinitionInverseCardinality = "HAS_MANY"
Label string

Human-readable display name for this endpoint direction.

RelationshipGroupDefinitions map[string, NoteDefinitionsResponseRelationshipGroupDefinition]

Map of relationship group keys to their definitions. A group collects relationships between the same two object types, such as the roles a contact can hold on an opportunity. Relationships name their group with groupKey.

ID string

Unique identifier of the relationship group.

Archived bool

Whether the relationship group is archived.

ArchivedAt Time

When the relationship group was archived, or null if active.

formatdate-time
Inverse NoteDefinitionsResponseRelationshipGroupDefinitionInverse

How the same group reads from the related object type.

Label string

Human-readable display name of the group, as it reads from the related object type.

Label string

Human-readable display name of the group, as it reads from this object type.

ObjectType string

The type of the related object every relationship in the group points to.

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 NoteDeleteResponseFieldValueTypeDate NoteDeleteResponseFieldValueType = "DATE"
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"
Relationships map[string, NoteDeleteResponseRelationship]

Map of relationship names to their associated entities. System relationships are prefixed with $ (e.g. $owner, $contact). A self-referential relationship keeps its merged values and includes optional directional values. List filters select the current record’s role with :asSource or :asDestination, for example ?parent:asSource[contains]=account_id.

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.

Directions NoteDeleteResponseRelationshipDirectionsOptional

Directional values for a self-referential relationship. List filters use the relationship key with :asSource or :asDestination; writes continue to use the bare key.

AsDestination NoteDeleteResponseRelationshipDirectionsAsDestination

The current record is the destination (incoming) endpoint.

Cardinality string

Whether this endpoint direction is HAS_ONE or HAS_MANY.

One of the following:
const NoteDeleteResponseRelationshipDirectionsAsDestinationCardinalityHasOne NoteDeleteResponseRelationshipDirectionsAsDestinationCardinality = "HAS_ONE"
const NoteDeleteResponseRelationshipDirectionsAsDestinationCardinalityHasMany NoteDeleteResponseRelationshipDirectionsAsDestinationCardinality = "HAS_MANY"
Values []string

IDs of the related entities in this direction.

AsSource NoteDeleteResponseRelationshipDirectionsAsSource

The current record is the source (outgoing) endpoint.

Cardinality string

Whether this endpoint direction is HAS_ONE or HAS_MANY.

One of the following:
const NoteDeleteResponseRelationshipDirectionsAsSourceCardinalityHasOne NoteDeleteResponseRelationshipDirectionsAsSourceCardinality = "HAS_ONE"
const NoteDeleteResponseRelationshipDirectionsAsSourceCardinalityHasMany NoteDeleteResponseRelationshipDirectionsAsSourceCardinality = "HAS_MANY"
Values []string

IDs of the related entities in this direction.

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 NoteListResponseDataFieldValueTypeDate NoteListResponseDataFieldValueType = "DATE"
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"
Relationships map[string, NoteListResponseDataRelationship]

Map of relationship names to their associated entities. System relationships are prefixed with $ (e.g. $owner, $contact). A self-referential relationship keeps its merged values and includes optional directional values. List filters select the current record’s role with :asSource or :asDestination, for example ?parent:asSource[contains]=account_id.

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.

Directions NoteListResponseDataRelationshipDirectionsOptional

Directional values for a self-referential relationship. List filters use the relationship key with :asSource or :asDestination; writes continue to use the bare key.

AsDestination NoteListResponseDataRelationshipDirectionsAsDestination

The current record is the destination (incoming) endpoint.

Cardinality string

Whether this endpoint direction is HAS_ONE or HAS_MANY.

One of the following:
const NoteListResponseDataRelationshipDirectionsAsDestinationCardinalityHasOne NoteListResponseDataRelationshipDirectionsAsDestinationCardinality = "HAS_ONE"
const NoteListResponseDataRelationshipDirectionsAsDestinationCardinalityHasMany NoteListResponseDataRelationshipDirectionsAsDestinationCardinality = "HAS_MANY"
Values []string

IDs of the related entities in this direction.

AsSource NoteListResponseDataRelationshipDirectionsAsSource

The current record is the source (outgoing) endpoint.

Cardinality string

Whether this endpoint direction is HAS_ONE or HAS_MANY.

One of the following:
const NoteListResponseDataRelationshipDirectionsAsSourceCardinalityHasOne NoteListResponseDataRelationshipDirectionsAsSourceCardinality = "HAS_ONE"
const NoteListResponseDataRelationshipDirectionsAsSourceCardinalityHasMany NoteListResponseDataRelationshipDirectionsAsSourceCardinality = "HAS_MANY"
Values []string

IDs of the related entities in this direction.

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 NoteRestoreResponse struct{…}
ID string

Unique identifier for the entity.

CreatedAt string

ISO 8601 timestamp of when the entity was created.

Fields map[string, NoteRestoreResponseField]

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

Value NoteRestoreResponseFieldValueUnion

The field value, or null if unset.

One of the following:
string
float64
bool
type NoteRestoreResponseFieldValueArray []string
type NoteRestoreResponseFieldValueAddress 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 NoteRestoreResponseFieldValueFullName 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 NoteRestoreResponseFieldValueTypeAddress NoteRestoreResponseFieldValueType = "ADDRESS"
const NoteRestoreResponseFieldValueTypeCheckbox NoteRestoreResponseFieldValueType = "CHECKBOX"
const NoteRestoreResponseFieldValueTypeCurrency NoteRestoreResponseFieldValueType = "CURRENCY"
const NoteRestoreResponseFieldValueTypeDate NoteRestoreResponseFieldValueType = "DATE"
const NoteRestoreResponseFieldValueTypeDatetime NoteRestoreResponseFieldValueType = "DATETIME"
const NoteRestoreResponseFieldValueTypeEmail NoteRestoreResponseFieldValueType = "EMAIL"
const NoteRestoreResponseFieldValueTypeFullName NoteRestoreResponseFieldValueType = "FULL_NAME"
const NoteRestoreResponseFieldValueTypeMarkdown NoteRestoreResponseFieldValueType = "MARKDOWN"
const NoteRestoreResponseFieldValueTypeMultiSelect NoteRestoreResponseFieldValueType = "MULTI_SELECT"
const NoteRestoreResponseFieldValueTypeNumber NoteRestoreResponseFieldValueType = "NUMBER"
const NoteRestoreResponseFieldValueTypeSingleSelect NoteRestoreResponseFieldValueType = "SINGLE_SELECT"
const NoteRestoreResponseFieldValueTypeSocialHandle NoteRestoreResponseFieldValueType = "SOCIAL_HANDLE"
const NoteRestoreResponseFieldValueTypeTelephone NoteRestoreResponseFieldValueType = "TELEPHONE"
const NoteRestoreResponseFieldValueTypeText NoteRestoreResponseFieldValueType = "TEXT"
const NoteRestoreResponseFieldValueTypeURL NoteRestoreResponseFieldValueType = "URL"
const NoteRestoreResponseFieldValueTypeHTML NoteRestoreResponseFieldValueType = "HTML"
Relationships map[string, NoteRestoreResponseRelationship]

Map of relationship names to their associated entities. System relationships are prefixed with $ (e.g. $owner, $contact). A self-referential relationship keeps its merged values and includes optional directional values. List filters select the current record’s role with :asSource or :asDestination, for example ?parent:asSource[contains]=account_id.

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.

Directions NoteRestoreResponseRelationshipDirectionsOptional

Directional values for a self-referential relationship. List filters use the relationship key with :asSource or :asDestination; writes continue to use the bare key.

AsDestination NoteRestoreResponseRelationshipDirectionsAsDestination

The current record is the destination (incoming) endpoint.

Cardinality string

Whether this endpoint direction is HAS_ONE or HAS_MANY.

One of the following:
const NoteRestoreResponseRelationshipDirectionsAsDestinationCardinalityHasOne NoteRestoreResponseRelationshipDirectionsAsDestinationCardinality = "HAS_ONE"
const NoteRestoreResponseRelationshipDirectionsAsDestinationCardinalityHasMany NoteRestoreResponseRelationshipDirectionsAsDestinationCardinality = "HAS_MANY"
Values []string

IDs of the related entities in this direction.

AsSource NoteRestoreResponseRelationshipDirectionsAsSource

The current record is the source (outgoing) endpoint.

Cardinality string

Whether this endpoint direction is HAS_ONE or HAS_MANY.

One of the following:
const NoteRestoreResponseRelationshipDirectionsAsSourceCardinalityHasOne NoteRestoreResponseRelationshipDirectionsAsSourceCardinality = "HAS_ONE"
const NoteRestoreResponseRelationshipDirectionsAsSourceCardinalityHasMany NoteRestoreResponseRelationshipDirectionsAsSourceCardinality = "HAS_MANY"
Values []string

IDs of the related entities in this direction.

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 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 NoteRetrieveResponseFieldValueTypeDate NoteRetrieveResponseFieldValueType = "DATE"
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"
Relationships map[string, NoteRetrieveResponseRelationship]

Map of relationship names to their associated entities. System relationships are prefixed with $ (e.g. $owner, $contact). A self-referential relationship keeps its merged values and includes optional directional values. List filters select the current record’s role with :asSource or :asDestination, for example ?parent:asSource[contains]=account_id.

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.

Directions NoteRetrieveResponseRelationshipDirectionsOptional

Directional values for a self-referential relationship. List filters use the relationship key with :asSource or :asDestination; writes continue to use the bare key.

AsDestination NoteRetrieveResponseRelationshipDirectionsAsDestination

The current record is the destination (incoming) endpoint.

Cardinality string

Whether this endpoint direction is HAS_ONE or HAS_MANY.

One of the following:
const NoteRetrieveResponseRelationshipDirectionsAsDestinationCardinalityHasOne NoteRetrieveResponseRelationshipDirectionsAsDestinationCardinality = "HAS_ONE"
const NoteRetrieveResponseRelationshipDirectionsAsDestinationCardinalityHasMany NoteRetrieveResponseRelationshipDirectionsAsDestinationCardinality = "HAS_MANY"
Values []string

IDs of the related entities in this direction.

AsSource NoteRetrieveResponseRelationshipDirectionsAsSource

The current record is the source (outgoing) endpoint.

Cardinality string

Whether this endpoint direction is HAS_ONE or HAS_MANY.

One of the following:
const NoteRetrieveResponseRelationshipDirectionsAsSourceCardinalityHasOne NoteRetrieveResponseRelationshipDirectionsAsSourceCardinality = "HAS_ONE"
const NoteRetrieveResponseRelationshipDirectionsAsSourceCardinalityHasMany NoteRetrieveResponseRelationshipDirectionsAsSourceCardinality = "HAS_MANY"
Values []string

IDs of the related entities in this direction.

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 NoteUpdateResponseFieldValueTypeDate NoteUpdateResponseFieldValueType = "DATE"
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"
Relationships map[string, NoteUpdateResponseRelationship]

Map of relationship names to their associated entities. System relationships are prefixed with $ (e.g. $owner, $contact). A self-referential relationship keeps its merged values and includes optional directional values. List filters select the current record’s role with :asSource or :asDestination, for example ?parent:asSource[contains]=account_id.

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.

Directions NoteUpdateResponseRelationshipDirectionsOptional

Directional values for a self-referential relationship. List filters use the relationship key with :asSource or :asDestination; writes continue to use the bare key.

AsDestination NoteUpdateResponseRelationshipDirectionsAsDestination

The current record is the destination (incoming) endpoint.

Cardinality string

Whether this endpoint direction is HAS_ONE or HAS_MANY.

One of the following:
const NoteUpdateResponseRelationshipDirectionsAsDestinationCardinalityHasOne NoteUpdateResponseRelationshipDirectionsAsDestinationCardinality = "HAS_ONE"
const NoteUpdateResponseRelationshipDirectionsAsDestinationCardinalityHasMany NoteUpdateResponseRelationshipDirectionsAsDestinationCardinality = "HAS_MANY"
Values []string

IDs of the related entities in this direction.

AsSource NoteUpdateResponseRelationshipDirectionsAsSource

The current record is the source (outgoing) endpoint.

Cardinality string

Whether this endpoint direction is HAS_ONE or HAS_MANY.

One of the following:
const NoteUpdateResponseRelationshipDirectionsAsSourceCardinalityHasOne NoteUpdateResponseRelationshipDirectionsAsSourceCardinality = "HAS_ONE"
const NoteUpdateResponseRelationshipDirectionsAsSourceCardinalityHasMany NoteUpdateResponseRelationshipDirectionsAsSourceCardinality = "HAS_MANY"
Values []string

IDs of the related entities in this direction.

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.