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 Clients API

Clients (patients), tags, and diagnoses.

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

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

This API exposes 5 operations across 3 paths, and defines 1 schema. 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.

5 operations 3 paths 1 schemas 1 DELETE2 GET2 POST

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 Clients 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 5

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

Clients 5

Clients (patients), tags, and diagnoses.

GET
/clients
Query clients
queryClients 9 params → 200401429
POST
/clients
Save or update a client
saveClient body → 200401429
POST
/clientTags
Add a tag to a client
addClientTag body → 200401
DELETE
/clientTags
Remove a tag from a client
removeClientTag 2 params → 200401
GET
/client/{clientId}/diagnoses
Query a client's diagnoses
queryClientDiagnoses 1 param → 200401

Schemas 1

The contract defines 1 schema that model the data the API accepts and returns. The most detailed is Client (10 properties). Each schema is shown below with its type and property counts.

Client
object
10 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

intakeq-clients-api-openapi.yml Raw ↑

Other APIs IntakeQ publishes across the network.

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