v19

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

List channels

Returns a paginated list of channels. 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 org-wide-visible providers). See <u>List endpoints</u> for more information about pagination.

Required scope: channels:read

Rate limit category: Search

get/v1/channels

Query parameters

offsetinteger

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

limitinteger

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

Headers

Lightfield-Version'2026-03-01' required

Required API version header. Requests may error without it.

Response

OK

objectstring required

The object type, always "list".

totalCountinteger required

Total number of entities matching the query.

Example response

{
  "object": "list",
  "data": [
    {
      "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"
    },
    {
      "id": "chn_cm3ghi789jkl012",
      "createdAt": "2026-04-29T15:12:00.000Z",
      "updatedAt": "2026-04-29T15:12:00.000Z",
      "httpLink": null,
      "fields": {
        "$name": {
          "valueType": "TEXT",
          "value": "general"
        },
        "$provider": {
          "valueType": "TEXT",
          "value": "SLACK"
        },
        "$isPublic": {
          "valueType": "CHECKBOX",
          "value": true
        },
        "$providerChannelId": {
          "valueType": "TEXT",
          "value": "C9876543210"
        },
        "$providerCreatedAt": {
          "valueType": "DATETIME",
          "value": "2026-01-05T10:00:00.000Z"
        }
      },
      "relationships": {},
      "objectType": "channel"
    }
  ],
  "totalCount": 2
}