Welcome to Nymbl API Documentation

The Nymbl Customer API provides an OData-based interface for accessing and managing patient, appointment, and clinical data. Build integrations that connect your systems directly to Nymbl's clinical platform.

Key Features

• OData-based Protocol: REST API with filtering, sorting, pagination, and expansion capabilities
• Secure Authentication: OAuth 2.0 access token and API key required on every request
• Documents: Upload and download documents

Getting Started

• 1. Get Your Credentials

  Obtain your Client ID, Client Secret, and API Key from your Nymbl account manager.

  Obtaining Credentials

• 2. Authenticate

  Use your credentials to request an OAuth 2.0 access token.

  Authentication Guide

• 3. Explore the API

  Try out endpoints interactively using the Swagger UI.

  Using Swagger

• 4. Build Your Integration

  Follow the quick start guide with code examples in Python and Node.js.

  Quick Start

Base URL

All API requests should be made to:

https://api.nymblqa.com/

Guides

• Filtering Data — Use $filter to query exactly the records you need
• Expanding Relations — Fetch related entities in a single request
• Pagination — Navigate large result sets efficiently
• Uploading & Downloading Documents — Attach and retrieve patient documents
• Using the Swagger UI — Test API endpoints interactively

Need Help?

• Review our comprehensive guides
• Check out code examples
• Contact support for assistance