Chats

List all chats

Retrieves a paginated list of chats for the authenticated partner.

Filtering:

  • If from is provided, returns chats for that specific phone number
  • If from is omitted, returns chats across all phone numbers owned by the partner
  • If to is provided, only returns chats where the specified handle is a participant

Pagination:

  • Use limit to control page size (default: 20, max: 100)
  • The response includes next_cursor for fetching the next page
  • When next_cursor is null, there are no more results to fetch
  • Pass the next_cursor value as the cursor parameter for the next request

Example pagination flow:

  1. First request: GET /v3/chats?from=%2B12223334444&limit=20
  2. Response includes next_cursor: "20" (more results exist)
  3. Next request: GET /v3/chats?from=%2B12223334444&limit=20&cursor=20
  4. Response includes next_cursor: null (no more results)
get/v3/chats

Request

  • Base URL: https://api.linqapp.com/api/partner
  • URL: https://api.linqapp.com/api/partner/v3/chats
  • Auth: HTTP bearer

Query parameters

fromstring
Example:+13343284472

Phone number to filter chats by. Returns chats made from this phone number. Must be in E.164 format (e.g., +13343284472). The + is automatically URL-encoded by HTTP clients. If omitted, returns chats across all phone numbers owned by the partner.

tostring
Example:+13343284472

Filter chats by a participant handle. Only returns chats where this handle is a participant. Can be an E.164 phone number (e.g., +13343284472) or an email address (e.g., user@example.com). For phone numbers, the + is automatically URL-encoded by HTTP clients.

limitinteger
Example:20

Maximum number of chats to return per page

cursorstring
Example:20

Pagination cursor from the previous response's next_cursor field. Omit this parameter for the first page of results.

Response

List of chats retrieved successfully

next_cursorstring nullable

Cursor for fetching the next page of results. Null if there are no more results to fetch. Pass this value as the cursor parameter in the next request.

Example response

{
  "chats": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "display_name": "+14155551234, +14155559876",
      "group_chat_icon": "https://example.com/group-icon.png",
      "service": "iMessage",
      "handles": [
        {
          "id": "550e8400-e29b-41d4-a716-446655440010",
          "handle": "+14155551234",
          "service": "iMessage",
          "status": "active",
          "joined_at": "2025-05-21T15:30:00.000Z",
          "is_me": true
        },
        {
          "id": "550e8400-e29b-41d4-a716-446655440011",
          "handle": "+14155559876",
          "service": "iMessage",
          "status": "active",
          "joined_at": "2025-05-21T15:30:00.000Z",
          "is_me": false
        }
      ],
      "created_at": "2024-01-15T10:30:00Z",
      "updated_at": "2024-01-15T10:30:00Z",
      "health_status": {
        "status": "AT_RISK",
        "doc_url": "https://docs.linqapp.com/channel/imessage/guides/chats/chat-health#at-risk",
        "updated_at": "2026-05-01T18:28:25Z"
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.