Retrieve a contact

client.Contact.Get(ctx, id) (*ContactRetrieveResponse, error)

GET/v1/contacts/{id}

Retrieves a single contact by its ID.

Required scope: contacts:read

Rate limit category: Read

ParametersExpand Collapse

id string

Unique identifier of the contact to retrieve.

ReturnsExpand Collapse

type ContactRetrieveResponse struct{…}

ID string

Unique identifier for the entity.

CreatedAt string

ISO 8601 timestamp of when the entity was created.

Fields map[string, ContactRetrieveResponseField]

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

Value ContactRetrieveResponseFieldValueUnion

The field value, or null if unset.

One of the following:

string

float64

bool

type ContactRetrieveResponseFieldValueArray []string

type ContactRetrieveResponseFieldValueAddress 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 ContactRetrieveResponseFieldValueFullName 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 ContactRetrieveResponseFieldValueTypeAddress ContactRetrieveResponseFieldValueType = "ADDRESS"

const ContactRetrieveResponseFieldValueTypeCheckbox ContactRetrieveResponseFieldValueType = "CHECKBOX"

const ContactRetrieveResponseFieldValueTypeCurrency ContactRetrieveResponseFieldValueType = "CURRENCY"

const ContactRetrieveResponseFieldValueTypeDatetime ContactRetrieveResponseFieldValueType = "DATETIME"

const ContactRetrieveResponseFieldValueTypeEmail ContactRetrieveResponseFieldValueType = "EMAIL"

const ContactRetrieveResponseFieldValueTypeFullName ContactRetrieveResponseFieldValueType = "FULL_NAME"

const ContactRetrieveResponseFieldValueTypeMarkdown ContactRetrieveResponseFieldValueType = "MARKDOWN"

const ContactRetrieveResponseFieldValueTypeMultiSelect ContactRetrieveResponseFieldValueType = "MULTI_SELECT"

const ContactRetrieveResponseFieldValueTypeNumber ContactRetrieveResponseFieldValueType = "NUMBER"

const ContactRetrieveResponseFieldValueTypeSingleSelect ContactRetrieveResponseFieldValueType = "SINGLE_SELECT"

const ContactRetrieveResponseFieldValueTypeSocialHandle ContactRetrieveResponseFieldValueType = "SOCIAL_HANDLE"

const ContactRetrieveResponseFieldValueTypeTelephone ContactRetrieveResponseFieldValueType = "TELEPHONE"

const ContactRetrieveResponseFieldValueTypeText ContactRetrieveResponseFieldValueType = "TEXT"

const ContactRetrieveResponseFieldValueTypeURL ContactRetrieveResponseFieldValueType = "URL"

const ContactRetrieveResponseFieldValueTypeHTML ContactRetrieveResponseFieldValueType = "HTML"

HTTPLink string

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

Relationships map[string, ContactRetrieveResponseRelationship]

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 ContactRetrieveResponseRelationshipDirectionsOptional

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 ContactRetrieveResponseRelationshipDirectionsAsDestination

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 ContactRetrieveResponseRelationshipDirectionsAsDestinationCardinalityHasOne ContactRetrieveResponseRelationshipDirectionsAsDestinationCardinality = "HAS_ONE"

const ContactRetrieveResponseRelationshipDirectionsAsDestinationCardinalityHasMany ContactRetrieveResponseRelationshipDirectionsAsDestinationCardinality = "HAS_MANY"

Values []string

IDs of the related entities in this direction.

AsSource ContactRetrieveResponseRelationshipDirectionsAsSource

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 ContactRetrieveResponseRelationshipDirectionsAsSourceCardinalityHasOne ContactRetrieveResponseRelationshipDirectionsAsSourceCardinality = "HAS_ONE"

const ContactRetrieveResponseRelationshipDirectionsAsSourceCardinalityHasMany ContactRetrieveResponseRelationshipDirectionsAsSourceCardinality = "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.

Retrieve a contact

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"),
  )
  contactRetrieveResponse, err := client.Contact.Get(context.TODO(), "id")
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", contactRetrieveResponse.ID)
}

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