API OVERVIEW

Pagination

Request IDs

Versioning

Rate Limits

CLINIC

Clinic

Retrieve a clinic

Staff

List all staff

Create a staff member

Retrieve a staff member

Update a staff member

Staff

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

List all staff

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

Arguments

No arguments

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

Responses

Create a staff member

Creates a new staff member

Arguments

email

string

Required

Unique Email for the staff member

first_name

string

Required

Staff member's first name

last_name

string

Required

Staff member's last name

metadata

object

Metadata to be attached to the staff member.

id

string

Your system's unique staff identifier.

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

Responses

Retrieve a staff member

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

Arguments

id

string

Required

Unique ID for the staff member

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

Responses

Update a staff member

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

Arguments

id

string

Required

Unique Identifier for the staff member

email

string

Unique Email for the staff member

first_name

string

Staff member's first name

last_name

string

Staff member's last name

metadata

object

Metadata to be attached to the staff member.

id

string

Your system's unique staff identifier.

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

Responses