Jump to Content

Guides API Reference

v1.2

API Reference

v1.2Guides API Reference

oncall

Create a new appointmentpost
Query appointmentsget
Get an appointmentget
Update an appointmentpatch
- Cancel an appointment
Metadata

Casenotes

Query casenotesget
Get a casenoteget
Query casenoteversionsget
Get a casenoteversionget
Get casenoteversions from casenoteget

Appointment Requests

Query appointment requestsget
Get an appointment requestget
Update an appointment requestpatch

Participants

Get a participantget
Update a participantpatch

Providers

Query providersget
Get a providerget

Forms

Query formsget
Get a formget
Assign a formpost
Get an assigned formget
Unassign a formdel

Roster

Query contactsget
Get a contactget
- Get forms assigned to contactget
- Get appointments for contactget
Create a contactpost
Update a contactpatch
Delete a contactdel
Working with custom fields

Availability

Create a new availabilitypost
Query availabilitiesget
Get an availabilityget
Update an availabilitypatch

Custom Appointment Field Answers

Query custom appointment field answersget
Get a custom appointment field answerget

Subscription Charge

Query subscription chargesget
Get a subscription chargeget

Webhooks

Appointment created
Appointment updated
Appointment request created
Appointment request updated
Form assigned
Form submitted
Authentication
Subscription charge created
Subscription charge updated

Errors

401 Unauthorized
400 Bad Request
404 Not Found

Powered by

Get a form

get

https://api.oncallhealth.ca/forms/{id}/

Retrieve an individual form

Path Params

id

int32

required

ID of the form to retrieve

Response

Updated over 5 years ago

Language

Credentials

OAuth2

Bearer

Response

Choose an example:

application/json

Updated over 5 years ago