Scheduled maintenance — Monday, June 29, 8:00–9:00 PM ET

Documentation will remain available. Database changes made during this window may not be saved.

API OVERVIEW

Pagination

Request IDs

Versioning

Rate Limits

CLINIC

Clinic

Retrieve a clinic

Labs

Labs

The Lab object contains a record of all ordered labs for a patient. Labs begin as recommendations within a treatment plan. Once purchased by the patient, they become lab orders. Lab orders can contain one or more tests and return one or more results.

New to Labs? Start with the Labs integration guide for an overview of lab status transitions, webhook behavior, and result mapping best practices.

List all lab orders

Lists all ordered labs.

Arguments

patient_id

string

Filter orders by patient_id.

GET /api/clinic/labs/orders
curl "https://api-us-snd.fullscript.io/api/clinic/labs/orders" \ -H 'Content-Type: application/json' \ -H 'Authorization: Bearer XXXXXXXXXXXXXXXXXXXX'

Responses

Retrieve a lab order

Retrieves a ordered lab.

Arguments

id

string

Required

Unique identifier of the lab order.

GET /api/clinic/labs/orders/{id}
curl "https://api-us-snd.fullscript.io/api/clinic/labs/orders/{id}" \ -H 'Content-Type: application/json' \ -H 'Authorization: Bearer XXXXXXXXXXXXXXXXXXXX'

Responses

Retrieve a lab test

Retrieves a lab test.

Note: Lab tests are returned separately from lab results. There is currently no guaranteed one-to-one mapping between results[] and tests[] in the lab order object. See the Labs Integration Guide for recommendations.

Arguments

id

string

Required

Unique identifier of the lab test.

GET /api/clinic/labs/tests/{id}
curl "https://api-us-snd.fullscript.io/api/clinic/labs/tests/{id}" \ -H 'Content-Type: application/json' \ -H 'Authorization: Bearer XXXXXXXXXXXXXXXXXXXX'

Responses

List lab tests

This endpoint is restricted

This endpoint is not available for general use. Access is highly restricted, and most requests will not be granted. If you believe your case is critical, you may submit a request for consideration. We will only respond if your request is relevant.

Returns a paginated catalog of active lab tests available for ordering. Inactive tests are excluded from the list rather than returned with an error.

Error responses

  • 403 — OAuth token is missing the catalog:read scope. Returns { "error": "Must have \catalog
    ` scope enabled." }`.

Arguments

No arguments

GET /api/labs
curl "https://api-us-snd.fullscript.io/api/labs" \ -H 'Content-Type: application/json' \ -H 'Authorization: Bearer XXXXXXXXXXXXXXXXXXXX'

Responses

Retrieve a lab test

This endpoint is restricted

This endpoint is not available for general use. Access is highly restricted, and most requests will not be granted. If you believe your case is critical, you may submit a request for consideration. We will only respond if your request is relevant.

Retrieves detailed information for a single lab test, including availability, sample types, biomarkers, and add-on tests.

Use List lab tests to browse the catalog and obtain lab test IDs.

Error responses

  • 403 — OAuth token is missing the catalog:read scope. Returns { "error": "Must have \catalog
    ` scope enabled." }`.
  • 404lab_id is missing or does not match an active lab test. Returns { "error": "Lab test ID is missing or invalid." }.

Arguments

lab_id

string

Required

Lab test variant UUID.

GET /api/labs/{lab_id}
curl "https://api-us-snd.fullscript.io/api/labs/{lab_id}" \ -H 'Content-Type: application/json' \ -H 'Authorization: Bearer XXXXXXXXXXXXXXXXXXXX'

Responses

Search for lab tests

Search for lab tests using Fullscript's OpenSearch implementation. Returns lab tests matching the query string, respecting practitioner-specific restrictions and favourites.

Note: This endpoint is gated by a feature flipper and may not be available for all partners.

Arguments

query

string

Search for lab tests matching a query string.

page[number]

integer

The page number to retrieve.

page[size]

integer

The number of results per page.

GET /api/labs/search/tests
curl "https://api-us-snd.fullscript.io/api/labs/search/tests" \ -H 'Content-Type: application/json' \ -H 'Authorization: Bearer XXXXXXXXXXXXXXXXXXXX'

Responses