Free setup on annual plans

Sign up today!
Book a Demo

Endpoints

Home >

API Reference >

Endpoints

API Reference: Endpoints Overview

Explore the current AnswerPal REST API endpoint groups. The generated directory below lists the routes currently exposed by the API project, with method, path and access model for each public integration surface.

Diagram illustrating AnswerPal's API endpoints, including tickets, channels, customers, end users, actions, documents, topics, translations, and webhooks, all connecting through the central AnswerPal API.

Current endpoint directory

This directory is generated from the current AnswerPalAPI controller routes. It reflects the REST endpoints currently exposed by the API project.

190HTTP endpoints
35endpoint groups
JWTBearer authentication
v1OpenAPI document name
Base URL: https://api.answerpal.eu. Authenticated endpoints use Authorization: Bearer <token>. Token, callback, tracking and tokenized file endpoints are marked separately below. Use the documented endpoint groups below for integration planning; verify deployment-specific OpenAPI access in your environment.

Core platform

Auth (5)

Issue JWTs, phone tokens, impersonation tokens and password reset flows. Auth guide

MethodPathAccess
POST/api/Auth/impersonate-by-customerNo bearer token
POST/api/Auth/loginNo bearer token
POST/api/Auth/phone-loginNo bearer token
POST/api/Auth/request-password-resetNo bearer token
POST/api/Auth/reset-passwordNo bearer token
Customers (7)

Read and update the current customer profile, account secrets, model settings and storage routes. Customers guide Costs and Subscription guide

MethodPathAccess
GET/api/Customers/meBearer JWT
PUT/api/Customers/meBearer JWT
GET/api/Customers/modelsBearer JWT
GET/api/Customers/my-secretsBearer JWT (PhoneAuthOnly)
GET/api/Customers/storage-statusBearer JWT
GET/api/Customers/storage-usageBearer JWT (ViewReports)
POST/api/Customers/storage-usage/recalculateBearer JWT (ViewReports)
CustomerReps (14)

Create and manage representatives, user roles, signatures and account state. Representatives guide

MethodPathAccess
GET/api/CustomerRepsBearer JWT (ManageUsers)
POST/api/CustomerRepsPublic/callback
GET/api/CustomerReps/assignableBearer JWT (Roles nameof(UserRole.Administrator)
GET/api/CustomerReps/meBearer JWT
DELETE/api/CustomerReps/{id}Bearer JWT (ManageUsers)
GET/api/CustomerReps/{id}Bearer JWT (ManageUsers)
PUT/api/CustomerReps/{id}Bearer JWT
POST/api/CustomerReps/{id}/activateBearer JWT (ManageUsers)
PUT/api/CustomerReps/{id}/change-passwordBearer JWT
POST/api/CustomerReps/{id}/deactivateBearer JWT (ManageUsers)
GET/api/CustomerReps/{id}/signaturesBearer JWT
POST/api/CustomerReps/{id}/signaturesBearer JWT
DELETE/api/CustomerReps/{id}/signatures/{lang}Bearer JWT
GET/api/CustomerReps/{id}/signatures/{lang}Bearer JWT
Subscription (1)

Return plan, limits and feature flags for the current user. Costs and Subscription guide

MethodPathAccess
GET/api/Subscription/meBearer JWT
Customer costs (3)

Report daily, monthly and yearly usage costs. Costs and Subscription guide

MethodPathAccess
GET/api/customer-costs/dailyBearer JWT (ViewReports)
GET/api/customer-costs/monthlyBearer JWT (ViewReports)
GET/api/customer-costs/yearlyBearer JWT (ViewReports)
CustomerCustomFields (5)

Manage customer-level custom field definitions. Customer Custom Fields guide

MethodPathAccess
GET/api/CustomerCustomFieldsBearer JWT
POST/api/CustomerCustomFieldsBearer JWT
DELETE/api/CustomerCustomFields/{id}Bearer JWT
GET/api/CustomerCustomFields/{id}Bearer JWT
PUT/api/CustomerCustomFields/{id}Bearer JWT

Channels and users

Channels (12)

Manage communication channels, routing, topic policy, imports and connection tests. Channels guide

MethodPathAccess
GET/api/ChannelsBearer JWT (Roles AllCustomerRepRoles)
POST/api/ChannelsBearer JWT (ManageSettings)
POST/api/Channels/import-emailsBearer JWT (ImportEmails)
POST/api/Channels/test-connectionBearer JWT (ManageSettings)
POST/api/Channels/{channelId}/import-emailsBearer JWT (ImportEmails)
GET/api/Channels/{channelToken}/translations-by-token/{lang}Public/callback
DELETE/api/Channels/{id}Bearer JWT (ManageSettings)
GET/api/Channels/{id}Bearer JWT (Roles AllCustomerRepRoles)
PUT/api/Channels/{id}Bearer JWT (ManageSettings)
GET/api/Channels/{id}/routingBearer JWT (Roles AllCustomerRepRoles)
GET/api/Channels/{id}/topic-policyBearer JWT (ManageSettings)
PUT/api/Channels/{id}/topic-policyBearer JWT (ManageSettings)
ChannelFolders (6)

Manage mailbox folders and folder synchronization for channels. Channels guide

MethodPathAccess
POST/api/ChannelFoldersBearer JWT
GET/api/ChannelFolders/byChannel/{channelId}Bearer JWT
GET/api/ChannelFolders/fromMailbox/{channelId}Bearer JWT
DELETE/api/ChannelFolders/{id}Bearer JWT
GET/api/ChannelFolders/{id}Bearer JWT
PUT/api/ChannelFolders/{id}Bearer JWT
ChannelTranslations (5)

Manage channel-specific language strings. Channels guide

MethodPathAccess
POST/api/ChannelTranslationsBearer JWT
GET/api/ChannelTranslations/byChannel/{channelId}Bearer JWT
DELETE/api/ChannelTranslations/{id}Bearer JWT
GET/api/ChannelTranslations/{id}Bearer JWT
PUT/api/ChannelTranslations/{id}Bearer JWT
EndUsers (7)

Manage contacts or end users and retrieve their ticket history. End Users guide

MethodPathAccess
GET/api/EndUsersBearer JWT
POST/api/EndUsersBearer JWT
GET/api/EndUsers/byUidBearer JWT
DELETE/api/EndUsers/{id}Bearer JWT
GET/api/EndUsers/{id}Bearer JWT
PUT/api/EndUsers/{id}Bearer JWT
GET/api/EndUsers/{id}/ticketsBearer JWT
EndUserUIDs (1)

Assign additional unique identifiers to end users. End Users guide

MethodPathAccess
POST/api/EndUserUIDs/assignBearer JWT

Automation setup

Actions (6)

Manage automation actions and available action metadata. Actions guide

MethodPathAccess
GET/api/ActionsBearer JWT (ManageSettings)
POST/api/ActionsBearer JWT (ManageSettings)
GET/api/Actions/availableBearer JWT (TicketAccessOrPhoneAuth)
DELETE/api/Actions/{id}Bearer JWT (ManageSettings)
GET/api/Actions/{id}Bearer JWT (ManageSettings)
PUT/api/Actions/{id}Bearer JWT (ManageSettings)
Topics (5)

Manage topics used for routing, classification and automation. Topics guide

MethodPathAccess
GET/api/TopicsBearer JWT (TicketAccessOrPhoneAuth)
POST/api/TopicsBearer JWT (ManageSettings)
DELETE/api/Topics/{id}Bearer JWT (ManageSettings)
GET/api/Topics/{id}Bearer JWT (TicketAccessOrPhoneAuth)
PUT/api/Topics/{id}Bearer JWT (ManageSettings)
TopicActions (6)

Link actions to topics, including bulk operations. Actions guide

MethodPathAccess
GET/api/TopicActionsBearer JWT
POST/api/TopicActionsBearer JWT
POST/api/TopicActions/bulkBearer JWT
DELETE/api/TopicActions/{id}Bearer JWT
GET/api/TopicActions/{id}Bearer JWT
PUT/api/TopicActions/{id}Bearer JWT
TopicChannels (6)

Link topics to channels, including bulk operations. Topics guide

MethodPathAccess
GET/api/TopicChannelsBearer JWT (ManageSettings)
POST/api/TopicChannelsBearer JWT (ManageSettings)
DELETE/api/TopicChannels/bulkBearer JWT (ManageSettings)
POST/api/TopicChannels/bulkBearer JWT (ManageSettings)
DELETE/api/TopicChannels/{id}Bearer JWT (ManageSettings)
GET/api/TopicChannels/{id}Bearer JWT (ManageSettings)
TopicDocuments (6)

Link documents to topics, including bulk operations. Documents guide

MethodPathAccess
GET/api/TopicDocumentsBearer JWT
POST/api/TopicDocumentsBearer JWT
POST/api/TopicDocuments/bulkBearer JWT
DELETE/api/TopicDocuments/{id}Bearer JWT
GET/api/TopicDocuments/{id}Bearer JWT
PUT/api/TopicDocuments/{id}Bearer JWT
Documents (6)

Manage prompt documents, knowledge documents and document conversion. Documents guide

MethodPathAccess
GET/api/DocumentsBearer JWT (ManageSettings)
POST/api/DocumentsBearer JWT (ManageSettings)
POST/api/Documents/convertBearer JWT (ManageSettings)
DELETE/api/Documents/{id}Bearer JWT (ManageSettings)
GET/api/Documents/{id}Bearer JWT (ManageSettings)
PUT/api/Documents/{id}Bearer JWT (ManageSettings)
HookActions (7)

Manage event-triggered actions and wait-second metadata. Hooks guide

MethodPathAccess
GET/api/HookActionsBearer JWT
POST/api/HookActionsBearer JWT
POST/api/HookActions/bulkBearer JWT
GET/api/HookActions/wait-secondsBearer JWT
DELETE/api/HookActions/{id}Bearer JWT
GET/api/HookActions/{id}Bearer JWT
PUT/api/HookActions/{id}Bearer JWT
HookDocuments (2)

Retrieve and attach prompt documents for hook execution. Hooks guide

MethodPathAccess
POST/api/HookDocumentsBearer JWT
GET/api/HookDocuments/promptDocumentsBearer JWT (TicketAccessOrPhoneAuth)
PageTopicMappings (5)

Map pages or URLs to topics. Topics guide

MethodPathAccess
GET/api/PageTopicMappingsBearer JWT
POST/api/PageTopicMappingsBearer JWT
DELETE/api/PageTopicMappings/{id}Bearer JWT
GET/api/PageTopicMappings/{id}Bearer JWT
PUT/api/PageTopicMappings/{id}Bearer JWT
ConditionalRules (1)

Create conditional rules from natural-language text. Topics guide

MethodPathAccess
POST/api/ConditionalRules/from-textBearer JWT

Tickets and messages

Tickets (11)

Create, update, assign, patch and retrieve tickets. Tickets guide

MethodPathAccess
GET/api/TicketsBearer JWT (TicketAccess)
POST/api/TicketsBearer JWT (TicketCreateFromPhone)
PUT/api/Tickets/bulkBearer JWT (TicketAccess)
POST/api/Tickets/createchatticketPublic/callback
DELETE/api/Tickets/{id}Bearer JWT (TicketAccess)
GET/api/Tickets/{id}Bearer JWT (TicketAccess)
PATCH/api/Tickets/{id}Bearer JWT (TicketAccessOrPhoneAuth)
PUT/api/Tickets/{id}Bearer JWT (TicketAccess)
PUT/api/Tickets/{id}/assignBearer JWT (TicketAccess)
GET/api/Tickets/{id}/history-summaryBearer JWT (TicketAccessOrPhoneAuth)
GET/api/Tickets/{ticketId}/playBearer JWT (TicketAccess)
TicketMessages (27)

Manage ticket messages, drafts, replies, attachments, escalation and tracking. Ticket Messages guide

MethodPathAccess
GET/api/TicketMessagesBearer JWT (TicketAccess)
POST/api/TicketMessagesBearer JWT (TicketCreateFromPhone)
POST/api/TicketMessages/create-newBearer JWT (TicketCreateFromPhone)
GET/api/TicketMessages/otPublic/callback
GET/api/TicketMessages/unsubscribejobadPublic/callback
DELETE/api/TicketMessages/{id}Bearer JWT (TicketAccess)
GET/api/TicketMessages/{id}Bearer JWT (TicketAccessOrPhoneAuth)
PUT/api/TicketMessages/{id}Bearer JWT (TicketAccessOrPhoneAuth)
GET/api/TicketMessages/{id}/attachmentsBearer JWT (TicketAccess)
POST/api/TicketMessages/{id}/attachmentsBearer JWT (TicketAccess)
DELETE/api/TicketMessages/{id}/attachments/{attachmentId}Bearer JWT (TicketAccess)
POST/api/TicketMessages/{id}/correct-topicsBearer JWT (TicketAccess)
POST/api/TicketMessages/{id}/detect-topicsBearer JWT (TicketAccess)
GET/api/TicketMessages/{id}/draftBearer JWT (TicketAccess)
POST/api/TicketMessages/{id}/execute-actionBearer JWT (TicketAccess)
POST/api/TicketMessages/{id}/execute-hookBearer JWT (TicketAccessOrPhoneAuth)
GET/api/TicketMessages/{id}/execute-single-actionBearer JWT (TicketAccess)
POST/api/TicketMessages/{id}/previewBearer JWT (TicketAccess)
GET/api/TicketMessages/{id}/promptBearer JWT (TicketAccess)
GET/api/TicketMessages/{id}/promptDocumentsBearer JWT (TicketAccessOrPhoneAuth)
POST/api/TicketMessages/{id}/replyBearer JWT (TicketAccessOrPhoneAuth)
POST/api/TicketMessages/{id}/sendBearer JWT (TicketAccess)
POST/api/TicketMessages/{id}/send-forwardBearer JWT (TicketAccess)
POST/api/TicketMessages/{id}/send-newBearer JWT (TicketAccess)
POST/api/TicketMessages/{messageId}/escalate-by-idBearer JWT (TicketAccessOrPhoneAuth)
POST/api/TicketMessages/{ticketToken}/escalatePublic/callback
GET/api/TicketMessages/{ticketToken}/like-dislikePublic/callback
TicketMessageTopics (5)

Manage topic classifications on ticket messages. Ticket Messages guide

MethodPathAccess
GET/api/TicketMessageTopicsBearer JWT (TicketAccessOrPhoneAuth)
POST/api/TicketMessageTopicsBearer JWT (TicketAccessOrPhoneAuth)
DELETE/api/TicketMessageTopics/{id}Bearer JWT (TicketAccessOrPhoneAuth)
GET/api/TicketMessageTopics/{id}Bearer JWT (TicketAccessOrPhoneAuth)
PUT/api/TicketMessageTopics/{id}Bearer JWT (TicketAccessOrPhoneAuth)
File (1)

Retrieve tokenized file attachments. File guide

MethodPathAccess
GET/api/File/{accessToken:guid}Public/callback

Voice, media and language

TwilioCalls (5)

Create voice tokens, initiate calls and handle Twilio callbacks. Voice and transcription guide

MethodPathAccess
GET/api/TwilioCalls/call-statusBearer JWT
POST/api/TwilioCalls/initiate-callBearer JWT
POST/api/TwilioCalls/voicePublic/callback
GET/api/TwilioCalls/voice-tokenBearer JWT
POST/api/TwilioCalls/{repID}/recordingcallbackPublic/callback
AudioChunks (1)

Upload and finalize audio chunks. Voice and transcription guide

MethodPathAccess
POST/api/AudioChunks/uploadAndFinalizeBearer JWT (TicketAccessOrPhoneAuth)
Realtime transcription (1)

Create realtime transcription call sessions. Voice and transcription guide

MethodPathAccess
POST/api/realtime/callsBearer JWT
Transcriptions (1)

Transcribe uploaded audio files. Voice and transcription guide

MethodPathAccess
POST/api/Transcriptions/fileBearer JWT
Translations (2)

Translate text and detect language using AI. Translations guide

MethodPathAccess
GET/api/Translations/detect-language-aiBearer JWT
POST/api/Translations/translateBearer JWT

Place descriptions

PlaceDescriptionReports (8)

Manage place-description reports and DOCX exports. Place descriptions guide

MethodPathAccess
GET/api/PlaceDescriptionReportsBearer JWT (TicketAccess)
POST/api/PlaceDescriptionReportsBearer JWT (TicketAccess)
DELETE/api/PlaceDescriptionReports/{id}Bearer JWT (TicketAccess)
GET/api/PlaceDescriptionReports/{id}Bearer JWT (TicketAccess)
PUT/api/PlaceDescriptionReports/{id}Bearer JWT (TicketAccess)
GET/api/PlaceDescriptionReports/{id}/export/docxBearer JWT (TicketAccess)
GET/api/PlaceDescriptionReports/{reportId}/roomsBearer JWT (TicketAccess)
POST/api/PlaceDescriptionReports/{reportId}/roomsBearer JWT (TicketAccess)
PlaceDescriptionRooms (6)

Manage rooms and transform room transcripts. Place descriptions guide

MethodPathAccess
DELETE/api/PlaceDescriptionRooms/{roomId}Bearer JWT (TicketAccess)
PUT/api/PlaceDescriptionRooms/{roomId}Bearer JWT (TicketAccess)
GET/api/PlaceDescriptionRooms/{roomId}/photosBearer JWT (TicketAccess)
POST/api/PlaceDescriptionRooms/{roomId}/photosBearer JWT (TicketAccess)
PUT/api/PlaceDescriptionRooms/{roomId}/photos/reorderBearer JWT (TicketAccess)
POST/api/PlaceDescriptionRooms/{roomId}/transformBearer JWT (TicketAccess)
PlaceDescriptionRoomPhotos (1)

Manage room photos and photo ordering. Place descriptions guide

MethodPathAccess
DELETE/api/PlaceDescriptionRoomPhotos/{photoId}Bearer JWT (TicketAccess)
PlaceDescriptionPhotos (1)

Retrieve tokenized place-description photos. Place descriptions guide

MethodPathAccess
GET/api/PlaceDescriptionPhotos/{accessToken:guid}Public/callback

Webhooks

GraphWebhook (4)

Handle Microsoft Graph webhook validation, notifications and subscription management. Webhooks guide

MethodPathAccess
GET/api/GraphWebhookPublic/callback
POST/api/GraphWebhookPublic/callback
POST/api/GraphWebhook/subscribe/{channelId}No bearer token declared
POST/api/GraphWebhook/unsubscribe/{channelId}No bearer token declared
Realtime hubs: /chatHub, /api/chatHub, and /ticketHub.

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

Contact API 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

Social Icons