POpostproxy
Direct Messages

Get chat

Fetch a single chat by Postproxy hashid or by external_conversation_id.

get/api/chats/{id}

Request

  • Base URL
    https://api.postproxy.dev
  • URL
    https://api.postproxy.dev/api/chats/{id}
  • Auth
    HTTP bearer

Query parameters

profile_group_idstring

Profile group context for the request. Optional when the API key is scoped to a profile group (that group is used automatically); with a full-access key, defaults to the first profile group in the account.

Response

The chat.

idstring

Chat hashid

profile_idstring

Profile hashid this chat belongs to

platform'facebook' | 'instagram' | 'telegram' | 'bluesky'

Network ID

participant_external_idstring

Platform-native participant ID

participant_usernamestring nullable

Participant's username (when known)

participant_namestring nullable

Participant's display name (when known)

participant_avatar_urlstring nullable

Stable storage URL of the participant's profile picture (null until fetched)

external_conversation_idstring nullable

Platform's native conversation ID (when known)

last_inbound_atstring nullable

ISO 8601 timestamp of last inbound message

last_outbound_atstring nullable

ISO 8601 timestamp of last outbound message

last_message_atstring nullable

ISO 8601 timestamp of last message in either direction

archivedboolean

Bluesky only — whether the chat is muted/archived

created_atstring

ISO 8601 timestamp of chat creation

external_placement_idstring nullable

The placement the chat runs on — the phone number id on WhatsApp, the Page id on Facebook chats that have one. Null otherwise.

groupboolean

True when the chat is a WhatsApp group rather than a 1:1 conversation.

within_messaging_windowboolean

WhatsApp only. Whether a free-form send is currently allowed — true for 24 hours after the customer’s last inbound message or referral. Outside it, send an approved template.

Changes

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