ConversationsGET

Get conversation

Returns one conversation in real time. Pass conversation_id as a query parameter (equal to the value returned by List conversations). The response always includes conversation_id / type / title / avatar_url (empty string when missing) plus type-specific fields such as members_count for groups; returns 404 when the conversation cannot be found.

https://api.unifyport.ai/v1/accounts/{account_id}/conversations/info

Headers

X-Api-Key

stringrequired

Workspace API key. The workspace is resolved from this header.

Path parameters

account_id

stringrequired

Identifier used in the conversations route.

Query parameters

conversation_id

stringrequired

Conversation to look up — the value returned as conversation_id by List conversations.

type

string

Conversation type (user, group, or channel) to disambiguate the lookup.

enum: user, group, channel

Request body

This endpoint does not require a JSON request body.

Response body

conversation_id

string

Conversation identifier. Use it as the target when sending messages or calling conversation routes.

type

string

Conversation type: user, group, or channel.

enum: user, group, channel

title

string

Display title of the conversation.

username

string

Provider username for the conversation, when available.

avatar_url

string

Avatar URL, or an empty string when none is set.

description

string

Group or channel description, when available.

last_message_at

string

RFC3339 timestamp of the most recent message.

format: date-time

last_message_text

string

Text preview of the most recent message, when available.

unread_count

integer

Number of unread messages in the conversation.

format: int64

members_count

integer

Number of members; returned for group conversations.

format: int64

subscribers_count

integer

Subscriber count for channel-style conversations, when available.

format: int64

is_pinned

boolean

Whether the connected account pinned the conversation.

is_muted

boolean

Whether the connected account muted the conversation.

created_at

string

Provider-reported conversation creation time, when available.

format: date-time

extra

object

Provider-specific fields not represented by the standard schema.

Responses

200

200 OK

Request succeeded. See the example response body.

400

Bad Request

The request body, path, or parameters are invalid.

401

Unauthorized

The X-Api-Key header is missing or invalid.

404

Not Found

The requested provider resource could not be found.

409

Conflict

The requested operation conflicts with an existing provider account or resource.

500

Internal Server Error

The service encountered an unexpected error.

501

Not Implemented

The selected provider does not implement this operation.

502

Bad Gateway

The provider adapter or upstream provider could not complete the operation.

Request

curl -X GET https://api.unifyport.ai/v1/accounts/{account_id}/conversations/info?conversation_id=peer_example&type=group \
  -H "X-Api-Key: <YOUR_API_KEY>"

Response

{
  "data": {
    "conversation_id": "peer_example",
    "type": "group",
    "title": "Group title",
    "avatar_url": "",
    "description": "...",
    "unread_count": 0,
    "members_count": 42
  }
}