{ "opencollection": "1.0.0", "info": { "name": "Knownwell api-keys clients API", "version": "v1" }, "items": [ { "info": { "name": "clients", "type": "folder" }, "items": [ { "info": { "name": "List Clients", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/clients", "params": [ { "name": "include_archived", "value": "", "type": "query" }, { "name": "limit", "value": "", "type": "query" }, { "name": "offset", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "List Clients" }, { "info": { "name": "Get Portfolio Health", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/clients/portfolio-health", "params": [ { "name": "include_archived", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Get Portfolio Health" }, { "info": { "name": "Get Trending Clients", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/clients/trending", "params": [ { "name": "direction", "value": "", "type": "query" }, { "name": "limit", "value": "", "type": "query" }, { "name": "include_archived", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Get Trending Clients" }, { "info": { "name": "Search Clients", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/clients/search", "params": [ { "name": "query", "value": "", "type": "query" }, { "name": "fields", "value": "", "type": "query" }, { "name": "include_archived", "value": "", "type": "query" }, { "name": "limit", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Search Clients" }, { "info": { "name": "Get Statistics", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/clients/statistics/overview", "params": [ { "name": "include_archived", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Get Statistics" }, { "info": { "name": "Export Clients Csv", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/clients/export/csv", "params": [ { "name": "include_archived", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Export Clients Csv" }, { "info": { "name": "Get Clients By Risk", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/clients/by-risk/:risk_level", "params": [ { "name": "risk_level", "value": "", "type": "path" }, { "name": "include_archived", "value": "", "type": "query" }, { "name": "limit", "value": "", "type": "query" }, { "name": "offset", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Get Clients By Risk" }, { "info": { "name": "Get Client", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/clients/:client_id", "params": [ { "name": "client_id", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Get Client" }, { "info": { "name": "Get Client History", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/clients/:client_id/history", "params": [ { "name": "client_id", "value": "", "type": "path" }, { "name": "months", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Get Client History" }, { "info": { "name": "Get Client Priorities", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/clients/:client_id/priorities", "params": [ { "name": "client_id", "value": "", "type": "path" }, { "name": "status_filter", "value": "", "type": "query" }, { "name": "limit", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Get Client Priorities" }, { "info": { "name": "Get Client Notes", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/clients/:client_id/notes", "params": [ { "name": "client_id", "value": "", "type": "path" }, { "name": "limit", "value": "", "type": "query" }, { "name": "offset", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Get Client Notes" }, { "info": { "name": "Get Client Key People", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/clients/:client_id/key-people", "params": [ { "name": "client_id", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Get Client Key People" }, { "info": { "name": "List Client Streams", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/clients/:client_id/streams", "params": [ { "name": "client_id", "value": "", "type": "path" }, { "name": "include_inactive", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "List Client Streams" }, { "info": { "name": "Get Stream", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/clients/:client_id/streams/:stream_id", "params": [ { "name": "client_id", "value": "", "type": "path" }, { "name": "stream_id", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Get Stream" } ] } ], "bundled": true }