Skip to main content
GET
/
chat
/
findChatByRemoteJid
/
:instanceName
curl --request GET \
  --url 'https://api.example.com/chat/findChatByRemoteJid/my-instance?remoteJid=5511999999999@s.whatsapp.net' \
  --header 'apikey: YOUR_API_KEY'

{
  "id": "chat_123",
  "remoteJid": "5511999999999@s.whatsapp.net",
  "owner": "my-instance",
  "isGroup": false,
  "name": "John Doe",
  "profilePictureUrl": "https://example.com/profile.jpg",
  "createdAt": "2024-03-04T10:30:00.000Z",
  "updatedAt": "2024-03-04T12:45:00.000Z"
}

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/EvolutionAPI/evolution-api/llms.txt

Use this file to discover all available pages before exploring further.

​
Overview

You can retrieve detailed information about a specific chat using its remote JID. This is useful when you need to get chat details before sending messages or performing chat-specific operations.

​
Authentication

This endpoint requires authentication via the apikey header.
​
header.apikey
string
required
Your Evolution API key for authentication.

​
Path Parameters

​
path.instanceName
string
required
The name of your WhatsApp instance.

​
Query Parameters

​
remoteJid
string
required
The WhatsApp JID of the chat you want to find. For individual chats, use the format 5511999999999@s.whatsapp.net. For groups, use the format 120363123456789@g.us.

​
Response

​
id
string
Unique chat identifier.
​
remoteJid
string
WhatsApp JID of the chat.
​
owner
string
Instance owner.
​
isGroup
boolean
Whether this is a group chat.
​
name
string
Chat display name.
​
profilePictureUrl
string
URL of the chat’s profile picture.
​
createdAt
string
ISO 8601 timestamp of when the chat was created.
​
updatedAt
string
ISO 8601 timestamp of last update.
curl --request GET \
  --url 'https://api.example.com/chat/findChatByRemoteJid/my-instance?remoteJid=5511999999999@s.whatsapp.net' \
  --header 'apikey: YOUR_API_KEY'

{
  "id": "chat_123",
  "remoteJid": "5511999999999@s.whatsapp.net",
  "owner": "my-instance",
  "isGroup": false,
  "name": "John Doe",
  "profilePictureUrl": "https://example.com/profile.jpg",
  "createdAt": "2024-03-04T10:30:00.000Z",
  "updatedAt": "2024-03-04T12:45:00.000Z"
}

​
Usage Notes

The remoteJid format varies based on chat type:
  • Individual chats: {phone_number}@s.whatsapp.net
  • Group chats: {group_id}@g.us
  • Broadcast lists: {broadcast_id}@broadcast
Use this endpoint before sending messages to verify that a chat exists and is accessible.