Chat

Get a chat conversation

Returns one conversation in the shape of a GET /chat/threads row: the creator or group identity, the latest-message preview, updatedAt, and the caller's unread count and pin, archive and mute state. An API key reaches its own organization's conversations only.

get/chat/threads/{chatId}

Request

  • Base URL: https://viral.app/api/v1
  • URL: https://viral.app/api/v1/chat/threads/{chatId}
  • Auth: API key in header x-api-key

Path parameters

chatIdstring required

Response

OK

orgIdstring required
kind'direct' | 'group'
creatorUserIdstring nullable required
creatorNamestring nullable required
creatorEmailstring nullable required
creatorImagestring nullable required
creatorEmailVerifiedboolean nullable
orgNamestring required
orgLogostring nullable required
relationship'active' | 'application' | 'past' nullable required
titlestring nullable
publicTitlestring nullable
groupKind'manual' | 'campaign' | 'all' nullable
campaignIdstring nullable
memberCountinteger
lastMessageSenderUserIdstring nullable
lastMessageSenderNamestring nullable
creatorOrgCreatorIdstring nullable
creatorIsMarketplaceCreatorboolean
creatorNeedsPlatformInviteboolean
lastMessageAtstring date-time required
updatedAtstring date-time nullable
lastMessageIdstring nullable
lastMessagePreviewstring nullable required
lastMessageDeletedboolean required
lastMessageSenderType'org' | 'creator' | 'system' nullable required
unreadCountinteger required
pinnedboolean required
archivedboolean required
mutedboolean
draftboolean

Changes

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