Skip to main content
GET
/
v1
/
external-support
/
{projectId}
/
conversations
/
{conversationId}
Get Conversation
curl --request GET \
  --url https://gateway.jelou.ai/jelouapi/v1/external-support/{projectId}/conversations/{conversationId} \
  --header 'Authorization: Basic <encoded-value>'
{
  "message": "<string>",
  "statusMessage": "<string>",
  "status": 123,
  "error": {
    "code": "<string>",
    "key": "<string>",
    "description": "<string>",
    "developerMessages": {},
    "clientMessages": {}
  },
  "validationError": {}
}

Documentation Index

Fetch the complete documentation index at: https://docs.jelou.ai/llms.txt

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

This endpoint does not emit any event to the webhook. It is a read-only query to retrieve the current status of a conversation.

​
Description

Retrieves the details and current status of a specific conversation. Returns information about the user, the associated bot, start and close dates, and the end reason if applicable.

​
Endpoint

GET https://gateway.jelou.ai/jelouapi/v1/external-support/{projectId}/conversations/{conversationId}

​
Path parameters

​
projectId
string
required
Unique identifier of the Jelou project the conversation belongs to.
​
conversationId
string
required
Unique identifier of the conversation you want to retrieve.

​
Authentication

All requests must include the x-api-key header with your Jelou project API key. 
x-api-key: API_KEY

​
Request example

The following example retrieves the details of conversation CONVERSATION_ID within project PROJECT_ID:
cURL
curl --request GET \
  --url https://gateway.jelou.ai/jelouapi/v1/external-support/PROJECT_ID/conversations/CONVERSATION_ID \
  --header 'x-api-key: API_KEY'

​
Responses

CodeStatusDescription
200OKConversation found. Returns the conversation details.
401UnauthorizedInvalid or missing authentication credentials.
404Not FoundConversation not found for the specified identifiers.
500Internal Server ErrorInternal server error.

​
Response example

{
  "message": [
    "Conversation retrieved successfully"
  ],
  "statusMessage": "success",
  "status": 1,
  "data": {
    "_id": "CONVERSATION_ID",
    "roomId": "ROOM_ID",
    "state": "closed",
    "startAt": "2026-01-15T10:30:00.000Z",
    "endAt": "2026-01-15T10:45:00.000Z",
    "endedReason": "closed_by_operator",
    "User": {
      "id": "USER_ID",
      "names": "USER_NAME",
      "referenceId": "USER_REFERENCE_ID",
      "createdAt": "2025-01-28T20:54:25.572Z"
    },
    "Bot": {
      "id": "BOT_ID",
      "name": "BOT_NAME",
      "type": "Whatsapp"
    }
  }
}

​
Response structure

FieldTypeDescription
data._idstringUnique identifier of the conversation.
data.roomIdstringConversation room identifier.
data.statestringConversation state: active or closed.
data.startAtdateDate and time the conversation started.
data.endAtdateDate and time of closing. Present only if the conversation is closed.
data.endedReasonstringClose reason: closed_by_operator.
data.User.idstringEnd user identifier.
data.User.namesstringEnd user name.
data.User.referenceIdstringExternal reference identifier of the user.
data.Bot.idstringIdentifier of the bot that handled the conversation.
data.Bot.namestringBot name.
data.Bot.typestringBot channel (for example: Whatsapp).

Authorizations

​
Authorization
string
header
required

Basic authentication using Base64 encoded clientId:clientSecret

Path Parameters

​
projectId
string
required

Unique identifier of the Jelou project

​
conversationId
string
required

Unique identifier of the conversation

Response

Conversation retrieved successfully