Skip to main content

​
Base URL

https://app.phonebot.io

​
Authentication

All API endpoints require Bearer token authentication: 
curl -X GET "https://app.phonebot.io/api/v1/vendors" \
  -H "Authorization: Bearer YOUR_API_TOKEN"

​
Response format

All responses follow a consistent structure: 
{
  "success": true,
  "message": "Human-readable message",
  "data": { },
  "timestamp": "2025-04-17T14:23:30Z",
  "traceId": "correlation-id"
}

​
Paginated responses

List endpoints return paginated data: 
{
  "success": true,
  "data": [],
  "page": 0,
  "size": 20,
  "totalElements": 100,
  "totalPages": 5,
  "timestamp": "2025-04-17T14:23:30Z"
}

​
Pagination parameters

ParameterTypeDefaultDescription
pageinteger0Page number (0-indexed)
sizeinteger20Items per page
sortstringname,ascSort criteria (e.g., name,desc)

​
Path parameters

All resource endpoints use UUID identifiers:
  • vendorId - Vendor identifier
  • organizationId - Organization identifier
  • assistantId - Assistant identifier
  • agentId - Agent identifier
  • planId - Plan identifier

​
Error responses

StatusDescription
400Bad Request - Invalid input data
401Unauthorized - Invalid or missing token
403Forbidden - Insufficient permissions
404Not Found - Resource does not exist
409Conflict - Resource cannot be modified (e.g., dependencies exist)