API Documentation

Getting Started

Learn the basics of the DocLinQ API

View Docs →

Authentication

Secure your API requests

View Docs →

API Reference

Explore all available endpoints

View Docs →

Code Examples

Sample code in multiple languages

View Docs →

Introduction

The DocLinQ API allows you to integrate our healthcare platform with your existing systems. You can manage appointments, patient records, messaging, and more programmatically.

Our RESTful API uses standard HTTP methods and returns JSON responses. All API requests must be authenticated using your API key.

Base URL

https://api.doclinq.com/v1

Authentication

All API requests require authentication using an API key. You can generate an API key in your DocLinQ dashboard under Settings > API.

API Key Authentication

Include your API key in the Authorization header of all requests:

curl -X GET "https://api.doclinq.com/v1/patients" \
  -H "Authorization: Bearer YOUR_API_KEY"

API Endpoints

Patients API

Manage patient records and information

GET /patients

List all patients

curl -X GET "https://api.doclinq.com/v1/patients" \
  -H "Authorization: Bearer YOUR_API_KEY"

GET /patients/{id}

Get a specific patient

curl -X GET "https://api.doclinq.com/v1/patients/123" \
  -H "Authorization: Bearer YOUR_API_KEY"

POST /patients

Create a new patient

curl -X POST "https://api.doclinq.com/v1/patients" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "firstName": "John",
    "lastName": "Doe",
    "email": "john.doe@example.com",
    "phone": "555-123-4567",
    "dateOfBirth": "1980-01-01"
  }'

Appointments API

Manage scheduling and appointments

GET /appointments

List all appointments

curl -X GET "https://api.doclinq.com/v1/appointments" \
  -H "Authorization: Bearer YOUR_API_KEY"

POST /appointments

Create a new appointment

curl -X POST "https://api.doclinq.com/v1/appointments" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "patientId": "123",
    "providerId": "456",
    "startTime": "2023-06-15T10:00:00Z",
    "endTime": "2023-06-15T10:30:00Z",
    "type": "follow-up"
  }'

Providers API

Manage healthcare providers and staff

GET /providers

List all providers

curl -X GET "https://api.doclinq.com/v1/providers" \
  -H "Authorization: Bearer YOUR_API_KEY"

GET /providers/{id}/availability

Get provider availability

curl -X GET "https://api.doclinq.com/v1/providers/456/availability?date=2023-06-15" \
  -H "Authorization: Bearer YOUR_API_KEY"

Messaging API

Send and receive secure messages

GET /messages

List all messages

curl -X GET "https://api.doclinq.com/v1/messages" \
  -H "Authorization: Bearer YOUR_API_KEY"

POST /messages

Send a new message

curl -X POST "https://api.doclinq.com/v1/messages" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "recipientId": "123",
    "senderId": "456",
    "subject": "Follow-up appointment",
    "body": "Your lab results are ready."
  }'

Client Libraries & SDKs

JavaScript SDK

For web and Node.js applications

npm install @doclinq/api-client

import { DocLinqClient } from '@doclinq/api-client';

const client = new DocLinqClient('YOUR_API_KEY');

// Get all patients
const patients = await client.patients.list();

Python SDK

For Python applications

pip install doclinq-api

from doclinq import DocLinqClient

client = DocLinqClient('YOUR_API_KEY')

# Get all patients
patients = client.patients.list()

Ruby SDK

For Ruby applications

gem install doclinq-api

require 'doclinq'

client = DocLinq::Client.new('YOUR_API_KEY')

# Get all patients
patients = client.patients.list

Ready to start integrating?

Sign up for a DocLinQ account to get your API keys and start building powerful healthcare applications.

Get API Access Contact Sales