Pagination

API OVERVIEW

Pagination

Request IDs

Versioning

Rate Limits

CLINIC

Clinic

Retrieve a clinic

Staff

List all staff

Create a staff member

Retrieve a staff member

Update a staff member

Practitioners

List all practitioners

Create a practitioner

Retrieve a practitioner

Update a practitioner

Practitioner Types

List all practitioner types

Protocols

List all Fullscript protocols

List all practitioner protocols

Retrieve a protocol

Templates

List all practitioner templates

Retrieve a template

Labs

List all lab orders

Retrieve a lab order

Retrieve a lab test

Resources

List all practitioner resources

Create a resource

Retrieve a practitioner's resource

Update a resource

Delete a resource

List All Fullscript Resources

Metadata

Find objects

PATIENTS

Patients

List all dependents

List all patients

Create a patient

Retrieve a patient

Update a patient

Search for patients

Address

List All Patient Addresses

Orders

List all orders

Retrieve an Order

List all patient orders

Treatment Plans

Activate a treatment plan

Cancel a treatment plan

List all patient treatment plans

Create a patient treatment plan

Retrieve a treatment plan

Update a treatment plan

Create an in-office checkout

Dynamic link

Create a Draft Treatment Plan Link with Patient Matching UI

Retrieve a new Treatment Plan link

Create a Draft Treatment Plan Link

Retrieve a Treatment Plan Link

FULLSCRIPT CATALOG

Products

List all products

Retrieve a product

List similar products

All top-level list endpoints can be paginated. They return a meta tag that contains all pagination data.

Example Request

curl "https://api-us-snd.fullscript.io/api/clinic/patients?page[number]=2&page[size]=20" \
  -H 'Authorization: Bearer XXXXXXXXXXXXXXXXXXXX'

Example Response

{
  "patients": [
    {...}
  ],
  "meta": {
    "current_page": 2,
    "next_page": null,
    "prev_page": 1,
    "total_pages": 2,
    "total_count": 40
  }
}

The maximum page size is 100.