Skip to main content

Prospyr API Documentation

Welcome to the Prospyr API documentation. Build powerful healthcare applications with our comprehensive GraphQL API.

What is Prospyr?​

Prospyr is a modern healthcare practice management platform that provides a robust API for:

  • 🏥 Patient Management - Create, update, and manage patient records
  • 📅 Appointment Scheduling - Book, reschedule, and manage appointments
  • 👨‍⚕️ Provider Operations - Manage provider schedules and availability
  • 📋 Insurance Processing - Handle insurance information and claims
  • 💬 Real-time Updates - Subscribe to changes with GraphQL subscriptions
  • 🔒 Secure Access - HIPAA-compliant data handling with robust authentication

Quick Start​

Get up and running with the Prospyr API in minutes:

1. Get Your JWT Token​

Contact us at gsupport@prospyrmed.com to request API access.

2. Make Your First Request​

curl -X POST https://prod.prospyrmedapi.com/v1/graphql \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer YOUR_JWT_TOKEN' \
  -H 'app: api' \
  -d '{"query": "{ patient(limit: 5) { id firstName lastName } }"}'

3. Explore the API​

Key Features​

GraphQL API​

Our API uses GraphQL, providing:

  • Flexible Queries - Request exactly the data you need
  • Single Endpoint - All operations through one URL
  • Strong Typing - Full schema introspection and type safety
  • Real-time Subscriptions - Live updates for dynamic applications

Developer-Friendly​

  • Comprehensive Documentation - Detailed guides and examples
  • Multiple SDKs - Client libraries for popular languages
  • Postman Collection - Test endpoints without writing code
  • Sandbox Environment - Safe testing environment available

Healthcare-Focused​

Built specifically for healthcare applications:

  • HIPAA Compliant - Secure handling of protected health information
  • Medical Coding - Support for ICD-10, CPT, and other standards
  • Insurance Integration - Built-in insurance verification and processing
  • Appointment Logic - Complex scheduling rules and availability management

API Overview​

Base URL​

https://prod.prospyrmedapi.com/v1/graphql

Authentication​

All requests require authentication via Bearer token and app header:

Authorization: Bearer YOUR_JWT_TOKEN
app: api

Response Format​

All responses follow the GraphQL specification:

{
  "data": {
    "patient": [
      {
        "id": 1,
        "firstName": "John",
        "lastName": "Doe"
      }
    ]
  }
}

Electronic Health Records (EHR)​

Build complete EHR systems with patient histories, clinical notes, and treatment plans.

Patient Portals​

Create secure patient-facing applications for appointment booking, record access, and communication.

Practice Management​

Develop tools for scheduling, billing, and administrative tasks.

Telehealth Integration​

Connect virtual visit platforms with patient records and scheduling.

Getting Help​

Next Steps​

🔐 Authentication

Learn how to authenticate and secure your API requests.

Get Started

💻 Sample Requests

Explore common API operations with practical examples.

View Examples

Building something amazing? We'd love to hear about it! Share your projects and get featured in our developer showcase.