---
title: "ClinicCards"
description: "Connect ClinicCards, obtain the required access and configure permitted actions."
url: "https://documentation.verbatik.com/integrations/cliniccards/"
---

# ClinicCards

Connect ClinicCards, obtain the required access and configure permitted actions.

The API adapter is implemented. Validate your own account and authorized actions before routing production calls.

## Before you start

Connect the account belonging to this business and workspace. Vendor subscriptions, API limits and role permissions still apply.

**API:** ClinicCards clinic management REST API

**Authentication:** Clinic API key in Token header

## Get access and connect

1. A clinic owner opens Settings → Other → Clinic settings and generates the ClinicCards API key.
2. Save the key in Verbatik and test /api/clinic-profile.
3. Read staff, cabinets and fee-schedule IDs. Determine free time from provider shifts minus appointments and reserved time blocks.
4. Find or create the patient and book a visit using patient, doctor and cabinet IDs. Start/end times must follow ClinicCards' five-minute schedule increments.
5. Rescheduling and cancellation send all required visit fields. Cancellation sets CANCELLED and preserves the record instead of deleting it.

## Account requirements

- ClinicCards clinic owner/admin
- Generated clinic API key
- Doctor, cabinet, patient and optional fee schedule IDs

## Permissions

- `Clinic-level API access to patients, appointments, staff, rooms, shifts and time blocks`

Grant the subset needed for the actions you enable. API scopes do not override the connected user’s record permissions or vendor validation rules.

## Connection fields

- `accessToken` — API key or authorized access token (required). Secret fields are saved as workspace credentials.

## Available actions

- `test_connection` — **Read**. Read clinic profile
- `list_staff` — **Read**. Read clinic staff
- `list_cabinets` — **Read**. Read treatment rooms
- `list_services` — **Read**. Read fee schedule
- `list_appointments` — **Read**. Read appointments for a bounded date range. Combine shifts, appointments and reserved blocks to determine free time.
- `list_shifts` — **Read**. Read provider shifts for a bounded date range. Combine shifts, appointments and reserved blocks to determine free time.
- `list_reserved_blocks` — **Read**. Read reserved time blocks for a bounded date range. Combine shifts, appointments and reserved blocks to determine free time.
- `find_patient` — **Read**. Read matching patients by phone, using international digits without the plus sign.
- `create_patient` — **Write**. Create a patient with contact details.
- `update_patient` — **Write**. Update an existing patient's name or contact details.
- `create_appointment` — **Write**. Create a visit after checking shifts, appointments and reserved blocks.
- `reschedule_appointment` — **Write**. Update a visit's full scheduling fields, preserving patient/doctor/room details.
- `cancel_appointment` — **Write**. Mark a visit CANCELLED while retaining its record. Supply the original patient/doctor/room/time fields.


## Verify before going live

Run Test connection and one read action against a known permitted record. Then test each intended write in an authorized sandbox. Check the provider’s own record and the Verbatik receipt. Publish the agent after assigning its tools. If a write has an unknown outcome, reconcile it with the vendor before trying again.

## Vendor documentation

- [Setup and API documentation](https://cliniccards.com/en/help/api)
- [Additional provider reference](https://cliniccards.com/api)
- [Additional provider reference](https://documenter.getpostman.com/view/29513893/2s9YBxZbqY)