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

Kno2 Attachments API

Upload, retrieve, and mark clinical document attachments.

Kno2 Attachments API is one of 7 APIs that Kno2 publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

This API exposes 3 operations across 2 paths, and defines 1 schema. It is described by OpenAPI 3.0.3, at version 1.0.

Requests are made against 2 base URLs: https://{subscription}.kno2fy.com, https://{subscription}.kno2-stage.com.

3 operations 2 paths 1 schemas 1 GET1 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://{subscription}.kno2fy.com
Authentication
HTTP Bearer, HTTP Basic
Contact
Resource Areas
1

Authentication & Security 2

Kno2 Attachments API declares 2 security schemes for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). It accepts HTTP basic authentication (basicAuth). By default, every request must be authenticated.

  • bearerAuth — Bearer access token obtained from POST /api/token.
  • basicAuth — HTTP Basic with base64(clientid:clientsecret), used only against /api/token to obtain a Bearer token.

Paths & Operations 3

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

Attachments 3

Upload, retrieve, and mark clinical document attachments.

GET
/api/messages/{id}/attachments/{attachmentId}
Retrieve an attachment
getAttachment 2 params → 200401404
POST
/api/messages/{id}/attachments/{attachmentId}
Upload an attachment
uploadAttachment 2 params body → 200401
PUT
/api/messages/{id}/attachments/{attachmentId}/read
Mark an attachment as read
markAttachmentRead 2 params → 200401

Schemas 1

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

Attachment
object
MODELED - a clinical document attachment.
5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

kno2-attachments-api-openapi.yml Raw ↑

Other APIs Kno2 publishes across the network.

Kno2 FHIR API
Kno2 Patient Record Query API
Kno2 Authentication API
Kno2 Directory API
Kno2 Intake API
Kno2 Messaging API