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

Client file attachments and folders.

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

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

This API exposes 5 operations across 4 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 4 paths 1 schemas 1 DELETE3 GET1 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 Files 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 4 paths, the API surfaces 5 operations — 1 DELETE, 3 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Files 5

Client file attachments and folders.

GET
/files
Get a client's files
getClientFiles 1 param → 200401
GET
/folders
Get folders
getFolders → 200401
GET
/files/{fileId}
Download a file
downloadFile 1 param → 200401
DELETE
/files/{fileId}
Delete a file
deleteFile 1 param → 200401
POST
/files/{clientId}
Upload a file to a client's record
uploadFile 1 param body → 200401

Schemas 1

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

File
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

intakeq-files-api-openapi.yml Raw ↑

Other APIs IntakeQ publishes across the network.

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