Jump to Content

v1.0

API Reference

v1.0API Reference

Helpdesk

auth
schema
- Get Supported Authentication Schema Propertiesget
- Get Customer Schemaget
invite
auth_legacy
appointment
core
customer
documents
payments
websockets
- 3DS Authenticationpost
- 3DS Challengepost
postcode
- Get Postcodeget
offer
- Make an offerpost
flow
- get proeprty flowget
- save data via flowpost

Core API

crm
schemas
- Get Schemasget
- Get Supported Propertiesget
customer
events
- Get Eventget
/heartbeat
- check server is upget
/version
- get api versionget

Payments API

Health
- Heartbeatget
Arrangements
- Create V1 Arrangementpost
- Cancel V1 Arrangementput
Card V2
Direct Debit
- Create Direct Debitpost
- Cancel Direct Debitdelete
Payment Plan
Card V1

Dashboards

Dashboard entry operations
Dashboard operations

Documents

upload_document
- Upload Documentpost
get_documents
- Get available documents for a FCCIDget
UUID

Communications

status
- returns 200 if the API is able to retrieve dataget
communication
templates
attachment

Search API

/heartbeat
- getget
/reference
- getget
/contact
- getget
/dob
- getget
/name
- getget

Powered by

Upload an attachment to be used as an template attachment

post https://example.com/comms-api/attachment/email/upload

Language

Click Try It! to start a request and see the response here!