### GET /products

Source: https://fullscript.dev/technical-reference/rate-limits

Endpoint to retrieve catalog products.

```APIDOC
## GET /products

### Description
Lists all products available in the Fullscript catalog.

### Method
GET

### Endpoint
/products

### Response
#### Success Response (200)
- **products** (array) - List of product objects.

#### Response Example
{
  "products": [
    {
      "id": "prod_abc",
      "name": "Vitamin D3",
      "brand": "Fullscript"
    }
  ]
}
```

--------------------------------

### List Webhook Deliveries using cURL

Source: https://fullscript.dev/technical-reference/webhooks

This example shows how to list all webhook deliveries from the last 30 days using a cURL command. It demonstrates the necessary headers, including `Content-Type` and `Authorization`, and the endpoint for retrieving delivery information. Filtering and sorting options are available but not shown in this basic example.

```bash
curl "https://api-us-snd.fullscript.io/api/webhooks/deliveries" \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer YOUR_ACCESS_TOKEN'
```

--------------------------------

### GET /products

Source: https://fullscript.dev/technical-reference/request-ids

List all products available in the Fullscript catalog.

```APIDOC
## GET /products

### Description
Retrieve a paginated list of all products in the catalog.

### Method
GET

### Endpoint
/products

### Parameters
#### Query Parameters
- **page** (integer) - Optional - Page number for pagination

### Response
#### Success Response (200)
- **products** (array) - List of product objects

#### Response Example
{
  "products": [
    { "id": "prod_001", "name": "Vitamin D3" }
  ]
}
```

--------------------------------

### GET /api/catalog/ingredients

Source: https://fullscript.dev/technical-reference/ingredients

Retrieve a comprehensive list of all supplement ingredients available on the Fullscript platform.

```APIDOC
## GET /api/catalog/ingredients

### Description
This resource allows you to list all ingredients available in the Fullscript catalog.

### Method
GET

### Endpoint
/api/catalog/ingredients

### Parameters
#### Path Parameters
- None

#### Query Parameters
- None

### Request Example
```bash
curl "https://api-us-snd.fullscript.io/api/catalog/ingredients" \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer XXXXXXXXXXXXXXXXXXXX'
```

### Response
#### Success Response (200)
- **ingredients** (array) - A list of ingredient objects.

#### Response Example
{
  "ingredients": [
    {
      "id": "ing_123",
      "name": "Curcumin"
    }
  ]
}
```

--------------------------------

### List Patient Treatment Plans (GET)

Source: https://fullscript.dev/technical-reference/treatment-plans

Lists all treatment plans for a given patient. Requires the patient_id. Optional parameters include sort_by (created_at or updated_at) and order_by (ASC or DESC). Returns a 200 OK on success, or an error code (403, 404) on failure.

```curl
curl "https://api-us-snd.fullscript.io/api/clinic/patients/{patient_id}/treatment_plans" \
         -H 'Content-Type: application/json' \
         -H 'Authorization: Bearer XXXXXXXXXXXXXXXXXXXX'
```

--------------------------------

### GET /api/catalog/products/{id}

Source: https://fullscript.dev/technical-reference/products

Retrieves the details of a specific product by its unique identifier, including custom dosage instructions if applicable.

```APIDOC
## GET /api/catalog/products/{id}

### Description
Retrieves an existing product. If the practitioner has set custom dosage instructions for the product, the `custom_dosage` object is included in the response.

### Method
GET

### Endpoint
/api/catalog/products/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - Unique identifier for the Product

#### Query Parameters
- **practitioner_id** (string) - Optional - Unique Practitioner ID to retrieve custom dosage instructions.

### Request Example
curl "https://api-us-snd.fullscript.io/api/catalog/products/{id}" \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer XXXXXXXXXXXXXXXXXXXX'

### Response
#### Success Response (200)
- **id** (string) - Product ID
- **custom_dosage** (object) - Optional custom dosage instructions

#### Response Example
{
  "id": "prod_123",
  "name": "Vitamin D"
}
```

--------------------------------

### GET /api/catalog/products

Source: https://fullscript.dev/technical-reference/products

Lists all products available on the Fullscript platform. Note: This endpoint is restricted and requires specific authorization.

```APIDOC
## GET /api/catalog/products

### Description
Lists all products available on the Fullscript platform. This endpoint is highly restricted and intended for specific use cases only.

### Method
GET

### Endpoint
/api/catalog/products

### Parameters
None

### Request Example
curl "https://api-us-snd.fullscript.io/api/catalog/products" \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer XXXXXXXXXXXXXXXXXXXX'

### Response
#### Success Response (200)
- **products** (array) - A list of product objects.

#### Response Example
{
  "products": []
}
```

--------------------------------

### GET /api/clinic/dynamic_links/treatment_plans/{id}

Source: https://fullscript.dev/technical-reference/dynamic-link

Retrieves a redirect_url for editing an existing treatment plan that is in a 'draft' or 'active' state.

```APIDOC
## GET /api/clinic/dynamic_links/treatment_plans/{id}

### Description
Returns a redirect_url for editing an existing treatment plan. The treatment plan provided must have a state of draft or active.

### Method
GET

### Endpoint
/api/clinic/dynamic_links/treatment_plans/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - Unique ID for the Treatment Plan.

#### Query Parameters
- **entrypoint** (string) - Optional - Target treatment plan page (catalog or labs).

### Request Example
curl "https://api-us-snd.fullscript.io/api/clinic/dynamic_links/treatment_plans/12345" \
  -H 'Authorization: Bearer XXXXXXXXXXXXXXXXXXXX'

### Response
#### Success Response (200)
- **redirect_url** (string) - The URL to edit the treatment plan.

#### Response Example
{
  "redirect_url": "https://fullscript.io/edit/12345"
}
```

--------------------------------

### GET /api/clinic/practitioners/{practitioner_id}/resources

Source: https://fullscript.dev/technical-reference/resources

Retrieves a list of all resources accessible to a specific practitioner.

```APIDOC
## GET /api/clinic/practitioners/{practitioner_id}/resources

### Description
Lists all Resources that the Practitioner has access to.

### Method
GET

### Endpoint
/api/clinic/practitioners/{practitioner_id}/resources

### Parameters
#### Path Parameters
- **practitioner_id** (string) - Required - Unique ID for the Practitioner

### Request Example
curl "https://api-us-snd.fullscript.io/api/clinic/practitioners/{practitioner_id}/resources" \
        -H 'Content-Type: application/json' \
        -H 'Authorization: Bearer XXXXXXXXXXXXXXXXXXXX'

### Response
#### Success Response (200)
- **resources** (array) - List of resource objects

#### Response Example
{
  "resources": []
}
```

--------------------------------

### Retrieve a Treatment Plan via GET

Source: https://fullscript.dev/technical-reference/treatment-plans

Fetches details of an existing treatment plan using its unique identifier. Returns the plan object if found, or appropriate error codes if access is denied or the ID is invalid.

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

--------------------------------

### API Request ID Example

Source: https://fullscript.dev/technical-reference/request-ids

Demonstrates the 'X-Request-Id' header returned in API responses. This unique identifier is crucial for troubleshooting specific requests and should be provided to support for faster resolution.

```http
x-request-id: 06ded6a2-cb35-43e7-9f83-a4b705e3e588
```

--------------------------------

### GET /api/catalog/ingredients/{id}

Source: https://fullscript.dev/technical-reference/ingredients

Retrieve detailed information for a specific ingredient using its unique identifier.

```APIDOC
## GET /api/catalog/ingredients/{id}

### Description
Retrieves details for an existing ingredient by its unique ID.

### Method
GET

### Endpoint
/api/catalog/ingredients/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - Unique ID for the ingredient

### Request Example
```bash
curl "https://api-us-snd.fullscript.io/api/catalog/ingredients/{id}" \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer XXXXXXXXXXXXXXXXXXXX'
```

### Response
#### Success Response (200)
- **id** (string) - The unique ID of the ingredient
- **name** (string) - The name of the ingredient

#### Error Responses
- **403** (Forbidden) - Access denied
- **404** (Not Found) - Ingredient does not exist

#### Response Example
{
  "id": "ing_123",
  "name": "Curcumin"
}
```

--------------------------------

### GET /api/events/products

Source: https://fullscript.dev/technical-reference/events

Retrieves a list of product events. Supports filtering by creation date and event type, and sorting.

```APIDOC
## GET /api/events/products

### Description
This endpoint lists all `product` events from the last 30 days. It supports filtering by `created_at` date, `event_type`, and sorting by `event_type` or `created_at`.

### Method
GET

### Endpoint
/api/events/products

### Parameters
#### Query Parameters
- **created_at** (string) - Optional - Filter by `created_at` date. Formats: `<yyyy-mm-dd`, `>yyyy-mm-dd`, `yyyy-mm-dd..yyyy-mm-dd`.
- **event_type** (string) - Optional - Filter events by `event_type`.
- **sort_by** (string) - Optional - Accepts `event_type` or `created_at`.
- **order_by** (string) - Optional - Accepts `ASC` or `DESC`. Defaults to `ASC`.

### Request Example
```bash
curl "https://api-us-snd.fullscript.io/api/events/products" \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer XXXXXXXXXXXXXXXXXXXX'
```

### Response
#### Success Response (200)
- **(structure not detailed in source)**

#### Response Example
(No example provided in source)
```

--------------------------------

### GET /api/clinic/treatment_plans/{id}

Source: https://fullscript.dev/technical-reference/treatment-plans

Retrieves an existing treatment plan. Requires the unique ID of the treatment plan.

```APIDOC
## GET /api/clinic/treatment_plans/{id}

### Description
Retrieves an existing treatment plan. Requires the unique ID of the treatment plan.

### Method
GET

### Endpoint
/api/clinic/treatment_plans/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - Unique ID for the Treatment Plan

### Response
#### Success Response (200)
OK

#### Error Response (403)
Forbidden

#### Error Response (404)
Not Found
```

--------------------------------

### GET /api/clinic/categories/{category_id}/products

Source: https://fullscript.dev/technical-reference/categories

List all products associated with a specific category, with optional sorting and ordering.

```APIDOC
## GET /api/clinic/categories/{category_id}/products

### Description
This resource allows you to list all of a category's products. The list is sorted in ascending order by the product's name, by default.

### Method
GET

### Endpoint
/api/clinic/categories/{category_id}/products

### Parameters
#### Path Parameters
- **category_id** (string) - Required - Unique ID for the Category.

#### Query Parameters
- **sort_by** (string) - Optional - Accepts a 'name' argument.
- **order_by** (string) - Optional - Ordering defaults to 'ASC' and can take an argument of 'ASC' or 'DESC'.

### Request Example
```bash
curl "https://api-us-snd.fullscript.io/api/clinic/categories/{category_id}/products" \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer XXXXXXXXXXXXXXXXXXXX'
```

### Response
#### Success Response (200)
- **products** (array) - A list of products within the category.

#### Response Example
{
  "products": []
}
```

--------------------------------

### GET /api/catalog/products/{product_id}/similar

Source: https://fullscript.dev/technical-reference/products

Lists products similar to the specified product, curated by Fullscript's licensed health professionals.

```APIDOC
## GET /api/catalog/products/{product_id}/similar

### Description
Lists similar products that have been curated by Fullscript's licensed health professionals, ordered from most to least popular.

### Method
GET

### Endpoint
/api/catalog/products/{product_id}/similar

### Parameters
#### Path Parameters
- **product_id** (string) - Required - Unique identifier for the Product

### Request Example
curl "https://api-us-snd.fullscript.io/api/catalog/products/{product_id}/similar" \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer XXXXXXXXXXXXXXXXXXXX'

### Response
#### Success Response (200)
- **products** (array) - List of similar products.

#### Response Example
{
  "products": []
}
```

--------------------------------

### GET /api/events/treatment_plans

Source: https://fullscript.dev/technical-reference/events

Retrieves a list of events related to treatment plans. Supports filtering by creation date, event type, and sorting options.

```APIDOC
## GET /api/events/treatment_plans

### Description
Retrieves a list of events related to treatment plans. This endpoint allows for filtering by creation date, event type, and provides options for sorting the results.

### Method
GET

### Endpoint
/api/events/treatment_plans

### Parameters
#### Query Parameters
- **created_at** (string) - Optional - Filter by `created_at` date. The date must be formatted as follows `yyyy-mm-dd`. Supports operators: `<yyyy-mm-dd` (less than), `>yyyy-mm-dd` (greater than), or `yyyy-mm-dd..yyyy-mm-dd` (within a range).
- **event_type** (string) - Optional - Filter events by `event_type`.
- **sort_by** (string) - Optional - Accepts one of the following arguments: `event_type`, `created_at`.
- **order_by** (string) - Optional - Ordering defaults to `ASC` and can take an argument of `ASC` or `DESC`.

### Request Example
```bash
curl "https://api-us-snd.fullscript.io/api/events/treatment_plans?created_at=>2023-01-01&sort_by=created_at&order_by=DESC" \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer XXXXXXXXXXXXXXXXXXXX'
```

### Response
#### Success Response (200)
- **event_type** (string) - Description of the event type.
- **created_at** (string) - Timestamp of when the event was created.

#### Response Example
```json
{
  "events": [
    {
      "event_type": "treatment_plan_created",
      "created_at": "2023-10-27T10:00:00Z"
    }
  ]
}
```

#### Error Responses
- **403 Forbidden**: Indicates that the request lacks valid authentication credentials or permissions.
```

--------------------------------

### Paginate API List Endpoints (cURL)

Source: https://fullscript.dev/technical-reference

Demonstrates how to paginate results from top-level list endpoints in the Fullscript API. It shows an example request using cURL with query parameters for page number and size, and the corresponding response structure including pagination metadata.

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

--------------------------------

### GET /patients

Source: https://fullscript.dev/technical-reference/rate-limits

Endpoint to retrieve a list of patients associated with the clinic.

```APIDOC
## GET /patients

### Description
Retrieves a paginated list of all patients associated with the authenticated clinic.

### Method
GET

### Endpoint
/patients

### Query Parameters
- **page** (integer) - Optional - The page number to retrieve.
- **per_page** (integer) - Optional - Number of records per page.

### Response
#### Success Response (200)
- **patients** (array) - A list of patient objects.

#### Response Example
{
  "patients": [
    {
      "id": "pat_123",
      "first_name": "Jane",
      "last_name": "Doe"
    }
  ]
}
```

--------------------------------

### POST /api/clinic/dynamic_links/gateway/treatment_plans

Source: https://fullscript.dev/technical-reference/dynamic-link

Creates a draft treatment plan link with patient matching UI, allowing practitioners to associate treatment plans with patients.

```APIDOC
## POST /api/clinic/dynamic_links/gateway/treatment_plans

### Description
Returns a `redirect_url` that enables access to a draft treatment plan. This endpoint optionally finds or creates a patient record to associate with the treatment plan.

### Method
POST

### Endpoint
/api/clinic/dynamic_links/gateway/treatment_plans

### Parameters
#### Request Body
- **treatment_plan** (object) - Required - Treatment plan information.
- **practitioner_id** (string) - Required - Practitioner's id used to create the draft treatment plan.
- **patient** (object) - Optional - Patient information for matching or creation.
- **entrypoint** (string) - Optional - Specifies which page the redirect_url will open (catalog, labs).

### Request Example
{
  "treatment_plan": {
    "practitioner_id": "string"
  },
  "patient": {
    "email": "patient@example.com",
    "first_name": "John",
    "last_name": "Doe"
  },
  "entrypoint": "catalog"
}

### Response
#### Success Response (200)
- **redirect_url** (string) - The URL to access the draft treatment plan.

#### Response Example
{
  "redirect_url": "https://fullscript.io/link/example"
}
```

--------------------------------

### Create a practitioner resource via cURL

Source: https://fullscript.dev/technical-reference/resources

Uploads a new resource for a practitioner. Supports file types including jpg, pdf, and doc, and allows association with a treatment plan.

```bash
curl -X 'POST' "https://api-us-snd.fullscript.io/api/clinic/practitioners/{practitioner_id}/resources" \
         -H 'Content-Type: application/json' \
         -H 'Authorization: Bearer XXXXXXXXXXXXXXXXXXXX' \
          -d $'{ 
  "type": "string", 
  "category": "string", 
  "attachment": "string", 
  "name": "string", 
  "treatment_plan_id": "string", 
  "save_to_library": "string" 
}'
```

--------------------------------

### GET /api/clinic/labs/tests/{id}

Source: https://fullscript.dev/technical-reference/labs

Retrieves details for a specific lab test.

```APIDOC
## GET /api/clinic/labs/tests/{id}

### Description
Retrieves a lab test. Note that lab tests are returned separately from lab results.

### Method
GET

### Endpoint
/api/clinic/labs/tests/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - Unique identifier of the lab test.

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

### Response
#### Success Response (200)
- **test** (object) - The lab test details.

#### Response Example
{
  "id": "test_456",
  "name": "Blood Panel"
}
```

--------------------------------

### GET /api/clinic/categories

Source: https://fullscript.dev/technical-reference/categories

Retrieve a list of all categories available within a clinic.

```APIDOC
## GET /api/clinic/categories

### Description
This resource allows you to list all of a clinic's categories.

### Method
GET

### Endpoint
/api/clinic/categories

### Parameters
#### Query Parameters
- None

### Request Example
```bash
curl "https://api-us-snd.fullscript.io/api/clinic/categories" \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer XXXXXXXXXXXXXXXXXXXX'
```

### Response
#### Success Response (200)
- **categories** (array) - A list of category objects.

#### Response Example
{
  "categories": []
}
```

--------------------------------

### List all practitioner resources via cURL

Source: https://fullscript.dev/technical-reference/resources

Retrieves a list of all resources accessible to a specific practitioner. Requires the practitioner_id as a path parameter and a valid Bearer token for authorization.

```bash
curl "https://api-us-snd.fullscript.io/api/clinic/practitioners/{practitioner_id}/resources" \
         -H 'Content-Type: application/json' \
         -H 'Authorization: Bearer XXXXXXXXXXXXXXXXXXXX'
```

--------------------------------

### GET /api/clinic/labs/orders/{id}

Source: https://fullscript.dev/technical-reference/labs

Retrieves the details of a specific lab order by its unique identifier.

```APIDOC
## GET /api/clinic/labs/orders/{id}

### Description
Retrieves a specific ordered lab by its unique ID.

### Method
GET

### Endpoint
/api/clinic/labs/orders/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - Unique identifier of the lab order.

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

### Response
#### Success Response (200)
- **order** (object) - The lab order details.

#### Response Example
{
  "id": "lab_123",
  "status": "completed"
}
```

--------------------------------

### List All Fullscript Resources

Source: https://fullscript.dev/technical-reference/resources

Retrieves a list of all resources created by Fullscript.

```APIDOC
## GET /api/clinic/fullscript_resources

### Description
The Fullscript resource object contains a list of all resources that have been created by Fullscript.

### Method
GET

### Endpoint
/api/clinic/fullscript_resources

### Parameters
#### Query Parameters
No query parameters.

### Request Example
```bash
curl "https://api-us-snd.fullscript.io/api/clinic/fullscript_resources" \
     -H 'Content-Type: application/json' \
     -H 'Authorization: Bearer XXXXXXXXXXXXXXXXXXXX'
```

### Response
#### Success Response (200)
##### OK

#### Error Responses
- **403** Forbidden
```

--------------------------------

### GET /api/clinic/labs/orders

Source: https://fullscript.dev/technical-reference/labs

Lists all ordered labs for the clinic, with an optional filter for patient ID.

```APIDOC
## GET /api/clinic/labs/orders

### Description
Lists all ordered labs. Use the patient_id query parameter to filter results for a specific patient.

### Method
GET

### Endpoint
/api/clinic/labs/orders

### Parameters
#### Query Parameters
- **patient_id** (string) - Optional - Filter orders by patient_id.

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

### Response
#### Success Response (200)
- **data** (array) - List of lab order objects.

#### Response Example
{
  "orders": []
}
```

--------------------------------

### POST /api/clinic/dynamic_links/treatment_plans

Source: https://fullscript.dev/technical-reference/dynamic-link

Creates a draft treatment plan link. This endpoint returns a redirect_url that enables access to a draft treatment plan and optionally finds or creates a patient record.

```APIDOC
## POST /api/clinic/dynamic_links/treatment_plans

### Description
Returns a redirect_url that enables access to a draft treatment plan. This endpoint optionally finds or creates a patient record to associate with the treatment plan.

### Method
POST

### Endpoint
/api/clinic/dynamic_links/treatment_plans

### Parameters
#### Request Body
- **treatment_plan** (object) - Required - Treatment plan information.
- **practitioner_id** (string) - Required - Practitioner's ID.
- **patient** (object) - Optional - Patient details (email, first_name, last_name, date_of_birth, gender, mobile_number, discount, send_welcome_email).
- **entrypoint** (string) - Optional - Page to open (catalog or labs).

### Request Example
{
  "treatment_plan": {
    "practitioner_id": "string"
  },
  "patient": {
    "email": "string",
    "first_name": "string",
    "last_name": "string",
    "date_of_birth": "yyyy-mm-dd",
    "gender": "male/female/x",
    "mobile_number": "+12223334444"
  },
  "entrypoint": "catalog"
}

### Response
#### Success Response (200)
- **redirect_url** (string) - The URL to access the treatment plan.

#### Response Example
{
  "redirect_url": "https://fullscript.io/link/example"
}
```

--------------------------------

### GET /api/clinic/categories/{id}

Source: https://fullscript.dev/technical-reference/categories

Retrieve details for a specific category by its unique identifier.

```APIDOC
## GET /api/clinic/categories/{id}

### Description
Retrieves an existing Category by its unique identifier.

### Method
GET

### Endpoint
/api/clinic/categories/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - Unique identifier of the Category.

### Request Example
```bash
curl "https://api-us-snd.fullscript.io/api/clinic/categories/{id}" \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer XXXXXXXXXXXXXXXXXXXX'
```

### Response
#### Success Response (200)
- **category** (object) - The category details.

#### Response Example
{
  "id": "cat_123",
  "name": "Example Category"
}
```

--------------------------------

### Create a Treatment Plan via POST

Source: https://fullscript.dev/technical-reference/treatment-plans

Creates a new treatment plan for a specific patient. Requires a patient ID, practitioner ID, and an array of product recommendations with detailed dosage instructions.

```bash
curl -X 'POST' "https://api-us-snd.fullscript.io/api/clinic/patients/{patient_id}/treatment_plans" \
         -H 'Content-Type: application/json' \
         -H 'Authorization: Bearer XXXXXXXXXXXXXXXXXXXX' \
         -d $'{   "practitioner_id": "string",   "personal_message": "string",   "state": "string",   "recommendations": [     {       "variant_id": "string",       "units_to_purchase": "string",       "refill": "string",       "take_with": "string",       "dosage": {         "amount": "string",         "frequency": "string",         "duration": "string",         "additional_info": "string",         "format": "string",         "time_of_day": "string"       }     }   ],   "metadata": {     "id": "string"   } }'
```

--------------------------------

### GET /api/clinic/patients/{patient_id}/treatment_plans

Source: https://fullscript.dev/technical-reference/treatment-plans

Lists all treatment plans associated with a specific patient.

```APIDOC
## GET /api/clinic/patients/{patient_id}/treatment_plans

### Description
This resource allows you to list all of a patient's treatment plans.

### Method
GET

### Endpoint
/api/clinic/patients/{patient_id}/treatment_plans

### Parameters
#### Path Parameters
- **patient_id** (string) - Required - Unique ID for the Patient

#### Query Parameters
- **sort_by** (string) - Optional - Accepts 'created_at' or 'updated_at'
- **order_by** (string) - Optional - Accepts 'ASC' or 'DESC'

### Response
#### Success Response (200)
- **data** (array) - List of treatment plan objects

#### Response Example
{
  "data": [
    { "id": "tp_1", "status": "active" }
  ]
}
```

--------------------------------

### List All Fullscript Resources (curl)

Source: https://fullscript.dev/technical-reference/resources

Retrieves a list of all resources created by Fullscript. No specific arguments are required, only authentication. Returns 200 OK on success, or 403 Forbidden on failure.

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

--------------------------------

### GET /api/clinic/practitioners/{practitioner_id}/resources/{id}

Source: https://fullscript.dev/technical-reference/resources

Retrieves the details of a specific resource by its ID.

```APIDOC
## GET /api/clinic/practitioners/{practitioner_id}/resources/{id}

### Description
Retrieves a Resource that the Practitioner has access to.

### Method
GET

### Endpoint
/api/clinic/practitioners/{practitioner_id}/resources/{id}

### Parameters
#### Path Parameters
- **practitioner_id** (string) - Required - Unique ID for the Practitioner.
- **id** (string) - Required - Unique ID for the Resource.

### Response
#### Success Response (200)
- **resource** (object) - The resource details

#### Response Example
{
  "id": "res_abc123",
  "name": "My Resource"
}
```

--------------------------------

### POST /api/clinic/practitioners/{practitioner_id}/resources

Source: https://fullscript.dev/technical-reference/resources

Creates a new resource for a practitioner, supporting various file types and categories.

```APIDOC
## POST /api/clinic/practitioners/{practitioner_id}/resources

### Description
Creates a new Resource for the Practitioner. Only the following file types are allowed: jpg, jpeg, png, pdf, doc, xlsx, pptx.

### Method
POST

### Endpoint
/api/clinic/practitioners/{practitioner_id}/resources

### Parameters
#### Path Parameters
- **practitioner_id** (string) - Required - The unique ID of the practitioner.

#### Request Body
- **type** (string) - Optional - Guide, Handout, Infographic, Meal plan, or Workbook.
- **category** (string) - Optional - Nutrition, Lifestyle, Physical activity, Supplements, or Health conditions.
- **attachment** (string) - Required - The resource file data.
- **name** (string) - Required - The name of the resource.
- **treatment_plan_id** (string) - Optional - ID of associated treatment plan.
- **save_to_library** (string) - Required - Boolean as string to save to library.

### Request Example
{
  "type": "Guide",
  "category": "Nutrition",
  "attachment": "base64_string",
  "name": "My Resource",
  "treatment_plan_id": "tp_123",
  "save_to_library": "true"
}

### Response
#### Success Response (200)
- **id** (string) - The created resource ID

#### Response Example
{
  "id": "res_abc123"
}
```

--------------------------------

### GET /clinics/{id}

Source: https://fullscript.dev/technical-reference/request-ids

Retrieve detailed information for a specific clinic by its unique identifier.

```APIDOC
## GET /clinics/{id}

### Description
Retrieve the details of a specific clinic.

### Method
GET

### Endpoint
/clinics/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the clinic.

### Response
#### Success Response (200)
- **id** (string) - The clinic ID
- **name** (string) - The name of the clinic

#### Response Example
{
  "id": "clinic_123",
  "name": "Example Wellness Clinic"
}
```

--------------------------------

### Create Draft Treatment Plan Link with Patient Matching UI (POST)

Source: https://fullscript.dev/technical-reference/dynamic-link

Generates a redirect URL for a draft treatment plan, optionally creating or matching a patient record. Requires `clinic:write` and potentially `patients:write` OAuth scopes. Accepts treatment plan and patient details as JSON payload.

```cURL
curl -X 'POST' "https://api-us-snd.fullscript.io/api/clinic/dynamic_links/gateway/treatment_plans" \
         -H 'Content-Type: application/json' \
         -H 'Authorization: Bearer XXXXXXXXXXXXXXXXXXXX' \
          -d $'{   "treatment_plan": {     "practitioner_id": "string"   },   "patient": {     "id": "string",     "external_id": "string",     "email": "string",     "first_name": "string",     "last_name": "string",     "date_of_birth": "string",     "gender": "string",     "mobile_number": "string",     "discount": "string",     "send_welcome_email": "string"   },   "entrypoint": "string" }'
```

--------------------------------

### Retrieve Treatment Plan Link (API)

Source: https://fullscript.dev/technical-reference/dynamic-link

Generates a redirect URL for editing an existing treatment plan. The treatment plan must be in a 'draft' or 'active' state. The entrypoint parameter specifies the initial page the user sees.

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

--------------------------------

### Retrieve a specific product via Fullscript API

Source: https://fullscript.dev/technical-reference/products

Fetches details for a specific product by its ID. Optionally accepts a practitioner_id to include custom dosage instructions if available.

```curl
curl "https://api-us-snd.fullscript.io/api/catalog/products/{id}" \
         -H 'Content-Type: application/json' \
         -H 'Authorization: Bearer XXXXXXXXXXXXXXXXXXXX'
```

--------------------------------

### GET /api/catalog/practitioner_types

Source: https://fullscript.dev/technical-reference/practitioner-types

Retrieves a list of all available practitioner types within the Fullscript catalog.

```APIDOC
## GET /api/catalog/practitioner_types

### Description
This resource allows you to retrieve a comprehensive list of all practitioner types available in the system.

### Method
GET

### Endpoint
/api/catalog/practitioner_types

### Parameters
#### Path Parameters
- None

#### Query Parameters
- None

#### Request Body
- None

### Request Example
```bash
curl "https://api-us-snd.fullscript.io/api/catalog/practitioner_types" \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer XXXXXXXXXXXXXXXXXXXX'
```

### Response
#### Success Response (200)
- **practitioner_types** (array) - A list of practitioner type objects.

#### Response Example
{
  "practitioner_types": [
    {
      "id": "pt_123",
      "name": "Naturopathic Doctor"
    }
  ]
}
```

--------------------------------

### List All Practitioner Protocols

Source: https://fullscript.dev/technical-reference/protocols

Retrieves a list of all treatment plan protocols belonging to a specific practitioner.

```APIDOC
## List All Practitioner Protocols

### Description
Retrieves a list of all treatment plan protocols that belong to a practitioner.

### Method
GET

### Endpoint
/api/clinic/practitioners/{practitioner_id}/protocols

### Path Parameters
- **practitioner_id** (string) - Required - Unique ID for the Practitioner

### Query Parameters
- **current_state** (string) - Optional - Takes an argument of `active`, `draft` or `cancelled` to return `active`, `draft` or `cancelled` protocols.
- **sort_by** (string) - Optional - Accepts one of the following arguments: `name` or `current_state`.
- **order_by** (string) - Optional - Ordering defaults to `ASC` and can take an argument of `ASC` or `DESC`.
- **ownership_type** (string) - Optional - Takes an argument of `owned`, `shared` or `all` to return only protocols created by the practitioner, only protocols shared with the practitioner, or both protocols created by and shared with the practitioner, respectively. If this argument is not included, only protocols created by the practitioner are returned.

### Request Example
```bash
curl "https://api-us-snd.fullscript.io/api/clinic/practitioners/{practitioner_id}/protocols" \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer XXXXXXXXXXXXXXXXXXXX'
```

### Response
#### Success Response (200)
OK

#### Error Responses
- **403** Forbidden
- **404** Not Found
- **422** Unprocessable Entity
```

--------------------------------

### GET /api/clinic/patients/{id}

Source: https://fullscript.dev/technical-reference/patients

Retrieves a specific patient's information using their unique ID.

```APIDOC
## GET /api/clinic/patients/{id}

### Description
Retrieves a specific patient's information using their unique ID.

### Method
GET

### Endpoint
/api/clinic/patients/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - Unique ID for the Patient

### Request Example
```bash
curl "https://api-us-snd.fullscript.io/api/clinic/patients/{id}" \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer XXXXXXXXXXXXXXXXXXXX'
```

### Response
#### Success Response (200)
OK

#### Error Responses
- **403** Forbidden
- **404** Not Found
```

--------------------------------

### List All Ingredients (curl)

Source: https://fullscript.dev/technical-reference/ingredients

This endpoint retrieves a list of all ingredients available on the Fullscript platform. It requires an API key for authentication and returns a JSON object containing ingredient data. No specific arguments are needed for this request.

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

--------------------------------

### List all products via Fullscript API

Source: https://fullscript.dev/technical-reference/products

Retrieves a list of all products available on the platform. Note that this endpoint is highly restricted and requires specific authorization for access.

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

--------------------------------

### GET /api/catalog/third_party_certifications/{id}

Source: https://fullscript.dev/technical-reference/third-party-certifications

Retrieves the specific details of a third-party certification by its unique identifier.

```APIDOC
## GET /api/catalog/third_party_certifications/{id}

### Description
Retrieves details for an existing third party certification using its unique ID.

### Method
GET

### Endpoint
/api/catalog/third_party_certifications/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - Unique ID for the third party certification

### Request Example
curl "https://api-us-snd.fullscript.io/api/catalog/third_party_certifications/{id}" \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer XXXXXXXXXXXXXXXXXXXX'

### Response
#### Success Response (200)
- **id** (string) - The unique identifier
- **name** (string) - The name of the certification

#### Error Handling
- **403** (Forbidden) - Access denied
- **404** (Not Found) - Certification ID does not exist

#### Response Example
{
  "id": "cert_123",
  "name": "Certified Halal"
}
```

--------------------------------

### Create In-Office Checkout (POST)

Source: https://fullscript.dev/technical-reference/treatment-plans

Initiates an in-office checkout process for a given treatment plan. This action clears the patient's current cart, populates it with the specified treatment plan, and returns a URL for practitioners to fulfill the checkout on Fullscript.

```curl
curl -X 'POST' "https://api-us-snd.fullscript.io/api/clinic/treatment_plans/{treatment_plan_id}/in_office_checkout" \
         -H 'Content-Type: application/json' \
         -H 'Authorization: Bearer XXXXXXXXXXXXXXXXXXXX'
```

--------------------------------

### GET /api/catalog/third_party_certifications

Source: https://fullscript.dev/technical-reference/third-party-certifications

Retrieves a comprehensive list of all third-party certifications available on the Fullscript platform.

```APIDOC
## GET /api/catalog/third_party_certifications

### Description
This resource allows you to list all third party certifications available on the platform.

### Method
GET

### Endpoint
/api/catalog/third_party_certifications

### Parameters
#### Path Parameters
- None

#### Query Parameters
- None

### Request Example
curl "https://api-us-snd.fullscript.io/api/catalog/third_party_certifications" \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer XXXXXXXXXXXXXXXXXXXX'

### Response
#### Success Response (200)
- **data** (array) - List of third party certification objects

#### Response Example
{
  "certifications": [
    { "id": "cert_123", "name": "Certified Halal" }
  ]
}
```

--------------------------------

### List All Fullscript Protocols

Source: https://fullscript.dev/technical-reference/protocols

Retrieves a list of all treatment plan protocols created by Fullscript.

```APIDOC
## List All Fullscript Protocols

### Description
Retrieves a list of all treatment plan protocols that have been created by Fullscript.

### Method
GET

### Endpoint
/api/clinic/fullscript_protocols

### Query Parameters
- **sort_by** (string) - Optional - Accepts a `name` argument.
- **order_by** (string) - Optional - Can take an argument of `ASC` or `DESC`.

### Request Example
```bash
curl "https://api-us-snd.fullscript.io/api/clinic/fullscript_protocols" \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer XXXXXXXXXXXXXXXXXXXX'
```

### Response
#### Success Response (200)
OK
```

--------------------------------

### GET /api/catalog/brands/{id}

Source: https://fullscript.dev/technical-reference/brands

Retrieve detailed information for a specific brand using its unique identifier.

```APIDOC
## GET /api/catalog/brands/{id}

### Description
Retrieves the full details for an existing brand by its unique ID.

### Method
GET

### Endpoint
/api/catalog/brands/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - Unique ID for the Brand

### Request Example
curl "https://api-us-snd.fullscript.io/api/catalog/brands/{id}" \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer XXXXXXXXXXXXXXXXXXXX'

### Response
#### Success Response (200)
- **brand** (object) - The brand details.

#### Response Example
{
  "id": "brand_123",
  "name": "Example Brand",
  "description": "Brand description here."
}
```

--------------------------------

### Retrieve a practitioner resource via cURL

Source: https://fullscript.dev/technical-reference/resources

Fetches details of a specific resource using the practitioner's ID and the unique resource ID. Returns a 200 OK status on success or 404 if not found.

```bash
curl "https://api-us-snd.fullscript.io/api/clinic/practitioners/{practitioner_id}/resources/{id}" \
         -H 'Content-Type: application/json' \
         -H 'Authorization: Bearer XXXXXXXXXXXXXXXXXXXX'
```

--------------------------------

### GET /api/clinic/patients/{patient_id}/addresses

Source: https://fullscript.dev/technical-reference/address

Retrieves a list of all addresses associated with a specific patient record.

```APIDOC
## GET /api/clinic/patients/{patient_id}/addresses

### Description
Retrieves a list of all addresses associated with a specific patient record.

### Method
GET

### Endpoint
/api/clinic/patients/{patient_id}/addresses

### Parameters
#### Path Parameters
- **patient_id** (string) - Required - Unique ID for the patient.

### Request Example
```bash
curl "https://api-us-snd.fullscript.io/api/clinic/patients/{patient_id}/addresses" \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer XXXXXXXXXXXXXXXXXXXX'
```

### Response
#### Success Response (200)
- **addresses** (array) - A list of address objects associated with the patient.

#### Error Responses
- **403** (Forbidden) - Authentication failed or insufficient permissions.
- **404** (Not Found) - The specified patient_id does not exist.
```

--------------------------------

### GET /api/events/lab_orders

Source: https://fullscript.dev/technical-reference/events

Retrieves a list of lab order events. Supports filtering by creation date and sorting.

```APIDOC
## GET /api/events/lab_orders

### Description
This endpoint lists all `lab_order` events. It allows filtering by `created_at` date and sorting by `created_at` or `order_by` parameters.

### Method
GET

### Endpoint
/api/events/lab_orders

### Parameters
#### Query Parameters
- **created_at** (string) - Optional - Filter by `created_at` date. Formats: `<yyyy-mm-dd`, `>yyyy-mm-dd`, `yyyy-mm-dd..yyyy-mm-dd`.
- **sort_by** (string) - Optional - Accepts `created_at`.
- **order_by** (string) - Optional - Accepts `ASC` or `DESC`. Defaults to `ASC`.

### Request Example
```bash
curl "https://api-us-snd.fullscript.io/api/events/lab_orders" \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer XXXXXXXXXXXXXXXXXXXX'
```

### Response
#### Success Response (200)
- **(structure not detailed in source)**

#### Response Example
(No example provided in source)
```

--------------------------------

### Resources - Create a resource

Source: https://fullscript.dev/technical-reference/pagination

Creates a new resource for a practitioner.

```APIDOC
## POST /api/resources

### Description
Creates a new resource for a practitioner.

### Method
POST

### Endpoint
`/api/resources`

### Parameters
#### Request Body
- **practitioner_id** (string) - Required - The ID of the practitioner to associate the resource with.
- **name** (string) - Required - The name of the resource.
- **type** (string) - Required - The type of the resource (e.g., 'document', 'video').
- **url** (string) - Optional - The URL of the resource.

### Request Example
```json
{
  "practitioner_id": "practitioner_xyz",
  "name": "Advanced Nutrition Tips",
  "type": "document",
  "url": "http://example.com/tips.pdf"
}
```

### Response
#### Success Response (201)
- **id** (string) - The unique identifier of the newly created resource.
- **name** (string) - The name of the resource.
- **type** (string) - The type of the resource.

#### Response Example
```json
{
  "id": "resource_2",
  "name": "Advanced Nutrition Tips",
  "type": "document"
}
```
```