API Documentation

Integrate with DocLinq's powerful healthcare platform using our comprehensive API

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"

Learn More About Authentication

API Endpoints

Patients API

Manage patient records and information

GET

/patients

List all patients

Example:

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

GET

/patients/{id}

Get a specific patient

Example:

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

POST

/patients

Create a new patient

Example:

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"
  }'

View Full Patients API Reference

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();

View JavaScript SDK Docs

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()

View Python SDK Docs

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

View Ruby SDK Docs

Ready to start integrating?

Get API Access Contact Sales