API Reference

Authentication

All API requests require authentication using your API key in the Authorization header:

Authorization: Bearer YOUR_API_KEY

Base URL

Endpoints

Get Conversations

Retrieve all conversations for a customer session.

GET {api_base_url}/api/v1/helpdesk/customer/{session_id}/conversations/

Parameters

string

required

Unique identifier for the customer session

Query Parameters

boolean

Filter conversations by status. Accepts: true, t, yes, 1 (true), anything else is false

Response

array

Array of conversation objects

Conversation Object:

string

Unique conversation identifier

string

ISO timestamp of creation

string

ISO timestamp of last update

boolean

Whether the conversation is closed

boolean

Whether support closure was requested

boolean

Customer read status

boolean

Agent read status

string

Current responder: "agent" or "sate"

string

Ticket identifier

string

Ticket slug for URLs

object

Most recent message in the conversation

Example Response

[
  {
    "id": "conv_123",
    "date_created": "2024-01-15T10:30:00Z",
    "date_updated": "2024-01-15T11:45:00Z",
    "closed": false,
    "close_support": false,
    "read_by_customer": true,
    "read_by_agent": false,
    "responder": "sate",
    "ticket": "ticket_456",
    "ticket_slug": "customer-inquiry-456",
    "latest_message": {
      "id": "msg_789",
      "date_created": "2024-01-15T11:45:00Z",
      "date_updated": "2024-01-15T11:45:00Z",
      "message": "I can help you with that issue.",
      "sender": "sate",
      "is_attachment": false,
      "attachment_metadata": null,
      "ticket_chat": "conv_123"
    }
  }
]

Status Codes

Success

Conversations retrieved successfully

Bad Request

Invalid parameters or malformed request

Unauthorized

Invalid or missing API key

Forbidden

Access denied for this resource

Get Conversation Messages

Retrieve all messages for a specific conversation.

GET {api_base_url}/api/v1/helpdesk/customer/{session_id}/conversations/{conversation_id}/messages/

Parameters

string

required

Unique identifier for the customer session

string

required

Unique identifier for the conversation

Response

string

Conversation identifier

string

ISO timestamp of creation

string

ISO timestamp of last update

boolean

Whether the conversation is closed

boolean

Whether support closure was requested

boolean

Customer read status

boolean

Agent read status

string

Current responder: "agent" or "sate"

string

Ticket identifier

array

Array of message objects in chronological order

Message Object:

string

Unique message identifier

string

ISO timestamp of creation

string

ISO timestamp of last update

string

Message content

string

Message sender: "sate", "agent", or "customer"

boolean

Whether this message contains an attachment

object

Attachment details (if is_attachment is true)

string

Associated conversation ID

Example Response

{
  "id": "conv_123",
  "date_created": "2024-01-15T10:30:00Z",
  "date_updated": "2024-01-15T11:45:00Z",
  "closed": false,
  "close_support": false,
  "read_by_customer": true,
  "read_by_agent": false,
  "responder": "sate",
  "ticket": "ticket_456",
  "messages": [
    {
      "id": "msg_001",
      "date_created": "2024-01-15T10:30:00Z",
      "date_updated": "2024-01-15T10:30:00Z",
      "message": "Hello, I need help with my order",
      "sender": "customer",
      "is_attachment": false,
      "attachment_metadata": null,
      "ticket_chat": "conv_123"
    },
    {
      "id": "msg_002",
      "date_created": "2024-01-15T10:31:00Z",
      "date_updated": "2024-01-15T10:31:00Z",
      "message": "I'd be happy to help you with your order. Could you provide your order number?",
      "sender": "sate",
      "is_attachment": false,
      "attachment_metadata": null,
      "ticket_chat": "conv_123"
    }
  ]
}

Status Codes

Success

Messages retrieved successfully

Bad Request

Invalid parameters or malformed request

Unauthorized

Invalid or missing API key

Forbidden

Access denied for this resource

Error Responses

All error responses follow this format:

{
  "detail": "Error description explaining what went wrong"
}

Next Steps

Socket.IO Events for real-time messaging
SDK Integration for easier implementation

Helpdesk API

DevSpace API

Authentication

Base URL

Endpoints

Get Conversations

Parameters

Query Parameters

Response

Example Response

Status Codes

Get Conversation Messages

Parameters

Response

Example Response

Status Codes

Error Responses

Next Steps

​Authentication

​Base URL

​Endpoints

​Get Conversations

​Parameters

​Query Parameters

​Response

​Example Response

​Status Codes

​Get Conversation Messages

​Parameters

​Response

​Example Response

​Status Codes

​Error Responses

​Next Steps

Authentication

Base URL

Endpoints

Get Conversations

Parameters

Query Parameters

Response

Example Response

Status Codes

Get Conversation Messages

Parameters

Response

Example Response

Status Codes

Error Responses

Next Steps