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

Knownwell clients API

The clients API from Knownwell — 14 operation(s) for clients.

Knownwell clients API is one of 9 APIs that Knownwell 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, API documentation, an API reference, and a getting-started guide.

This API exposes 14 operations across 14 paths, and defines 14 schemas. It is described by OpenAPI 3.1.0, at version v1.

Requests are made against the base URL https://api.knownwell.com/ci/v1.

14 operations 14 paths 14 schemas 14 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
v1
Base URL
https://api.knownwell.com/ci/v1
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Knownwell clients API declares 1 security scheme for authenticating requests. An API key is passed in the header as X-API-Key (APIKeyHeader).

Paths & Operations 14

Across 14 paths, the API surfaces 14 operations — 14 GET. Each is listed below with its method, path, parameters, and response codes.

clients 14
GET
/v1/clients
List Clients
list_clients_v1_clients_get 3 params → 200422
GET
/v1/clients/portfolio-health
Get Portfolio Health
get_portfolio_health_v1_clients_portfolio_health_get 1 param → 200422
GET
/v1/clients/trending
Get Trending Clients
get_trending_clients_v1_clients_trending_get 3 params → 200422
GET
/v1/clients/search
Search Clients
search_clients_v1_clients_search_get 4 params → 200422
GET
/v1/clients/statistics/overview
Get Statistics
get_statistics_v1_clients_statistics_overview_get 1 param → 200422
GET
/v1/clients/export/csv
Export Clients Csv
export_clients_csv_v1_clients_export_csv_get 1 param → 200422
GET
/v1/clients/by-risk/{risk_level}
Get Clients By Risk
get_clients_by_risk_v1_clients_by_risk__risk_level__get 4 params → 200422
GET
/v1/clients/{client_id}
Get Client
get_client_v1_clients__client_id__get 1 param → 200422
GET
/v1/clients/{client_id}/history
Get Client History
get_client_history_v1_clients__client_id__history_get 2 params → 200422
GET
/v1/clients/{client_id}/priorities
Get Client Priorities
get_client_priorities_v1_clients__client_id__priorities_get 3 params → 200422
GET
/v1/clients/{client_id}/notes
Get Client Notes
get_client_notes_v1_clients__client_id__notes_get 3 params → 200422
GET
/v1/clients/{client_id}/key-people
Get Client Key People
get_client_key_people_v1_clients__client_id__key_people_get 1 param → 200422
GET
/v1/clients/{client_id}/streams
List Client Streams
list_client_streams_v1_clients__client_id__streams_get 2 params → 200422
GET
/v1/clients/{client_id}/streams/{stream_id}
Get Stream
get_stream_v1_clients__client_id__streams__stream_id__get 2 params → 200422

Schemas 14

The contract defines 14 schemas that model the data the API accepts and returns. The most detailed are ClientDetailResponse (15 properties), StreamDetailResponse (15 properties), ClientResponse (13 properties), StreamResponse (11 properties). Each schema is shown below with its type and property counts.

ClientMetadata
object
Client metadata.
10 properties
StreamDetailResponse
object
Detailed stream response with insights from Cortex analytics.
15 properties 4 required
StreamResponse
object
Response model for a stream (sub-project within a client)
11 properties 4 required
ScoreChange
object
Score change over a time period.
3 properties 2 required
ScoreChanges
object
Score changes over different time periods.
2 properties
TrendDirection
string
PortfolioHealthResponse
object
Portfolio health metrics.
5 properties 4 required
RiskLevel
string
ValidationError
object
5 properties 3 required
ClientListResponse
object
Response model for list of clients.
3 properties 3 required
ClientResponse
object
Response model for client data.
13 properties 4 required
ClientDetailResponse
object
Detailed client response with additional data.
15 properties 4 required
StreamListResponse
object
Response model for list of streams.
4 properties 4 required
HTTPValidationError
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

knownwell-clients-api-openapi.yml Raw ↑

Other APIs Knownwell publishes across the network.

Knownwell api-keys API
Knownwell documentation API
Knownwell health API
Knownwell portfolios API
Knownwell root API
Knownwell status API
Knownwell streams API
Knownwell topics API