Skip to content
Lightfield Lightfield
API Reference
Channel

Retrieve a channel

channel.retrieve(strid) -> ChannelRetrieveResponse
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: str

Unique identifier of the channel to retrieve.

ReturnsExpand Collapse
class ChannelRetrieveResponse: …
id: str

Unique identifier for the entity.

created_at: str

ISO 8601 timestamp of when the entity was created.

fields: Dict[str, Fields]

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

value: Optional[FieldsValue]

The field value, or null if unset.

One of the following:
str
float
bool
List[str]
class FieldsValueAddress: …
city: Optional[str]

City name.

country: Optional[str]

2-letter ISO 3166-1 alpha-2 country code.

latitude: Optional[float]

Latitude coordinate.

longitude: Optional[float]

Longitude coordinate.

postal_code: Optional[str]

Postal or ZIP code.

state: Optional[str]

State or province.

street: Optional[str]

Street address line 1.

street2: Optional[str]

Street address line 2.

class FieldsValueFullName: …
first_name: Optional[str]

The contact’s first name.

last_name: Optional[str]

The contact’s last name.

value_type: Literal["ADDRESS", "CHECKBOX", "CURRENCY", 12 more]

The data type of the field.

One of the following:
"ADDRESS"
"CHECKBOX"
"CURRENCY"
"DATETIME"
"EMAIL"
"FULL_NAME"
"MARKDOWN"
"MULTI_SELECT"
"NUMBER"
"SINGLE_SELECT"
"SOCIAL_HANDLE"
"TELEPHONE"
"TEXT"
"URL"
"HTML"
object_type: Literal["channel"]

Always channel.

relationships: Dict[str, Relationships]

Map of relationship names to their associated entities. System relationships are prefixed with $ (e.g. $owner, $contact).

cardinality: str

Whether the relationship is has_one or has_many.

object_type: str

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

values: List[str]

IDs of the related entities.

updated_at: Optional[str]

ISO 8601 timestamp of when the entity was last updated, or null.

external_id: Optional[str]

External identifier for the entity, or null if unset.

Retrieve a channel

from lightfield import Lightfield

client = Lightfield(
    api_key="My API Key",
)
channel_retrieve_response = client.channel.retrieve(
    "id",
)
print(channel_retrieve_response.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"
}