Get definitions for a custom object type

client.Object.Definitions(ctx, entitySlug) (*ObjectDefinitionsResponse, error)

GET/v1/objects/{entitySlug}/definitions

Returns field and relationship definitions for the specified custom object type.

ParametersExpand Collapse

entitySlug string

The slug of the custom object type.

ReturnsExpand Collapse

type ObjectDefinitionsResponse struct{…}

FieldDefinitions map[string, ObjectDefinitionsResponseFieldDefinition]

Map of field keys to their definitions, including both system and custom fields.

Description string

Description of the field, or null.

Label string

Human-readable display name of the field.

TypeConfiguration ObjectDefinitionsResponseFieldDefinitionTypeConfiguration

Type-specific configuration (e.g. select options, currency code).

Currency stringOptional

ISO 4217 3-letter currency code.

HandleService stringOptional

Social platform associated with this handle field.

One of the following:

const ObjectDefinitionsResponseFieldDefinitionTypeConfigurationHandleServiceTwitter ObjectDefinitionsResponseFieldDefinitionTypeConfigurationHandleService = "TWITTER"

const ObjectDefinitionsResponseFieldDefinitionTypeConfigurationHandleServiceLinkedin ObjectDefinitionsResponseFieldDefinitionTypeConfigurationHandleService = "LINKEDIN"

const ObjectDefinitionsResponseFieldDefinitionTypeConfigurationHandleServiceFacebook ObjectDefinitionsResponseFieldDefinitionTypeConfigurationHandleService = "FACEBOOK"

const ObjectDefinitionsResponseFieldDefinitionTypeConfigurationHandleServiceInstagram ObjectDefinitionsResponseFieldDefinitionTypeConfigurationHandleService = "INSTAGRAM"

MultipleValues boolOptional

Whether this field accepts multiple values.

Options []ObjectDefinitionsResponseFieldDefinitionTypeConfigurationOptionOptional

Available options for select fields.

ID string

Unique identifier of the select option.

Label string

Human-readable display name of the option.

Description stringOptional

Description of the option, or null.

Unique boolOptional

Whether values for this field must be unique.

ValueType string

Data type of the field.

One of the following:

const ObjectDefinitionsResponseFieldDefinitionValueTypeAddress ObjectDefinitionsResponseFieldDefinitionValueType = "ADDRESS"

const ObjectDefinitionsResponseFieldDefinitionValueTypeCheckbox ObjectDefinitionsResponseFieldDefinitionValueType = "CHECKBOX"

const ObjectDefinitionsResponseFieldDefinitionValueTypeCurrency ObjectDefinitionsResponseFieldDefinitionValueType = "CURRENCY"

const ObjectDefinitionsResponseFieldDefinitionValueTypeDatetime ObjectDefinitionsResponseFieldDefinitionValueType = "DATETIME"

const ObjectDefinitionsResponseFieldDefinitionValueTypeEmail ObjectDefinitionsResponseFieldDefinitionValueType = "EMAIL"

const ObjectDefinitionsResponseFieldDefinitionValueTypeFullName ObjectDefinitionsResponseFieldDefinitionValueType = "FULL_NAME"

const ObjectDefinitionsResponseFieldDefinitionValueTypeMarkdown ObjectDefinitionsResponseFieldDefinitionValueType = "MARKDOWN"

const ObjectDefinitionsResponseFieldDefinitionValueTypeMultiSelect ObjectDefinitionsResponseFieldDefinitionValueType = "MULTI_SELECT"

const ObjectDefinitionsResponseFieldDefinitionValueTypeNumber ObjectDefinitionsResponseFieldDefinitionValueType = "NUMBER"

const ObjectDefinitionsResponseFieldDefinitionValueTypeSingleSelect ObjectDefinitionsResponseFieldDefinitionValueType = "SINGLE_SELECT"

const ObjectDefinitionsResponseFieldDefinitionValueTypeSocialHandle ObjectDefinitionsResponseFieldDefinitionValueType = "SOCIAL_HANDLE"

const ObjectDefinitionsResponseFieldDefinitionValueTypeTelephone ObjectDefinitionsResponseFieldDefinitionValueType = "TELEPHONE"

const ObjectDefinitionsResponseFieldDefinitionValueTypeText ObjectDefinitionsResponseFieldDefinitionValueType = "TEXT"

const ObjectDefinitionsResponseFieldDefinitionValueTypeURL ObjectDefinitionsResponseFieldDefinitionValueType = "URL"

const ObjectDefinitionsResponseFieldDefinitionValueTypeHTML ObjectDefinitionsResponseFieldDefinitionValueType = "HTML"

ID stringOptional

Unique identifier of the field definition.

ReadOnly boolOptional

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

ObjectType string

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

RelationshipDefinitions map[string, ObjectDefinitionsResponseRelationshipDefinition]

Map of relationship keys to their definitions.

Cardinality string

Whether this is a has_one or has_many relationship.

One of the following:

const ObjectDefinitionsResponseRelationshipDefinitionCardinalityHasOne ObjectDefinitionsResponseRelationshipDefinitionCardinality = "HAS_ONE"

const ObjectDefinitionsResponseRelationshipDefinitionCardinalityHasMany ObjectDefinitionsResponseRelationshipDefinitionCardinality = "HAS_MANY"

Description string

Description of the relationship, or null.

Label string

Human-readable display name of the relationship.

ObjectType string

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

ID stringOptional

Unique identifier of the relationship definition.

Get definitions for a custom object type

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"),
  )
  objectDefinitionsResponse, err := client.Object.Definitions(context.TODO(), "entitySlug")
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", objectDefinitionsResponse.FieldDefinitions)
}

{
  "fieldDefinitions": {
    "foo": {
      "description": "description",
      "label": "label",
      "typeConfiguration": {
        "currency": "currency",
        "handleService": "TWITTER",
        "multipleValues": true,
        "options": [
          {
            "id": "id",
            "label": "label",
            "description": "description"
          }
        ],
        "unique": true
      },
      "valueType": "ADDRESS",
      "id": "id",
      "readOnly": true
    }
  },
  "objectType": "objectType",
  "relationshipDefinitions": {
    "foo": {
      "cardinality": "HAS_ONE",
      "description": "description",
      "label": "label",
      "objectType": "objectType",
      "id": "id"
    }
  }
}

Returns Examples

{
  "fieldDefinitions": {
    "foo": {
      "description": "description",
      "label": "label",
      "typeConfiguration": {
        "currency": "currency",
        "handleService": "TWITTER",
        "multipleValues": true,
        "options": [
          {
            "id": "id",
            "label": "label",
            "description": "description"
          }
        ],
        "unique": true
      },
      "valueType": "ADDRESS",
      "id": "id",
      "readOnly": true
    }
  },
  "objectType": "objectType",
  "relationshipDefinitions": {
    "foo": {
      "cardinality": "HAS_ONE",
      "description": "description",
      "label": "label",
      "objectType": "objectType",
      "id": "id"
    }
  }
}