Chatsv4

Get a chat

GET/chats/{chatId}

The chat of a group that was merged into another group on its first send returns the surviving group's chat on the same number.

Path parameters

chatIdRequiredstring

Unique identifier of the chat, prefixed with chat_. Returned by the List chats endpoint.

Headers

AuthorizationRequiredstring

Your API key, sent as a bearer token: Authorization: Bearer <api_key>. Editing this stays in sync with the API key box on the right.

Bearer

Returns

dataoptionalChat
idoptionalstring

Chat id (chat_...).

channel_idoptionalstring
channel_typeoptionalstring
"blooio""twilio""whatsapp""whatsapp_business""rcs_business""amb"
contact_idoptionalstring | null
identity_idoptionalstring | null
group_idoptionalstring | null
contactoptionalContactSummary | null

The person on the other side of a 1:1 chat. null in a group chat; see group.

ContactSummary
contact_idRequiredstring | null

The contact (ct_...). null when no contact record matches the identifier.

identifierRequiredstring

The contact's identifier (phone number, email, or handle).

nameRequiredstring | null

The contact's name. null when none is on file. On a webhook it is a snapshot from when the event happened; read the contact for current details.

null
groupoptionalGroupSummary | null

The group, when this is a group chat. null in a 1:1 chat.

GroupSummary
group_idRequiredstring

Group id (grp_...).

nameRequiredstring | null

The group's name. null when it has none.

null
stateoptionalstring
"open""closed""blocked""deprecated"
capabilitiesoptionalobject
window_expires_atoptionalinteger | null
last_message_atoptionalinteger | null
created_atoptionalinteger

Response codes

200A chat
401Your API key is missing or invalid. Pass it as a bearer token.
404No chat was found with the provided `chatId`.

Sends a live request with your values and shows the real response below. Your key is stored only in this browser.

Request
curl -X GET https://api.blooio.com/v4/chats/chat_a1b2c3d4 \
Response objectexample
{  "data": {    "id": "chat_a1b2c3d4",    "channel_id": "ch_a1b2c3d4",    "channel_type": "blooio",    "contact_id": "ct_a1b2c3d4",    "identity_id": "idn_a1b2c3d4",    "group_id": "grp_a1b2c3d4",    "contact": {      "contact_id": "ct_a1b2c3d4",      "identifier": "+15551234567",      "name": "Jane Doe"    },    "group": {      "group_id": "grp_a1b2c3d4",      "name": "Jane Doe"    },    "state": "open",    "capabilities": {},    "window_expires_at": 0,    "last_message_at": 0,    "created_at": 0  }}