Get a custom object record

client.Object.Get(ctx, id, query) (*ObjectRetrieveResponse, error)

GET/v1/objects/{entitySlug}/values/{id}

Retrieves a single record by ID for the specified custom object type.

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 ObjectRetrieveResponse struct{…}

ID string

Unique identifier for the entity.

CreatedAt string

ISO 8601 timestamp of when the entity was created.

Fields map[string, ObjectRetrieveResponseField]

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

Value ObjectRetrieveResponseFieldValueUnion

The field value, or null if unset.

One of the following:

string

float64

bool

type ObjectRetrieveResponseFieldValueArray []string

type ObjectRetrieveResponseFieldValueAddress 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 ObjectRetrieveResponseFieldValueFullName 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 ObjectRetrieveResponseFieldValueTypeAddress ObjectRetrieveResponseFieldValueType = "ADDRESS"

const ObjectRetrieveResponseFieldValueTypeCheckbox ObjectRetrieveResponseFieldValueType = "CHECKBOX"

const ObjectRetrieveResponseFieldValueTypeCurrency ObjectRetrieveResponseFieldValueType = "CURRENCY"

const ObjectRetrieveResponseFieldValueTypeDatetime ObjectRetrieveResponseFieldValueType = "DATETIME"

const ObjectRetrieveResponseFieldValueTypeEmail ObjectRetrieveResponseFieldValueType = "EMAIL"

const ObjectRetrieveResponseFieldValueTypeFullName ObjectRetrieveResponseFieldValueType = "FULL_NAME"

const ObjectRetrieveResponseFieldValueTypeMarkdown ObjectRetrieveResponseFieldValueType = "MARKDOWN"

const ObjectRetrieveResponseFieldValueTypeMultiSelect ObjectRetrieveResponseFieldValueType = "MULTI_SELECT"

const ObjectRetrieveResponseFieldValueTypeNumber ObjectRetrieveResponseFieldValueType = "NUMBER"

const ObjectRetrieveResponseFieldValueTypeSingleSelect ObjectRetrieveResponseFieldValueType = "SINGLE_SELECT"

const ObjectRetrieveResponseFieldValueTypeSocialHandle ObjectRetrieveResponseFieldValueType = "SOCIAL_HANDLE"

const ObjectRetrieveResponseFieldValueTypeTelephone ObjectRetrieveResponseFieldValueType = "TELEPHONE"

const ObjectRetrieveResponseFieldValueTypeText ObjectRetrieveResponseFieldValueType = "TEXT"

const ObjectRetrieveResponseFieldValueTypeURL ObjectRetrieveResponseFieldValueType = "URL"

const ObjectRetrieveResponseFieldValueTypeHTML ObjectRetrieveResponseFieldValueType = "HTML"

HTTPLink string

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

Relationships map[string, ObjectRetrieveResponseRelationship]

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.

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": "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"
}