Skip to main content

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

HeaderValue
AuthorizationBearer

Path parameters

conversation_id
string (UUID)
required
The UUID of the conversation to retrieve.

Response

id
string (UUID)
Unique identifier for the conversation.
business_id
string (UUID)
The business this conversation belongs to.
customer_id
string (UUID) | null
The associated customer’s UUID.
assignee_id
string (UUID) | null
The assigned agent’s UUID, or null if unassigned.
status
string
Current status. One of "open", "pending", "resolved", or "closed".
channel_type
string
The channel this conversation came through.
channel_id
string (UUID) | null
The channel record this conversation is linked to.
created_at
string (ISO 8601)
Timestamp when the conversation was created.
updated_at
string (ISO 8601)
Timestamp when the conversation was last updated.
first_response_at
string (ISO 8601) | null
Timestamp of the first agent response, used for SLA tracking.
customer
object | null
Embedded customer object.
messages
array
Full list of messages in this conversation, ordered chronologically.

Example

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

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

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