Chats

Get a chat by ID

Retrieve a chat by its unique identifier.

get/v3/chats/{chatId}

Request

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

Path parameters

chatIdstring uuid required
Example:550e8400-e29b-41d4-a716-446655440000

Unique identifier of the chat

Response

Chat found and returned successfully

idstring uuid required

Unique identifier for the chat

display_namestring nullable required

Display name for the chat. Defaults to a comma-separated list of recipient handles. Can be updated for group chats.

group_chat_iconstring uri nullable

URL of the group chat icon. Only set for group chats that have an icon; null otherwise.

service'iMessage' | 'SMS' | 'RCS'

Messaging service type. Where this names the transport a message used, it is per-message: a chat's own service can differ from a message in it, and Apple can downgrade an individual message.

is_archivedboolean required

DEPRECATED: This field is deprecated and will be removed in a future API version.

is_groupboolean required

Whether this is a group chat

created_atstring date-time required

When the chat was created

updated_atstring date-time required

When the chat was last updated

Example response

{
  "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.