API OVERVIEW

Pagination

Request IDs

Versioning

Rate Limits

CLINIC

Clinic

Retrieve a clinic

Resources

The resource object contains a record of all resources made by or shared with a practitioner. The API allows you to create, update, and remove resources. It also allows you to retrieve resources linked to a treatment plan.

List all practitioner resources

Lists all Resources that the Practitioner has access to.

Arguments

practitioner_id

string

Required

Unique ID for the Practitioner

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

Responses

Create a resource

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

Arguments

practitioner_id

string

Required

The unique ID of the practitioner.

type

string

The type of resource. Can be any of the following strings: Guide, Handout, Infographic, Meal plan, or Workbook.

category

string

The category of the resource. Can be any of the following strings: Nutrition, Lifestyle, Physical activity, Supplements, or Health conditions.

attachment

string

Required

The resource that is being uploaded.

name

string

Required

The name of the resource that is being uploaded.

treatment_plan_id

string

The treatment plan ID with which the resource is being associated.

save_to_library

string

Required

A boolean value that signifies whether the resource should be saved to the practitioner's resource library.

POST /api/clinic/practitioners/{practitioner_id}/resources
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" }'

Responses

Retrieve a practitioner's resource

Retrieves a Resource that the Practitioner has access to.

Arguments

practitioner_id

string

Required

Unique ID for the Practitioner.

id

string

Required

Unique ID for the Resource.

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

Responses

Update a resource

Updates a Practitioner's Resource.

Arguments

practitioner_id

string

Required

Unique ID for the Practitioner.

id

string

Required

Unique ID for the Resource.

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

Responses

Delete a resource

Deletes an existing Practitioner's Resource.

Arguments

practitioner_id

string

Required

Unique ID for the Practitioner.

id

string

Required

Unique ID for the Resource.

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

Responses

List All Fullscript Resources

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

Arguments

No arguments

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

Responses