# Note ## Create a note `client.Note.New(ctx, body) (*NoteCreateResponse, error)` **post** `/v1/notes` Creates a new note record. The note author is automatically set to the API key owner. Supports idempotency via the `Idempotency-Key` header. **[Required scope](/using-the-api/scopes/):** `notes:create` **[Rate limit category](/using-the-api/rate-limits/):** Write ### Parameters - `body NoteNewParams` - `Fields param.Field[NoteNewParamsFields]` Field values for the new note. `$title` is required; `$content` is optional. See **[Fields and relationships](/using-the-api/fields-and-relationships/)** for value type details. - `Title string` Title of the note. - `Content string` Content of the note as markdown formatted text. - `Relationships param.Field[NoteNewParamsRelationships]` Relationships to set on the new note. System relationships use a `$` prefix (e.g. `$account`, `$opportunity`). Each value is a single entity ID or an array of IDs. The note author is automatically set to the API key owner. - `Account NoteNewParamsRelationshipsAccountUnion` ID(s) of accounts to associate with this note. - `string` - `type NoteNewParamsRelationshipsAccountArray []string` - `Opportunity NoteNewParamsRelationshipsOpportunityUnion` ID(s) of opportunities to associate with this note. - `string` - `type NoteNewParamsRelationshipsOpportunityArray []string` ### Returns - `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. - `string` - `float64` - `bool` - `type NoteCreateResponseFieldValueArray []string` - `type NoteCreateResponseFieldValueAddress struct{…}` - `City string` City name. - `Country string` 2-letter ISO 3166-1 alpha-2 country code. - `Latitude float64` Latitude coordinate. - `Longitude float64` Longitude coordinate. - `PostalCode string` Postal or ZIP code. - `State string` State or province. - `Street string` Street address line 1. - `Street2 string` Street address line 2. - `type NoteCreateResponseFieldValueFullName struct{…}` - `FirstName string` The contact's first name. - `LastName string` The contact's last name. - `ValueType string` The data type of the field. - `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"` - `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 string` External identifier for the entity, or null if unset. ### 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"), ) noteCreateResponse, err := client.Note.New(context.TODO(), githubcomlightfldlightfieldgo.NoteNewParams{ Fields: githubcomlightfldlightfieldgo.NoteNewParamsFields{ Title: "$title", }, }) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", noteCreateResponse.ID) } ``` #### Response ```json { "id": "id", "createdAt": "createdAt", "fields": { "foo": { "value": "string", "valueType": "ADDRESS" } }, "httpLink": "httpLink", "relationships": { "foo": { "cardinality": "cardinality", "objectType": "objectType", "values": [ "string" ] } }, "updatedAt": "updatedAt", "externalId": "externalId" } ``` ## Update a note `client.Note.Update(ctx, id, body) (*NoteUpdateResponse, error)` **post** `/v1/notes/{id}` Updates an existing note by ID. Only included fields and relationships are modified. Both `$account` and `$opportunity` relationships can be modified via `add` or `remove` operations. Supports idempotency via the `Idempotency-Key` header. **[Required scope](/using-the-api/scopes/):** `notes:update` **[Rate limit category](/using-the-api/rate-limits/):** Write ### Parameters - `id string` Unique identifier of the note to update. - `body NoteUpdateParams` - `Fields param.Field[NoteUpdateParamsFields]` Field values to update — only provided fields are modified; omitted fields are left unchanged. See **[Fields and relationships](/using-the-api/fields-and-relationships/)** for value type details. - `Content string` Content of the note as markdown formatted text. - `Title string` Title of the note. - `Relationships param.Field[NoteUpdateParamsRelationships]` Relationship operations to apply. System relationships use a `$` prefix (e.g. `$account`, `$opportunity`). Each value is an operation object with `add` or `remove`. - `Account NoteUpdateParamsRelationshipsAccountUnion` Operation to modify associated accounts. - `type NoteUpdateParamsRelationshipsAccountAdd struct{…}` - `Add NoteUpdateParamsRelationshipsAccountAddAddUnion` Entity ID(s) to add to the relationship. - `string` - `type NoteUpdateParamsRelationshipsAccountAddAddArray []string` - `type NoteUpdateParamsRelationshipsAccountRemove struct{…}` - `Remove NoteUpdateParamsRelationshipsAccountRemoveRemoveUnion` Entity ID(s) to remove from the relationship. - `string` - `type NoteUpdateParamsRelationshipsAccountRemoveRemoveArray []string` - `Opportunity NoteUpdateParamsRelationshipsOpportunityUnion` Operation to modify associated opportunities. - `type NoteUpdateParamsRelationshipsOpportunityAdd struct{…}` - `Add NoteUpdateParamsRelationshipsOpportunityAddAddUnion` Entity ID(s) to add to the relationship. - `string` - `type NoteUpdateParamsRelationshipsOpportunityAddAddArray []string` - `type NoteUpdateParamsRelationshipsOpportunityRemove struct{…}` - `Remove NoteUpdateParamsRelationshipsOpportunityRemoveRemoveUnion` Entity ID(s) to remove from the relationship. - `string` - `type NoteUpdateParamsRelationshipsOpportunityRemoveRemoveArray []string` ### Returns - `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. - `string` - `float64` - `bool` - `type NoteUpdateResponseFieldValueArray []string` - `type NoteUpdateResponseFieldValueAddress struct{…}` - `City string` City name. - `Country string` 2-letter ISO 3166-1 alpha-2 country code. - `Latitude float64` Latitude coordinate. - `Longitude float64` Longitude coordinate. - `PostalCode string` Postal or ZIP code. - `State string` State or province. - `Street string` Street address line 1. - `Street2 string` Street address line 2. - `type NoteUpdateResponseFieldValueFullName struct{…}` - `FirstName string` The contact's first name. - `LastName string` The contact's last name. - `ValueType string` The data type of the field. - `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"` - `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 string` External identifier for the entity, or null if unset. ### 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"), ) noteUpdateResponse, err := client.Note.Update( context.TODO(), "id", githubcomlightfldlightfieldgo.NoteUpdateParams{ }, ) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", noteUpdateResponse.ID) } ``` #### Response ```json { "id": "id", "createdAt": "createdAt", "fields": { "foo": { "value": "string", "valueType": "ADDRESS" } }, "httpLink": "httpLink", "relationships": { "foo": { "cardinality": "cardinality", "objectType": "objectType", "values": [ "string" ] } }, "updatedAt": "updatedAt", "externalId": "externalId" } ``` ## Retrieve a note `client.Note.Get(ctx, id) (*NoteRetrieveResponse, error)` **get** `/v1/notes/{id}` Retrieves a single note by its ID. **[Required scope](/using-the-api/scopes/):** `notes:read` **[Rate limit category](/using-the-api/rate-limits/):** Read ### Parameters - `id string` Unique identifier of the note to retrieve. ### Returns - `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. - `string` - `float64` - `bool` - `type NoteRetrieveResponseFieldValueArray []string` - `type NoteRetrieveResponseFieldValueAddress struct{…}` - `City string` City name. - `Country string` 2-letter ISO 3166-1 alpha-2 country code. - `Latitude float64` Latitude coordinate. - `Longitude float64` Longitude coordinate. - `PostalCode string` Postal or ZIP code. - `State string` State or province. - `Street string` Street address line 1. - `Street2 string` Street address line 2. - `type NoteRetrieveResponseFieldValueFullName struct{…}` - `FirstName string` The contact's first name. - `LastName string` The contact's last name. - `ValueType string` The data type of the field. - `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"` - `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 string` External identifier for the entity, or null if unset. ### 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"), ) noteRetrieveResponse, err := client.Note.Get(context.TODO(), "id") if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", noteRetrieveResponse.ID) } ``` #### Response ```json { "id": "id", "createdAt": "createdAt", "fields": { "foo": { "value": "string", "valueType": "ADDRESS" } }, "httpLink": "httpLink", "relationships": { "foo": { "cardinality": "cardinality", "objectType": "objectType", "values": [ "string" ] } }, "updatedAt": "updatedAt", "externalId": "externalId" } ``` ## List notes `client.Note.List(ctx, query) (*NoteListResponse, error)` **get** `/v1/notes` Returns a paginated list of notes. Use `offset` and `limit` to paginate through results. See [List endpoints](/using-the-api/list-endpoints/) for more information about pagination. **[Required scope](/using-the-api/scopes/):** `notes:read` **[Rate limit category](/using-the-api/rate-limits/):** Search ### Parameters - `query NoteListParams` - `Limit param.Field[int64]` Maximum number of records to return. Defaults to 25, maximum 25. - `Offset param.Field[int64]` Number of records to skip for pagination. Defaults to 0. ### Returns - `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. - `string` - `float64` - `bool` - `type NoteListResponseDataFieldValueArray []string` - `type NoteListResponseDataFieldValueAddress struct{…}` - `City string` City name. - `Country string` 2-letter ISO 3166-1 alpha-2 country code. - `Latitude float64` Latitude coordinate. - `Longitude float64` Longitude coordinate. - `PostalCode string` Postal or ZIP code. - `State string` State or province. - `Street string` Street address line 1. - `Street2 string` Street address line 2. - `type NoteListResponseDataFieldValueFullName struct{…}` - `FirstName string` The contact's first name. - `LastName string` The contact's last name. - `ValueType string` The data type of the field. - `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"` - `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 string` 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. ### 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"), ) noteListResponse, err := client.Note.List(context.TODO(), githubcomlightfldlightfieldgo.NoteListParams{ }) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", noteListResponse.Data) } ``` #### Response ```json { "data": [ { "id": "id", "createdAt": "createdAt", "fields": { "foo": { "value": "string", "valueType": "ADDRESS" } }, "httpLink": "httpLink", "relationships": { "foo": { "cardinality": "cardinality", "objectType": "objectType", "values": [ "string" ] } }, "updatedAt": "updatedAt", "externalId": "externalId" } ], "object": "object", "totalCount": 0 } ``` ## Domain Types ### Note Create Response - `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. - `string` - `float64` - `bool` - `type NoteCreateResponseFieldValueArray []string` - `type NoteCreateResponseFieldValueAddress struct{…}` - `City string` City name. - `Country string` 2-letter ISO 3166-1 alpha-2 country code. - `Latitude float64` Latitude coordinate. - `Longitude float64` Longitude coordinate. - `PostalCode string` Postal or ZIP code. - `State string` State or province. - `Street string` Street address line 1. - `Street2 string` Street address line 2. - `type NoteCreateResponseFieldValueFullName struct{…}` - `FirstName string` The contact's first name. - `LastName string` The contact's last name. - `ValueType string` The data type of the field. - `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"` - `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 string` External identifier for the entity, or null if unset. ### Note List Response - `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. - `string` - `float64` - `bool` - `type NoteListResponseDataFieldValueArray []string` - `type NoteListResponseDataFieldValueAddress struct{…}` - `City string` City name. - `Country string` 2-letter ISO 3166-1 alpha-2 country code. - `Latitude float64` Latitude coordinate. - `Longitude float64` Longitude coordinate. - `PostalCode string` Postal or ZIP code. - `State string` State or province. - `Street string` Street address line 1. - `Street2 string` Street address line 2. - `type NoteListResponseDataFieldValueFullName struct{…}` - `FirstName string` The contact's first name. - `LastName string` The contact's last name. - `ValueType string` The data type of the field. - `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"` - `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 string` 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. ### Note Retrieve Response - `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. - `string` - `float64` - `bool` - `type NoteRetrieveResponseFieldValueArray []string` - `type NoteRetrieveResponseFieldValueAddress struct{…}` - `City string` City name. - `Country string` 2-letter ISO 3166-1 alpha-2 country code. - `Latitude float64` Latitude coordinate. - `Longitude float64` Longitude coordinate. - `PostalCode string` Postal or ZIP code. - `State string` State or province. - `Street string` Street address line 1. - `Street2 string` Street address line 2. - `type NoteRetrieveResponseFieldValueFullName struct{…}` - `FirstName string` The contact's first name. - `LastName string` The contact's last name. - `ValueType string` The data type of the field. - `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"` - `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 string` External identifier for the entity, or null if unset. ### Note Update Response - `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. - `string` - `float64` - `bool` - `type NoteUpdateResponseFieldValueArray []string` - `type NoteUpdateResponseFieldValueAddress struct{…}` - `City string` City name. - `Country string` 2-letter ISO 3166-1 alpha-2 country code. - `Latitude float64` Latitude coordinate. - `Longitude float64` Longitude coordinate. - `PostalCode string` Postal or ZIP code. - `State string` State or province. - `Street string` Street address line 1. - `Street2 string` Street address line 2. - `type NoteUpdateResponseFieldValueFullName struct{…}` - `FirstName string` The contact's first name. - `LastName string` The contact's last name. - `ValueType string` The data type of the field. - `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"` - `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 string` External identifier for the entity, or null if unset.