Skip to content
English
Submit a Support Ticket Check Ticket Status
  • There are no suggestions because the search field is empty.

Knownwell API

Get Knownwell Scores into Your Tools (Docs, Dashboards, Exports)

Knownwell API allows you to pull your client portfolio data including your client Knownwell scores, health categories, trends, priorities, notes, and key contacts. You can pull this data into whatever you already run: internal dashboards, spreadsheets, reports, CRM exports, or customer success docs. The API is read-only, so it’s safe for reporting and automation. 

What you can do with it

  • Export CQ scores and health status for all clients (or a subset).
  • Track score trends over time (history and changes). 
  • Roll up portfolio health (distribution, averages, topic overview). 
  • Pull action items (priorities) tied to a client.
  • Pull notes and key people to power internal context and reporting. 

Getting access (API key)

To use the API, you’ll need an API key.

  • Request it from your Knownwell account manager, email us at success@knownwell.com, or submit this form and check off "API Related Inquiry."
  • Treat it like a password (don’t paste it into public docs or shared files).

How authentication works 

Every request includes your API key in a request header called X-API-Key.  

  • The API only supports HTTPS.
  • Keys are read-only by default (you can retrieve data, not change it).  

Where to connect (Base URL)

All API requests start with:

  • Production Base URL: https://ci-api.knownwell.com/v1 

How to get Knownwell scores into your documents 

Most customers do this in one of these patterns:

  • Spreadsheet export workflow
  • Pull GET / clients on a schedule (daily/weekly).
  • Write results into a spreadsheet tab used for reporting or mail-merge docs.
  • Use limit/skip if you have a large portfolio.
  • Dashboard / BI workflow
  • Pull GET / clients / portfolio-health for rollups.
  • Pull GET / clients / {client_id} / history for trend lines. 
  • Client brief / QBR doc workflow
  • Pull GET / clients/ {client_id} for the score snapshot and topics.
  • Pull priorities + notes + key people for “what to do next” and relationship context.

FAQs

Do I need engineering help to use this?

Not always. If you already use a tool that can call an API and write results into a sheet or database, you can usually connect it with minimal support. You will need an API key.

Can the API change my data?

No. Knownwell API endpoints are read-only.

How far back can I pull history?

Up to 365 days per client via the history endpoint. 

What if I get rate-limited?

Slow down and retry after the time suggested by the API (you’ll see a 429 error when it happens). 

Where do I go for help?

Knownwell provides help via email at success@knownwell.com and also publishes API status and interactive docs. 

Support

If you need to contact us for assistance, you can do so by submitting a ticket here or by emailing us at success@knownwell.com. When you contact support, please include:

  • The request ID (returned with errors)
  • Timestamp
  • What you expected vs. what happened
  • (Exclude your API key.)

More information about Knownwell's API Documentation can be found here.