API OVERVIEW

Pagination

Request IDs

Versioning

Rate Limits

CLINIC

Clinic

Retrieve a clinic

FULLSCRIPT CATALOG

Categories

Categories

The category object contains a record of all categories from a clinic.

List all category products

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.

Arguments

category_id

string

Required

Unique ID for the Category.

sort_by

string

Accepts a name argument.

order_by

string

Ordering defaults to ASC and can take an argument of ASC or DESC.

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

Responses

Retrieve a Category

Retrieves an existing Category.

Arguments

id

string

Required

Unique identifier of the Category.

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

Responses

List all categories

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

Arguments

No arguments

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

Responses