Retrieve a channel

client.Channel.Get(ctx, id) (*ChannelRetrieveResponse, error)

GET/v1/channels/{id}

Retrieves a single channel by its ID. Returns 404 if the channel is not visible to the caller — a private channel the caller is not a member of is indistinguishable from one that does not exist.

Required scope: channels:read

Rate limit category: Read

ParametersExpand Collapse

id string

Unique identifier of the channel to retrieve.

ReturnsExpand Collapse

type ChannelRetrieveResponse struct{…}

ID string

Unique identifier for the entity.

CreatedAt string

ISO 8601 timestamp of when the entity was created.

Fields map[string, ChannelRetrieveResponseField]

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

Value ChannelRetrieveResponseFieldValueUnion

The field value, or null if unset.

One of the following:

string

float64

bool

type ChannelRetrieveResponseFieldValueArray []string

type ChannelRetrieveResponseFieldValueAddress 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 ChannelRetrieveResponseFieldValueFullName 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 ChannelRetrieveResponseFieldValueTypeAddress ChannelRetrieveResponseFieldValueType = "ADDRESS"

const ChannelRetrieveResponseFieldValueTypeCheckbox ChannelRetrieveResponseFieldValueType = "CHECKBOX"

const ChannelRetrieveResponseFieldValueTypeCurrency ChannelRetrieveResponseFieldValueType = "CURRENCY"

const ChannelRetrieveResponseFieldValueTypeDatetime ChannelRetrieveResponseFieldValueType = "DATETIME"

const ChannelRetrieveResponseFieldValueTypeEmail ChannelRetrieveResponseFieldValueType = "EMAIL"

const ChannelRetrieveResponseFieldValueTypeFullName ChannelRetrieveResponseFieldValueType = "FULL_NAME"

const ChannelRetrieveResponseFieldValueTypeMarkdown ChannelRetrieveResponseFieldValueType = "MARKDOWN"

const ChannelRetrieveResponseFieldValueTypeMultiSelect ChannelRetrieveResponseFieldValueType = "MULTI_SELECT"

const ChannelRetrieveResponseFieldValueTypeNumber ChannelRetrieveResponseFieldValueType = "NUMBER"

const ChannelRetrieveResponseFieldValueTypeSingleSelect ChannelRetrieveResponseFieldValueType = "SINGLE_SELECT"

const ChannelRetrieveResponseFieldValueTypeSocialHandle ChannelRetrieveResponseFieldValueType = "SOCIAL_HANDLE"

const ChannelRetrieveResponseFieldValueTypeTelephone ChannelRetrieveResponseFieldValueType = "TELEPHONE"

const ChannelRetrieveResponseFieldValueTypeText ChannelRetrieveResponseFieldValueType = "TEXT"

const ChannelRetrieveResponseFieldValueTypeURL ChannelRetrieveResponseFieldValueType = "URL"

const ChannelRetrieveResponseFieldValueTypeHTML ChannelRetrieveResponseFieldValueType = "HTML"

HTTPLink string

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

ObjectType ChannelRetrieveResponseObjectType

Always channel.

Relationships map[string, ChannelRetrieveResponseRelationship]

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 channel

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

{
  "id": "chn_cm2def456ghi789",
  "createdAt": "2026-05-01T09:00:00.000Z",
  "fields": {
    "$name": {
      "value": "acme-deal-room",
      "valueType": "TEXT"
    },
    "$provider": {
      "value": "SLACK",
      "valueType": "TEXT"
    },
    "$isPublic": {
      "value": false,
      "valueType": "CHECKBOX"
    },
    "$providerChannelId": {
      "value": "C0123456789",
      "valueType": "TEXT"
    },
    "$providerCreatedAt": {
      "value": "2026-04-20T14:30:00.000Z",
      "valueType": "DATETIME"
    }
  },
  "httpLink": null,
  "objectType": "channel",
  "relationships": {
    "account-slack-channel": {
      "cardinality": "has_many",
      "objectType": "account",
      "values": [
        "acc_cm0abc123def456"
      ]
    },
    "opportunity-slack-channel": {
      "cardinality": "has_many",
      "objectType": "opportunity",
      "values": [
        "opp_cm1xyz456uvw789"
      ]
    }
  },
  "updatedAt": "2026-05-01T09:00:00.000Z",
  "externalId": "externalId"
}

Returns Examples

{
  "id": "chn_cm2def456ghi789",
  "createdAt": "2026-05-01T09:00:00.000Z",
  "fields": {
    "$name": {
      "value": "acme-deal-room",
      "valueType": "TEXT"
    },
    "$provider": {
      "value": "SLACK",
      "valueType": "TEXT"
    },
    "$isPublic": {
      "value": false,
      "valueType": "CHECKBOX"
    },
    "$providerChannelId": {
      "value": "C0123456789",
      "valueType": "TEXT"
    },
    "$providerCreatedAt": {
      "value": "2026-04-20T14:30:00.000Z",
      "valueType": "DATETIME"
    }
  },
  "httpLink": null,
  "objectType": "channel",
  "relationships": {
    "account-slack-channel": {
      "cardinality": "has_many",
      "objectType": "account",
      "values": [
        "acc_cm0abc123def456"
      ]
    },
    "opportunity-slack-channel": {
      "cardinality": "has_many",
      "objectType": "opportunity",
      "values": [
        "opp_cm1xyz456uvw789"
      ]
    }
  },
  "updatedAt": "2026-05-01T09:00:00.000Z",
  "externalId": "externalId"
}