Retrieve a note

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

GET/v1/notes/{id}

Retrieves a single note by its ID.

Required scope: notes:read

Rate limit category: Read

ParametersExpand Collapse

id string

Unique identifier of the note to retrieve.

ReturnsExpand Collapse

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"

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.

Retrieve a note

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)
}

{
  "id": "id",
  "createdAt": "createdAt",
  "fields": {
    "foo": {
      "value": "string",
      "valueType": "ADDRESS"
    }
  },
  "httpLink": "httpLink",
  "relationships": {
    "foo": {
      "cardinality": "cardinality",
      "objectType": "objectType",
      "values": [
        "string"
      ]
    }
  },
  "updatedAt": "updatedAt",
  "externalId": "externalId"
}

Returns Examples

{
  "id": "id",
  "createdAt": "createdAt",
  "fields": {
    "foo": {
      "value": "string",
      "valueType": "ADDRESS"
    }
  },
  "httpLink": "httpLink",
  "relationships": {
    "foo": {
      "cardinality": "cardinality",
      "objectType": "objectType",
      "values": [
        "string"
      ]
    }
  },
  "updatedAt": "updatedAt",
  "externalId": "externalId"
}