v19

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

List messages

Returns a paginated list of messages. Use offset and limit to paginate through results. Each message is filtered per caller to those whose channel they may see, and includes a read-only accessLevel. See <u>List endpoints</u> for more information about pagination.

Required scope: messages:read

Rate limit category: Search

get/v1/messages

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

objectstring required

The object type, always "list".

totalCountinteger required

Total number of entities matching the query.

Example response

{
  "object": "list",
  "data": [
    {
      "id": "msg_cm0abc456def789",
      "createdAt": "2026-05-01T09:00:00.000Z",
      "updatedAt": "2026-05-01T09:00:00.000Z",
      "httpLink": null,
      "fields": {
        "$text": {
          "valueType": "TEXT",
          "value": "Thanks — pushed the fix, should be live shortly."
        },
        "$sentAt": {
          "valueType": "DATETIME",
          "value": "2026-05-01T08:59:30.000Z"
        },
        "$provider": {
          "valueType": "TEXT",
          "value": "SLACK"
        },
        "$providerThreadId": {
          "valueType": "TEXT",
          "value": "1714553970.123456"
        },
        "$editedAt": {
          "valueType": "DATETIME",
          "value": null
        }
      },
      "relationships": {
        "$channel": {
          "cardinality": "has_one",
          "objectType": "channel",
          "values": [
            "chn_cm2def456ghi789"
          ]
        }
      },
      "objectType": "message",
      "accessLevel": "FULL"
    },
    {
      "id": "msg_cm1xyz123uvw456",
      "createdAt": "2026-04-29T15:12:00.000Z",
      "updatedAt": "2026-04-29T15:12:00.000Z",
      "httpLink": null,
      "fields": {
        "$text": {
          "valueType": "TEXT",
          "value": "Can we sync on pricing tomorrow?"
        },
        "$sentAt": {
          "valueType": "DATETIME",
          "value": "2026-04-29T15:11:30.000Z"
        },
        "$provider": {
          "valueType": "TEXT",
          "value": "SLACK"
        },
        "$providerThreadId": {
          "valueType": "TEXT",
          "value": null
        },
        "$editedAt": {
          "valueType": "DATETIME",
          "value": null
        }
      },
      "relationships": {
        "$channel": {
          "cardinality": "has_one",
          "objectType": "channel",
          "values": [
            "chn_cm2def456ghi789"
          ]
        }
      },
      "objectType": "message",
      "accessLevel": "FULL"
    }
  ],
  "totalCount": 2
}