Skip to main content

​
Overview

The AllCare API provides programmatic access to our healthcare platform, enabling integrations with external systems, custom applications, and automated workflows.

​
Available APIs

Doctors API

Manage provider profiles, credentials, and assignments

Patients API

Access patient data, demographics, and medical records (GraphQL)

Pharmacy API

Prescription data and pharmacy operations (GraphQL)

Facility API

Facility management and configuration

​
API Types

​
REST APIs

Most AllCare APIs follow REST principles:
  • Doctors API - RESTful endpoints for provider management
  • Facility API - RESTful endpoints for facility operations
  • Visit Scheduling API - RESTful endpoints for scheduling
Base URL: https://api.allcare.ai/v1/

​
GraphQL APIs

For complex queries and flexible data retrieval:
  • Patients API - GraphQL for patient data
  • Pharmacy API - GraphQL for prescription data
GraphQL Endpoint: https://api.allcare.ai/graphql/

​
Authentication

All API requests require authentication using API keys or OAuth 2.0 tokens.
1

Obtain API Credentials

Contact your AllCare account manager to request API access
2

Generate API Key

Log in to AllCare dashboard and generate API key in Settings > API Access
3

Include in Requests

Add API key to request headers:
Authorization: Bearer YOUR_API_KEY
Learn more about authentication →

​
Quick Start

​
REST API Example

curl -X GET "https://api.allcare.ai/v1/doctors/12345" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"

​
GraphQL Example

query GetPatient {
  patient(id: "12345") {
    firstName
    lastName
    dateOfBirth
    medications {
      name
      dosage
      frequency
    }
  }
}

​
Rate Limits

To ensure fair usage and system stability:
PlanRate LimitBurst
Standard100 req/min200
Professional500 req/min1000
EnterpriseCustomCustom
Rate limits are per API key. Contact sales for higher limits.

​
Response Format

​
Success Response

{
  "success": true,
  "data": {
    "id": "12345",
    "firstName": "John",
    "lastName": "Doe"
  },
  "timestamp": "2025-01-15T10:30:00Z"
}

​
Error Response

{
  "success": false,
  "error": {
    "code": "RESOURCE_NOT_FOUND",
    "message": "The requested resource was not found",
    "details": {}
  },
  "timestamp": "2025-01-15T10:30:00Z"
}

​
Error Codes

CodeDescriptionHTTP Status
UNAUTHORIZEDInvalid or missing API key401
FORBIDDENInsufficient permissions403
RESOURCE_NOT_FOUNDResource doesn’t exist404
VALIDATION_ERRORInvalid request data400
RATE_LIMIT_EXCEEDEDToo many requests429
INTERNAL_ERRORServer error500

​
Security

API keys are sensitive credentials
  • Never commit API keys to version control
  • Use environment variables
  • Rotate keys regularly
  • Monitor API usage for anomalies

​
Best Practices

Use HTTPS for all API requests
Store API keys securely (environment variables, secrets manager)
Implement proper error handling
Log API interactions for auditing
Follow HIPAA compliance guidelines for PHI

​
HIPAA Compliance

All API usage must comply with HIPAA regulations:
  • API access requires signed Business Associate Agreement (BAA)
  • All data transmission is encrypted (TLS 1.2+)
  • Comprehensive audit logs maintained
  • Access controls enforced
  • PHI handling follows AllCare policies

​
SDKs and Libraries

Official SDKs available for popular languages:

JavaScript/TypeScript

npm install @allcare/api-client

Python

pip install allcare-api

C# / .NET

NuGet: AllCare.ApiClient

​
Webhooks

Receive real-time notifications for events:
  • Patient enrollment
  • Prescription submitted
  • Visit completed
  • Status changes
  • Errors and alerts
Configure webhooks in your API settings dashboard.

​
API Versioning

AllCare uses URL-based versioning:
  • Current: v1 (stable)
  • Beta: v2 (preview features)
Breaking changes are introduced in new versions. Existing versions are supported for 12 months after new version release.

​
Support

Developer & API Docs

Detailed endpoint documentation and examples

Developer Support

Email: [email protected]

Status Page

Monitor API health and uptime

Changelog

Track API updates and changes

​
Next Steps

1

Set Up Authentication

Configure API keys and OAuth
2

Explore Endpoints

Review API documentation for your use case
3

Test in Sandbox

Use our sandbox environment for testing
4

Go Live

Deploy to production