v19

latestOpenAPI 3.1.1raw.githubusercontent.com2026-08-017489931.2 KB

Retrieve a channel

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

get/v1/channels/{id}

Path parameters

idstring required

Unique identifier of the channel to retrieve.

Headers

Lightfield-Version'2026-03-01' required

Required API version header. Requests may error without it.

Response

idstring required

Unique identifier for the entity.

createdAtstring required

ISO 8601 timestamp of when the entity was created.

updatedAtstring nullable required

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

httpLinkstring nullable required

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

externalIdstring nullable

External identifier for the entity, or null if unset.

fieldsobject required

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

relationshipsobject required

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

objectType'channel' required

Always channel.

Example response

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