Skip to content

Get a custom object record

client.Object.Get(ctx, id, query) (*ObjectRetrieveResponseUnion, error)
GET/v1/objects/{entitySlug}/values/{id}

Retrieves a single record by ID for the specified custom object type. A record you may see by name only is returned as { id, restricted: { name, reason } }, with no fields or relationships; check for restricted before reading them.

ParametersExpand Collapse
id string

The ID of the record to retrieve.

query ObjectGetParams
EntitySlug param.Field[string]

The slug of the custom object type.

ReturnsExpand Collapse
type ObjectRetrieveResponseUnion interface{…}
One of the following:
type ObjectRetrieveResponseEntity struct{…}
ID string

Unique identifier for the entity.

CreatedAt string

ISO 8601 timestamp of when the entity was created.

Fields map[string, ObjectRetrieveResponseEntityField]

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

Value ObjectRetrieveResponseEntityFieldValueUnion

The field value, or null if unset.

One of the following:
string
float64
bool
type ObjectRetrieveResponseEntityFieldValueArray []string
type ObjectRetrieveResponseEntityFieldValueAddress 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 ObjectRetrieveResponseEntityFieldValueFullName 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 ObjectRetrieveResponseEntityFieldValueTypeAddress ObjectRetrieveResponseEntityFieldValueType = "ADDRESS"
const ObjectRetrieveResponseEntityFieldValueTypeCheckbox ObjectRetrieveResponseEntityFieldValueType = "CHECKBOX"
const ObjectRetrieveResponseEntityFieldValueTypeCurrency ObjectRetrieveResponseEntityFieldValueType = "CURRENCY"
const ObjectRetrieveResponseEntityFieldValueTypeDate ObjectRetrieveResponseEntityFieldValueType = "DATE"
const ObjectRetrieveResponseEntityFieldValueTypeDatetime ObjectRetrieveResponseEntityFieldValueType = "DATETIME"
const ObjectRetrieveResponseEntityFieldValueTypeEmail ObjectRetrieveResponseEntityFieldValueType = "EMAIL"
const ObjectRetrieveResponseEntityFieldValueTypeFullName ObjectRetrieveResponseEntityFieldValueType = "FULL_NAME"
const ObjectRetrieveResponseEntityFieldValueTypeMarkdown ObjectRetrieveResponseEntityFieldValueType = "MARKDOWN"
const ObjectRetrieveResponseEntityFieldValueTypeMultiSelect ObjectRetrieveResponseEntityFieldValueType = "MULTI_SELECT"
const ObjectRetrieveResponseEntityFieldValueTypeNumber ObjectRetrieveResponseEntityFieldValueType = "NUMBER"
const ObjectRetrieveResponseEntityFieldValueTypeSingleSelect ObjectRetrieveResponseEntityFieldValueType = "SINGLE_SELECT"
const ObjectRetrieveResponseEntityFieldValueTypeSocialHandle ObjectRetrieveResponseEntityFieldValueType = "SOCIAL_HANDLE"
const ObjectRetrieveResponseEntityFieldValueTypeTelephone ObjectRetrieveResponseEntityFieldValueType = "TELEPHONE"
const ObjectRetrieveResponseEntityFieldValueTypeText ObjectRetrieveResponseEntityFieldValueType = "TEXT"
const ObjectRetrieveResponseEntityFieldValueTypeURL ObjectRetrieveResponseEntityFieldValueType = "URL"
const ObjectRetrieveResponseEntityFieldValueTypeHTML ObjectRetrieveResponseEntityFieldValueType = "HTML"
Relationships map[string, ObjectRetrieveResponseEntityRelationship]

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 ObjectRetrieveResponseEntityRelationshipDirectionsOptional

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 ObjectRetrieveResponseEntityRelationshipDirectionsAsDestination

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 ObjectRetrieveResponseEntityRelationshipDirectionsAsDestinationCardinalityHasOne ObjectRetrieveResponseEntityRelationshipDirectionsAsDestinationCardinality = "HAS_ONE"
const ObjectRetrieveResponseEntityRelationshipDirectionsAsDestinationCardinalityHasMany ObjectRetrieveResponseEntityRelationshipDirectionsAsDestinationCardinality = "HAS_MANY"
Values []string

IDs of the related entities in this direction.

AsSource ObjectRetrieveResponseEntityRelationshipDirectionsAsSource

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 ObjectRetrieveResponseEntityRelationshipDirectionsAsSourceCardinalityHasOne ObjectRetrieveResponseEntityRelationshipDirectionsAsSourceCardinality = "HAS_ONE"
const ObjectRetrieveResponseEntityRelationshipDirectionsAsSourceCardinalityHasMany ObjectRetrieveResponseEntityRelationshipDirectionsAsSourceCardinality = "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 ObjectRetrieveResponseRestricted struct{…}
ID string

Unique identifier for the record, the same ID a full response carries.

Restricted ObjectRetrieveResponseRestrictedRestricted

Present only on a record the caller may know exists but not read. Check for it before reading fields or relationships, which a restricted record does not carry.

Name string

A label for the record’s type, such as “Restricted opportunity”. Never the record’s name.

Reason string

Why the record is restricted.

One of the following:
const ObjectRetrieveResponseRestrictedRestrictedReasonNoAccess ObjectRetrieveResponseRestrictedRestrictedReason = "NO_ACCESS"
const ObjectRetrieveResponseRestrictedRestrictedReasonInherited ObjectRetrieveResponseRestrictedRestrictedReason = "INHERITED"

Get a custom object record

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"),
  )
  objectRetrieveResponse, err := client.Object.Get(
    context.TODO(),
    "id",
    githubcomlightfldlightfieldgo.ObjectGetParams{
      EntitySlug: "entitySlug",
    },
  )
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", objectRetrieveResponse)
}
{
  "id": "id",
  "createdAt": "createdAt",
  "fields": {
    "foo": {
      "value": "string",
      "valueType": "ADDRESS"
    }
  },
  "httpLink": "httpLink",
  "relationships": {
    "foo": {
      "cardinality": "cardinality",
      "objectType": "objectType",
      "values": [
        "string"
      ],
      "directions": {
        "asDestination": {
          "cardinality": "HAS_ONE",
          "values": [
            "string"
          ]
        },
        "asSource": {
          "cardinality": "HAS_ONE",
          "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"
      ],
      "directions": {
        "asDestination": {
          "cardinality": "HAS_ONE",
          "values": [
            "string"
          ]
        },
        "asSource": {
          "cardinality": "HAS_ONE",
          "values": [
            "string"
          ]
        }
      }
    }
  },
  "updatedAt": "updatedAt",
  "externalId": "externalId"
}