Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

IntakeQ Appointments API

Appointments, booking settings, and cancellation.

IntakeQ Appointments API is one of 6 APIs that IntakeQ publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Appointments. The published artifact set on APIs.io includes an OpenAPI specification, an API reference, and API documentation.

This API exposes 6 operations across 4 paths, and defines 4 schemas. It is described by OpenAPI 3.0.3, at version 1.0.

Requests are made against a single base URL, https://intakeq.com/api/v1.

6 operations 4 paths 4 schemas 3 GET2 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.0
Base URL
https://intakeq.com/api/v1
Authentication
API Key
Contact
Resource Areas
1

Authentication & Security 1

IntakeQ Appointments API declares 1 security scheme for authenticating requests. An API key is passed in the header as X-Auth-Key (authKey). By default, every request must be authenticated.

  • authKey — The account API key found under More Settings Integrations Developer API.

Paths & Operations 6

Across 4 paths, the API surfaces 6 operations — 3 GET, 2 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Appointments 6

Appointments, booking settings, and cancellation.

GET
/appointments
Query appointments
queryAppointments 8 params → 200401429
POST
/appointments
Create an appointment
createAppointment body → 200401
PUT
/appointments
Update an appointment
updateAppointment body → 200401
GET
/appointments/{appointmentId}
Retrieve a single appointment
getAppointment 1 param → 200401
GET
/appointments/settings
Retrieve booking settings
getBookingSettings → 200401
POST
/appointments/cancellation
Cancel an appointment
cancelAppointment body → 200401

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are Appointment (11 properties), AppointmentCreate (8 properties), AppointmentUpdate (7 properties), Practitioner (3 properties). Each schema is shown below with its type and property counts.

Practitioner
object
3 properties
AppointmentCreate
object
8 properties 8 required
Appointment
object
11 properties
AppointmentUpdate
object
7 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

intakeq-appointments-api-openapi.yml Raw ↑

Other APIs IntakeQ publishes across the network.

IntakeQ Clients API
IntakeQ Files API
IntakeQ Intake Forms API
IntakeQ Invoices API
IntakeQ Treatment Notes API