Get Conversation

Overview

Retrieves a single conversation by ID, including the associated customer and the complete message history. Only conversations belonging to your business are accessible.

Request

Method: GET URL: /api/v1/conversations/{conversation_id}

Headers

Header	Value
Authorization	Bearer

Path parameters

string (UUID)

required

The UUID of the conversation to retrieve.

Response

string (UUID)

Unique identifier for the conversation.

string (UUID)

The business this conversation belongs to.

string (UUID) | null

The associated customer’s UUID.

string (UUID) | null

The assigned agent’s UUID, or null if unassigned.

string

Current status. One of "open", "pending", "resolved", or "closed".

string

The channel this conversation came through.

string (UUID) | null

The channel record this conversation is linked to.

string (ISO 8601)

Timestamp when the conversation was created.

string (ISO 8601)

Timestamp when the conversation was last updated.

string (ISO 8601) | null

Timestamp of the first agent response, used for SLA tracking.

object | null

Embedded customer object.

Show customer fields

integer

Customer ID.

string | null

Customer’s display name.

string | null

Customer’s email address.

string | null

Customer’s phone number.

string | null

Your system’s identifier for this customer.

string (ISO 8601)

Timestamp when the customer record was created.

array

Full list of messages in this conversation, ordered chronologically.

Show message fields

string (UUID)

Unique identifier for the message.

string (UUID)

The conversation this message belongs to.

string

Who sent the message. One of "agent" or "customer".

string (UUID) | null

UUID of the agent who sent the message, or null for customer messages.

string

The text content of the message.

array

List of attachment objects, if any.

string (ISO 8601)

Timestamp when the message was sent.

Example

curl https://api.pingback.live/api/v1/conversations/c3d4e5f6-a7b8-9012-cdef-123456789012 \
  -H "Authorization: Bearer YOUR_TOKEN"

const conversationId = 'c3d4e5f6-a7b8-9012-cdef-123456789012';
const response = await fetch(
  `https://api.pingback.live/api/v1/conversations/${conversationId}`,
  {
    headers: {
      'Authorization': `Bearer ${token}`,
    },
  }
);
const conversation = await response.json();

Response example

{
  "id": "c3d4e5f6-a7b8-9012-cdef-123456789012",
  "business_id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
  "customer_id": "d4e5f6a7-b8c9-0123-defa-234567890123",
  "assignee_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "status": "open",
  "channel_type": "widget",
  "channel_id": "e5f6a7b8-c9d0-1234-efab-345678901234",
  "created_at": "2024-03-01T09:00:00Z",
  "updated_at": "2024-03-01T09:20:00Z",
  "first_response_at": "2024-03-01T09:05:00Z",
  "customer": {
    "id": 42,
    "business_id": 7,
    "name": "Alex Johnson",
    "email": "alex@example.com",
    "phone": null,
    "external_id": null,
    "created_at": "2024-02-20T08:00:00Z"
  },
  "messages": [
    {
      "id": "f6a7b8c9-d0e1-2345-fabc-456789012345",
      "conversation_id": "c3d4e5f6-a7b8-9012-cdef-123456789012",
      "sender_type": "customer",
      "sender_id": null,
      "content": "Hello, I need help with my order.",
      "attachments": [],
      "created_at": "2024-03-01T09:00:00Z"
    },
    {
      "id": "g7b8c9d0-e1f2-3456-abcd-567890123456",
      "conversation_id": "c3d4e5f6-a7b8-9012-cdef-123456789012",
      "sender_type": "agent",
      "sender_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "content": "Hi Alex! Happy to help. Can you share your order number?",
      "attachments": [],
      "created_at": "2024-03-01T09:05:00Z"
    }
  ]
}

Errors

Status	Meaning
401	Unauthorized — missing or invalid Bearer token
404	Conversation not found or does not belong to your business

Authentication

Conversations

Channels & Widget

Team

Knowledge Base

Analytics

Overview

Request

Headers

Path parameters

Response

Example

Response example

Errors

​Overview

​Request

​Headers

​Path parameters

​Response

​Example

​Response example

​Errors

Overview

Request

Headers

Path parameters

Response

Example

Response example

Errors