Skip to content
Lightfield Lightfield
API Reference
Channel

List channels

client.channel.list(ChannelListParams { limit, offset } query?, RequestOptionsoptions?): ChannelListResponse { data, object, totalCount }
GET/v1/channels

Returns a paginated list of channels. Results are sorted by when the record was created in Lightfield (createdAt), newest first. Use offset and limit to paginate through results. Each page is filtered per caller to the channels they may see (public channels, channels they are a member of, and LinkedIn DMs they can read in full). See List endpoints for more information about pagination.

Required scope: channels:read

Rate limit category: Search

ParametersExpand Collapse
query: ChannelListParams { limit, offset }
limit?: number

Maximum number of records to return. Defaults to 25, maximum 25.

minimum1
maximum9007199254740991
offset?: number

Number of records to skip for pagination. Defaults to 0.

minimum0
maximum9007199254740991
ReturnsExpand Collapse
ChannelListResponse { data, object, totalCount }
data: Array<Data>

Array of channel objects for the current page.

id: string

Unique identifier for the entity.

createdAt: string

ISO 8601 timestamp of when the entity was created.

fields: Record<string, 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: string | number | boolean | 3 more | null

The field value, or null if unset.

One of the following:
string
number
boolean
Array<string>
Address { city, country, latitude, 5 more }
city?: string | null

City name.

country?: string | null

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

latitude?: number | null

Latitude coordinate.

longitude?: number | null

Longitude coordinate.

postalCode?: string | null

Postal or ZIP code.

state?: string | null

State or province.

street?: string | null

Street address line 1.

street2?: string | null

Street address line 2.

FullName { firstName, lastName }
firstName?: string | null

The contact’s first name.

lastName?: string | null

The contact’s last name.

valueType: "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"
objectType: "channel"

Always channel.

relationships: Record<string, Relationships>

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: Array<string>

IDs of the related entities.

directions?: Directions { asDestination, asSource }

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: AsDestination { cardinality, values }

The current record is the destination (incoming) endpoint.

cardinality: "HAS_ONE" | "HAS_MANY"

Whether this endpoint direction is HAS_ONE or HAS_MANY.

One of the following:
"HAS_ONE"
"HAS_MANY"
values: Array<string>

IDs of the related entities in this direction.

asSource: AsSource { cardinality, values }

The current record is the source (outgoing) endpoint.

cardinality: "HAS_ONE" | "HAS_MANY"

Whether this endpoint direction is HAS_ONE or HAS_MANY.

One of the following:
"HAS_ONE"
"HAS_MANY"
values: Array<string>

IDs of the related entities in this direction.

updatedAt: string | null

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

externalId?: string | null

External identifier for the entity, or null if unset.

object: string

The object type, always "list".

totalCount: number

Total number of entities matching the query.

minimum0
maximum9007199254740991

List channels

import Lightfield from 'lightfield';

const client = new Lightfield({
  apiKey: 'My API Key',
});

const channelListResponse = await client.channel.list();

console.log(channelListResponse.data);
{
  "data": [
    {
      "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"
        },
        "$includeInCrm": {
          "value": "string",
          "valueType": "CHECKBOX"
        }
      },
      "httpLink": null,
      "objectType": "channel",
      "relationships": {
        "account-slack-channel": {
          "cardinality": "has_many",
          "objectType": "account",
          "values": [
            "acc_cm0abc123def456"
          ],
          "directions": {
            "asDestination": {
              "cardinality": "HAS_ONE",
              "values": [
                "string"
              ]
            },
            "asSource": {
              "cardinality": "HAS_ONE",
              "values": [
                "string"
              ]
            }
          }
        },
        "opportunity-slack-channel": {
          "cardinality": "has_many",
          "objectType": "opportunity",
          "values": [
            "opp_cm1xyz456uvw789"
          ],
          "directions": {
            "asDestination": {
              "cardinality": "HAS_ONE",
              "values": [
                "string"
              ]
            },
            "asSource": {
              "cardinality": "HAS_ONE",
              "values": [
                "string"
              ]
            }
          }
        }
      },
      "updatedAt": "2026-05-01T09:00:00.000Z",
      "externalId": "externalId"
    },
    {
      "id": "chn_cm3ghi789jkl012",
      "createdAt": "2026-04-29T15:12:00.000Z",
      "fields": {
        "$name": {
          "value": "general",
          "valueType": "TEXT"
        },
        "$provider": {
          "value": "SLACK",
          "valueType": "TEXT"
        },
        "$isPublic": {
          "value": true,
          "valueType": "CHECKBOX"
        },
        "$providerChannelId": {
          "value": "C9876543210",
          "valueType": "TEXT"
        },
        "$providerCreatedAt": {
          "value": "2026-01-05T10:00:00.000Z",
          "valueType": "DATETIME"
        },
        "$includeInCrm": {
          "value": "string",
          "valueType": "CHECKBOX"
        }
      },
      "httpLink": null,
      "objectType": "channel",
      "relationships": {
        "account-slack-channel": {
          "cardinality": "has_many",
          "objectType": "account",
          "values": [
            "acc_cm0abc123def456"
          ],
          "directions": {
            "asDestination": {
              "cardinality": "HAS_ONE",
              "values": [
                "string"
              ]
            },
            "asSource": {
              "cardinality": "HAS_ONE",
              "values": [
                "string"
              ]
            }
          }
        },
        "opportunity-slack-channel": {
          "cardinality": "has_many",
          "objectType": "opportunity",
          "values": [
            "opp_cm1xyz456uvw789"
          ],
          "directions": {
            "asDestination": {
              "cardinality": "HAS_ONE",
              "values": [
                "string"
              ]
            },
            "asSource": {
              "cardinality": "HAS_ONE",
              "values": [
                "string"
              ]
            }
          }
        }
      },
      "updatedAt": "2026-04-29T15:12:00.000Z",
      "externalId": "externalId"
    }
  ],
  "object": "list",
  "totalCount": 2
}
Returns Examples
{
  "data": [
    {
      "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"
        },
        "$includeInCrm": {
          "value": "string",
          "valueType": "CHECKBOX"
        }
      },
      "httpLink": null,
      "objectType": "channel",
      "relationships": {
        "account-slack-channel": {
          "cardinality": "has_many",
          "objectType": "account",
          "values": [
            "acc_cm0abc123def456"
          ],
          "directions": {
            "asDestination": {
              "cardinality": "HAS_ONE",
              "values": [
                "string"
              ]
            },
            "asSource": {
              "cardinality": "HAS_ONE",
              "values": [
                "string"
              ]
            }
          }
        },
        "opportunity-slack-channel": {
          "cardinality": "has_many",
          "objectType": "opportunity",
          "values": [
            "opp_cm1xyz456uvw789"
          ],
          "directions": {
            "asDestination": {
              "cardinality": "HAS_ONE",
              "values": [
                "string"
              ]
            },
            "asSource": {
              "cardinality": "HAS_ONE",
              "values": [
                "string"
              ]
            }
          }
        }
      },
      "updatedAt": "2026-05-01T09:00:00.000Z",
      "externalId": "externalId"
    },
    {
      "id": "chn_cm3ghi789jkl012",
      "createdAt": "2026-04-29T15:12:00.000Z",
      "fields": {
        "$name": {
          "value": "general",
          "valueType": "TEXT"
        },
        "$provider": {
          "value": "SLACK",
          "valueType": "TEXT"
        },
        "$isPublic": {
          "value": true,
          "valueType": "CHECKBOX"
        },
        "$providerChannelId": {
          "value": "C9876543210",
          "valueType": "TEXT"
        },
        "$providerCreatedAt": {
          "value": "2026-01-05T10:00:00.000Z",
          "valueType": "DATETIME"
        },
        "$includeInCrm": {
          "value": "string",
          "valueType": "CHECKBOX"
        }
      },
      "httpLink": null,
      "objectType": "channel",
      "relationships": {
        "account-slack-channel": {
          "cardinality": "has_many",
          "objectType": "account",
          "values": [
            "acc_cm0abc123def456"
          ],
          "directions": {
            "asDestination": {
              "cardinality": "HAS_ONE",
              "values": [
                "string"
              ]
            },
            "asSource": {
              "cardinality": "HAS_ONE",
              "values": [
                "string"
              ]
            }
          }
        },
        "opportunity-slack-channel": {
          "cardinality": "has_many",
          "objectType": "opportunity",
          "values": [
            "opp_cm1xyz456uvw789"
          ],
          "directions": {
            "asDestination": {
              "cardinality": "HAS_ONE",
              "values": [
                "string"
              ]
            },
            "asSource": {
              "cardinality": "HAS_ONE",
              "values": [
                "string"
              ]
            }
          }
        }
      },
      "updatedAt": "2026-04-29T15:12:00.000Z",
      "externalId": "externalId"
    }
  ],
  "object": "list",
  "totalCount": 2
}