API OVERVIEW

Pagination

Request IDs

Versioning

Rate Limits

CLINIC

Clinic

Retrieve a clinic

Practitioners

List all practitioners

Create a practitioner

Retrieve a practitioner

Update a practitioner

Practitioners

The practitioner object contains a record of all available practitioners that belong to a clinic. The API allows you to create and update practitioners. It also allows you to list all practitioners and find individual practitioners.

List all practitioners

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

Arguments

No arguments

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

Responses

Create a practitioner

Creates a new practitioner

Arguments

practitioner_type_id

string

Required

Unique Identifier for the Practitioner's Type

email

string

Required

Unique Email for the Practitioner

first_name

string

Required

Practitioner's first name

last_name

string

Required

Practitioner's last name

metadata

object

Metadata to be attached to the practitioner.

id

string

Your system's unique practitioner identifier.

POST /api/clinic/practitioners
curl -X 'POST' "https://api-us-snd.fullscript.io/api/clinic/practitioners" \ -H 'Content-Type: application/json' \ -H 'Authorization: Bearer XXXXXXXXXXXXXXXXXXXX' \ -d $'{ "practitioner_type_id": "string", "email": "string", "first_name": "string", "last_name": "string", "metadata": { "id": "string" } }'

Responses

Retrieve a practitioner

Retrieves an existing practitioner. You need to supply the unique ID for the practitioner.

Arguments

id

string

Required

Unique ID for the Practitioner

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

Responses

Update a practitioner

Updates a specific practitioner with the attributes that you pass in. Parameters not provided will remain unchanged.

Arguments

id

string

Required

Unique Identifier for the Practitioner

email

string

Unique Email for the Practitioner

first_name

string

Practitioner's first name

last_name

string

Practitioner's last name

metadata

object

Metadata to be attached to the practitioner.

id

string

Your system's unique practitioner identifier.

PATCH /api/clinic/practitioners/{id}
curl -X 'PATCH' "https://api-us-snd.fullscript.io/api/clinic/practitioners/{id}" \ -H 'Content-Type: application/json' \ -H 'Authorization: Bearer XXXXXXXXXXXXXXXXXXXX' \ -d $'{ "email": "string", "first_name": "string", "last_name": "string", "metadata": { "id": "string" } }'

Responses