Knowledge Base

Documentation and guides for the Public API.

• API Consumer Guide - Complete guide for integrating with the Ascend Public API including authentication, HTTP requests, bulk operations, and real-time data sync
• Issue Reporting Guide - How to submit API support tickets, understand priority levels, and service level objectives
• Obtaining Prod Access - Production access requirements including testing requirements, endpoint coverage, and performance expectations
• RESTful API Best Practices - Comprehensive guide covering versioning, casing, URLs, query parameters, pagination, and error handling
• Creating and Setting Up Webhooks for the StreamAPI - How to create, register, and secure webhooks for StreamAPI real-time data change notifications delivered via AWS SNS
• Location-Based API Billing - How API usage is calculated by location and how to optimize your integration to avoid unnecessary charges
• Usage Report Endpoint - How to use /v1/usagereport to monitor your month-to-date API call volume, and why it is scoped per apiConsumer (not per organization)
• Vendor Enablement in Dentrix Ascend - How organizations turn third-party vendor integrations on or off in the product

Additional content areas:

• API Authentication
• Rate Limiting
• Advanced Error Handling Strategies
• Bulk GET — Total Count Behavior - How pagination.total behaves in bulk GET endpoints — when you will see a real count, zero, or no total field at all
• Documents V1 — Developer Guide - Document upload, bulk GET filters, owner assignment, tags, total count, and streaming
• Patients V1 — Developer Guide - Patient bulk GET, create, update, calculated fields, total count, filters, and pagination recommendations
• Missed Appointments V1 — Developer Guide - Missed appointment bulk GET, filters, PUT/DELETE semantics, and how rescheduledOn is set via appointment updates