Free setup on annual plans
Sign up today!
API Reference
API Reference
API Reference
Welcome to the AnswerPal API Reference. Here you’ll find everything you need to integrate, automate, and extend AnswerPal using our secure and flexible RESTful API. Browse the sections below to get started, find endpoint documentation, and access best practices for robust integrations.
Introduction
AnswerPal provides a comprehensive, RESTful API to automate, extend, and integrate every aspect of your customer service, support, and communications workflows. Whether you’re building custom integrations, automating ticket handling, or connecting AnswerPal with your CRM, ERP, or other tools, our API gives you secure, flexible, and scalable access to all platform features.
RESTful JSON API
Standard HTTP methods and JSON payloads for easy integration.
Secure Authentication
Issue JWT bearer tokens for representatives and phone contexts, request password resets and support internal customer impersonation.
Real-Time Automation
Trigger workflows and actions instantly with webhooks and events.
Extensible & Flexible
Map custom fields, connect to external APIs, and tailor workflows to your needs.
Authentication
POST /api/Auth/login and send it as Authorization: Bearer <token>. Public callback, tracking, tokenized file and phone-auth endpoints are marked separately in the endpoint directory. Fields such as OverrideApiAuthenticationType on actions, documents or customer settings are outbound connector settings for API calls that AnswerPal makes to external systems; they are not inbound AnswerPal API authentication.Endpoints Overview
AnswerPalAPI controller routes, open the Endpoints page.💳
Costs and Subscription
Subscription plan, storage usage and cost reporting endpoints.
🧩
Customer Custom Fields
Customer-level custom field definitions and DTOs.
🏢
Customers
Customer account settings, connector credentials, model defaults and secrets.
📄
Documents
Prompt documents, knowledge documents and conversion endpoints.
❌
Error Codes
HTTP status codes, validation errors and common API failure patterns.
🏠
Place Descriptions
Place-description reports, rooms, photos and DOCX export.
👥
Representatives
Representative accounts, roles, lifecycle, passwords and signatures.
💬
Ticket Messages
Messages, drafts, AI replies, sending, attachments, escalation and message topics.
🎫
Tickets
Ticket lifecycle, search, assignment, bulk updates, playback and history.
🎙️
Voice and Transcription
Twilio calls, realtime sessions, audio chunks and transcription.
✅
Best Practices
Follow our best practices guide to ensure secure, reliable, and efficient API integrations. Topics include authentication, error handling, data validation, and performance optimization.
FAQ
Yes, all endpoints require a valid access token unless otherwise noted.
Each endpoint’s detail page includes example requests and responses.
Yes, all endpoints follow REST conventions using standard HTTP methods.
Support
Table of Contents
AnswerPal: AI-powered customer service solutions to elevate your support and communication effortlessly.
Quick Links
Contact
For all support, sales, and partnership inquiries, email us at info@answerpal.eu
AnswerPal
Bisschoppenhoflaan 380
2100 Antwerp
Belgium
+32.36416685
BE 0862.692.858