Carium

Carium Caredb API

The Caredb API from Carium — 12 operation(s) for caredb.

Documentation GitHub OpenAPI

Operations 15

GET /caredb/v1/aggregation-individuals/ Patients GET Request #

GET /caredb/v1/journal-entries/ Welcome to the Carium API, which uses REST and JSON :API to support a wide… #

POST /caredb/v1/org-appointments/ Create an Appointment #

DELETE /caredb/v1/org-appointments/{id} Delete an Appointment #

GET /caredb/v1/org-appointments/{id} Get a Single Appointment #

PATCH /caredb/v1/org-appointments/{id} Update an Appointment #

GET /caredb/v1/org-document-classes/ List document classes #

GET /caredb/v1/org-document-references/ List Documents #

POST /caredb/v1/org-document-references/ Upload a Document #

GET /caredb/v1/org-document-references/{id}/get-download-info/ Download a Document #

POST /caredb/v1/org-document-references/{id}/process-upload/ Upload a Document #

GET /caredb/v1/todo-entries/ Worklist GET Request #

PATCH /caredb/v1/todo-entries/4e09e457-c46b-449b-a7b0-41319614287f PATCH /caredb/v1/todo-entries/4e09e457-c46b-449b-a7b0-41319614287f #

GET /caredb/v1/todo-entries/4e09e457-c46b-449b-a7b0-41319614287f/ Worklist GET Request for specific entry #

GET /caredb/v1/{v1id} GET /caredb/v1/aggregation-individuals #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/carium:carium-caredb-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Carium Caredb API
  version: '2026-10-07'
  description: 'GENERATED FROM DOCUMENTATION by API Evangelist on 2026-10-07: 26 operation(s) read from 5 public documentation page(s) (each operation names its page in x-source). This is not the provider''s published contract; Carium has published no machine-readable contract that the pipeline could find. Engine: local.'
  x-evidence-tiers:
    code-example: 8
    documentation: 18
    pages-with-code: 3
    pages-read: 5
  x-generated-from: documentation
  x-provenance: generated
  x-authored-by: API Evangelist
  x-generated: '2026-10-07'
  x-generator: generate-contract-from-docs.py
  x-engine: local
  x-sources:
  - https://developers.carium.com/docs/main/api/intro
  - https://developers.carium.com/docs/main/api/examples
  - https://developers.carium.com/docs/main/areas/metrics
  - https://developers.carium.com/docs/main/guides/pathways_intro/part_1
  - https://developers.carium.com/docs/main/guides/pathways_intro/part_2
servers:
- url: https://api.carium.com
security:
- bearer: []
tags:
- name: Caredb
paths:
  /caredb/v1/aggregation-individuals/:
    get:
      operationId: get_caredb_v1_aggregation_individuals
      tags:
      - Caredb
      summary: Patients GET Request
      description: Retrieves patient individuals for an organization.
      x-source: https://developers.carium.com/docs/main/guides/pathways_intro/part_2
      parameters:
      - name: filter[account-type]
        in: query
        required: false
        schema:
          type: string
      - name: filter[exclude-self]
        in: query
        required: false
        schema:
          type: boolean
      - name: organization-id
        in: query
        required: true
        schema:
          type: string
      - name: page[limit]
        in: query
        required: false
        schema:
          type: integer
      - name: page[offset]
        in: query
        required: false
        schema:
          type: integer
      - name: sort
        in: query
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetCaredbV1AggregationIndividualsResponse'
      x-evidence:
        kind: documentation
  /caredb/v1/journal-entries/:
    get:
      operationId: get_caredb_v1_journal_entries
      tags:
      - Caredb
      summary: Welcome to the Carium API, which uses REST and JSON :API to support a wide…
      description: Retrieves a list of journal entries. Authentication required via Bearer token.
      x-source: https://developers.carium.com/docs/main/api/intro
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /caredb/v1/org-appointments/:
    post:
      operationId: post_caredb_v1_org_appointments
      tags:
      - Caredb
      summary: Create an Appointment
      x-source: https://developers.carium.com/docs/main/api/examples
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostCaredbV1OrgAppointmentsRequest'
      responses:
        '201':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostCaredbV1OrgAppointmentsResponse'
      x-evidence:
        kind: documentation
  /caredb/v1/org-appointments/{id}:
    delete:
      operationId: delete_caredb_v1_org_appointments_id
      tags:
      - Caredb
      summary: Delete an Appointment
      x-source: https://developers.carium.com/docs/main/api/examples
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
    get:
      operationId: get_caredb_v1_org_appointments_id
      tags:
      - Caredb
      summary: Get a Single Appointment
      x-source: https://developers.carium.com/docs/main/api/examples
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
    patch:
      operationId: patch_caredb_v1_org_appointments_id
      tags:
      - Caredb
      summary: Update an Appointment
      x-source: https://developers.carium.com/docs/main/api/examples
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchCaredbV1OrgAppointmentsIdRequest'
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /caredb/v1/org-document-classes/:
    get:
      operationId: get_caredb_v1_org_document_classes
      tags:
      - Caredb
      summary: List document classes
      x-source: https://developers.carium.com/docs/main/api/examples
      parameters:
      - name: organization-id
        in: query
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /caredb/v1/org-document-references/:
    get:
      operationId: get_caredb_v1_org_document_references
      tags:
      - Caredb
      summary: List Documents
      x-source: https://developers.carium.com/docs/main/api/examples
      parameters:
      - name: filter[individual-id]
        in: query
        required: true
        schema:
          type: string
      - name: organization-id
        in: query
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
    post:
      operationId: post_caredb_v1_org_document_references
      tags:
      - Caredb
      summary: Upload a Document
      x-source: https://developers.carium.com/docs/main/api/examples
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostCaredbV1OrgDocumentReferencesRequest'
      responses:
        '201':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostCaredbV1OrgDocumentReferencesResponse'
      x-evidence:
        kind: documentation
  /caredb/v1/org-document-references/{id}/get-download-info/:
    get:
      operationId: get_caredb_v1_org_document_references_id_get_download_info
      tags:
      - Caredb
      summary: Download a Document
      x-source: https://developers.carium.com/docs/main/api/examples
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetCaredbV1OrgDocumentReferencesIdGetDownloadInfoResponse'
      x-evidence:
        kind: documentation
  /caredb/v1/org-document-references/{id}/process-upload/:
    post:
      operationId: post_caredb_v1_org_document_references_id_process_upload
      tags:
      - Caredb
      summary: Upload a Document
      x-source: https://developers.carium.com/docs/main/api/examples
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /caredb/v1/todo-entries/:
    get:
      operationId: get_caredb_v1_todo_entries
      tags:
      - Caredb
      summary: Worklist GET Request
      description: Lists worklist (todo) entries for an organization.
      x-source: https://developers.carium.com/docs/main/guides/pathways_intro/part_2
      parameters:
      - name: filter[include-done]
        in: query
        required: false
        schema:
          type: boolean
      - name: filter[include-inactive]
        in: query
        required: false
        schema:
          type: boolean
      - name: filter[provider-only]
        in: query
        required: false
        schema:
          type: boolean
      - name: organization-id
        in: query
        required: true
        schema:
          type: string
      - name: page[limit]
        in: query
        required: false
        schema:
          type: integer
      - name: page[offset]
        in: query
        required: false
        schema:
          type: integer
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetCaredbV1TodoEntriesResponse'
      x-evidence:
        kind: documentation
  /caredb/v1/todo-entries/4e09e457-c46b-449b-a7b0-41319614287f:
    patch:
      operationId: patch_caredb_v1_todo_entries_4e09e457_c46b_449b_a7b0_41319614287f
      tags:
      - Caredb
      summary: PATCH /caredb/v1/todo-entries/4e09e457-c46b-449b-a7b0-41319614287f
      x-source: https://developers.carium.com/docs/main/guides/pathways_intro/part_2
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchCaredbV1TodoEntries4E09E457C46B449BA7B041319614287FRequ'
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl -X 'PATCH' \\ 'https://api.carium.com/caredb/v1/todo-entries/4e09e457-c46b-449b-a7b0-41319614287f/' \\ -H 'accept: application/vnd.api+json' \\ -H 'Content-Type: application/json' \\ -H 'authorization: Bearer XXX' \\ -d '{ \"data\": { \"attributes\": [ { \"op\": \"replace\", \"path\": \"/due-time\", \"value\": \"2024-02-19 12:00:00\" } ], \"id\": \"284a395e-2e84-49e2-ba96-f82a73d67490\", \"type\": \"todo-entries\" } }' \n"
  /caredb/v1/todo-entries/4e09e457-c46b-449b-a7b0-41319614287f/:
    get:
      operationId: get_caredb_v1_todo_entries_4e09e457_c46b_449b_a7b0_41319614287f
      tags:
      - Caredb
      summary: Worklist GET Request for specific entry
      description: Retrieves a specific worklist entry by its ID.
      x-source: https://developers.carium.com/docs/main/guides/pathways_intro/part_2
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetCaredbV1TodoEntries4E09E457C46B449BA7B041319614287FRespon'
      x-evidence:
        kind: documentation
  /caredb/v1/{v1id}:
    get:
      operationId: get_caredb_v1_v1id
      tags:
      - Caredb
      summary: GET /caredb/v1/aggregation-individuals
      x-source: https://developers.carium.com/docs/main/guides/pathways_intro/part_2
      parameters:
      - name: v1id
        in: path
        required: true
        schema:
          type: string
      - name: filter[account-type]
        in: query
        required: false
        schema:
          type: string
      - name: filter[exclude-self]
        in: query
        required: false
        schema:
          type: string
      - name: organization-id
        in: query
        required: false
        schema:
          type: string
      - name: page[limit]
        in: query
        required: false
        schema:
          type: string
      - name: page[offset]
        in: query
        required: false
        schema:
          type: string
      - name: sort
        in: query
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Success (shape read from the example response on the page)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetCaredbV1V1IdResponse'
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl  \n Patients GET Request curl -X 'GET' \\ 'https://api.carium.com/caredb/v1/aggregation-individuals/?filter%5Baccount-type%5D=regular&filter%5Bexclude-self%5D=false&organization-id=f68573e8-b79f-42dc-9292-2d7ba43c9f33&page%5Blimit%5D=100&page%5Boffset%5D=0&sort=last-name' \\ -H 'accept: application/vnd.api+json' \\ -H 'authorization: Bearer XXX' \n Worklist  \n Worklist items are delegated to a C"
        collapsed_from: 5 example path(s) differing only at v1Id
components:
  schemas:
    GetCaredbV1TodoEntriesResponse:
      type: object
      properties:
        meta:
          type: object
        data:
          type: array
        data.id:
          type: string
        data.type:
          type: string
        data.attributes.text:
          type: string
        data.attributes.done:
          type: boolean
        data.attributes.created-at:
          type: string
    PostCaredbV1OrgDocumentReferencesResponse:
      type: object
      properties:
        data.id:
          type: string
          description: document reference id
        data.attributes.upload-info.upload-url:
          type: string
        data.attributes.upload-info.upload-data:
          type: object
    PatchCaredbV1OrgAppointmentsIdRequest:
      type: object
      properties:
        start-time:
          type: string
        end-time:
          type: string
      required:
      - start-time
      - end-time
    GetCaredbV1OrgDocumentReferencesIdGetDownloadInfoResponse:
      type: object
      properties:
        download-url:
          type: string
    GetCaredbV1V1IdResponse:
      type: object
      properties:
        page[offset]:
          type: integer
        page[limit]:
          type: integer
        page[total]:
          type: integer
    GetCaredbV1TodoEntries4E09E457C46B449BA7B041319614287FRespon:
      type: object
      properties:
        data:
          type: object
        data.id:
          type: string
        data.type:
          type: string
        data.attributes.text:
          type: string
        data.attributes.done:
          type: boolean
        data.attributes.created-at:
          type: string
        data.attributes.due-time:
          type: string
    PatchCaredbV1TodoEntries4E09E457C46B449BA7B041319614287FRequ:
      type: object
      properties:
        data:
          type: object
          properties:
            attributes:
              type: array
              items:
                type: object
                properties:
                  op:
                    type: string
                  path:
                    type: string
                  value:
                    type: string
                    format: date-time
            id:
              type: string
            type:
              type: string
    GetCaredbV1AggregationIndividualsResponse:
      type: object
      properties:
        meta:
          type: object
        data:
          type: array
        data.id:
          type: string
        data.type:
          type: string
        data.attributes.email:
          type: string
        data.attributes.first-name:
          type: string
        data.attributes.last-name:
          type: string
    PostCaredbV1OrgDocumentReferencesRequest:
      type: object
      properties:
        attachment-content-type:
          type: string
        attachment-filename:
          type: string
        class-id:
          type: string
        name:
          type: string
        description:
          type: string
        individual-id:
          type: string
        organization-id:
          type: string
      required:
      - attachment-content-type
      - attachment-filename
      - class-id
      - name
      - description
      - individual-id
      - organization-id
    PostCaredbV1OrgAppointmentsResponse:
      type: object
      properties:
        data.id:
          type: string
          description: id of the new appointment
    PostCaredbV1OrgAppointmentsRequest:
      type: object
      properties:
        organization-id:
          type: string
        individual-id:
          type: string
        practitioner-id:
          type: string
        start-time:
          type: string
        end-time:
          type: string
        status-id:
          type: string
        type-id:
          type: string
        add-video-channel:
          type: string
        guest-url:
          type: string
        host-url:
          type: string
        description:
          type: string
        patient-instruction:
          type: string
        location:
          type: string
      required:
      - organization-id
      - individual-id
      - practitioner-id
      - start-time
      - end-time
      - status-id
      - type-id
      - add-video-channel
  securitySchemes:
    bearer:
      type: http
      scheme: bearer