Find Chat by JID

Find a specific chat by its remote JID (WhatsApp ID).

GET /chat/findChatByRemoteJid/:instanceName

cURL

curl --request GET \
  --url 'https://api.example.com/chat/findChatByRemoteJid/my-instance?remoteJid=[e-mail]' \
  --header 'apikey: YOUR_API_KEY'

const remoteJid = encodeURIComponent('[e-mail]');

const response = await fetch(
  `https://api.example.com/chat/findChatByRemoteJid/my-instance?remoteJid=${remoteJid}`,
  {
    method: 'GET',
    headers: {
      'apikey': 'YOUR_API_KEY'
    }
  }
);

const data = await response.json();

import requests
import urllib.parse

remote_jid = urllib.parse.quote('[e-mail]')

response = requests.get(
    f'https://api.example.com/chat/findChatByRemoteJid/my-instance?remoteJid={remote_jid}',
    headers={'apikey': 'YOUR_API_KEY'}
)

data = response.json()

200 Success

{
  "id": "chat_123",
  "remoteJid": "[e-mail]",
  "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"
}

{
  "error": "remoteJid is a required query parameter"
}

{
  "error": "Unauthorized",
  "message": "Invalid API key"
}

{
  "error": "Chat not found",
  "message": "No chat found with the specified remoteJid"
}

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 [e-mail]. For groups, use the format [e-mail].

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

curl --request GET \
  --url 'https://api.example.com/chat/findChatByRemoteJid/my-instance?remoteJid=[e-mail]' \
  --header 'apikey: YOUR_API_KEY'

const remoteJid = encodeURIComponent('[e-mail]');

const response = await fetch(
  `https://api.example.com/chat/findChatByRemoteJid/my-instance?remoteJid=${remoteJid}`,
  {
    method: 'GET',
    headers: {
      'apikey': 'YOUR_API_KEY'
    }
  }
);

const data = await response.json();

import requests
import urllib.parse

remote_jid = urllib.parse.quote('[e-mail]')

response = requests.get(
    f'https://api.example.com/chat/findChatByRemoteJid/my-instance?remoteJid={remote_jid}',
    headers={'apikey': 'YOUR_API_KEY'}
)

data = response.json()

200 Success

{
  "id": "chat_123",
  "remoteJid": "[e-mail]",
  "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"
}

{
  "error": "remoteJid is a required query parameter"
}

{
  "error": "Unauthorized",
  "message": "Invalid API key"
}

{
  "error": "Chat not found",
  "message": "No chat found with the specified remoteJid"
}

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.