Caregiver API keys

Caregivers can create read-only or read and write keys for their own data, and renew or revoke them.

5 stepsUpdated for AveeCare
In this guide
Open Settings and find the API Keys cardLabel the key and choose its accessCopy the key once from the Your API Key dialogConnect an AI assistant or your own programRenew or revoke a key

Caregivers can create their own AveeCare API keys from the Caregiver Portal Settings page. A key lets an AI assistant like Claude Code, or a program or script you write against the AveeCare API, work with your own visits and schedule. It can only do what your caregiver role can already do in the app.

Quick answer

Open Settings from the caregiver sidebar, scroll to the API Keys card, then click Generate New API Key. Give the key a label, choose Read-only or Read & write, pick an expiry and click Generate Key. Copy the key from the dialog that follows; it is shown once. Use Revoke on the key when you are done with it.

Open Settings

What a caregiver key can do

  • Only what your caregiver role allows. Your own visits, schedule, profile and messages. It cannot open the company patient list, other caregivers' schedules, payroll, billing or settings.
  • It always acts as you. Notes, swap requests and visit requests made with your key are recorded as yours; a key cannot file them in another caregiver's name or approve them on the office's behalf.
  • Read-only or Read & write. A Read-only key can look things up but cannot change anything. Choose Read & write only if your program or assistant needs to make changes.
  • Logged. Every action the key takes is attributed to your caregiver account.
  • It expires. You choose 30, 60, 90 or 180 days when you create it.
  • No MFA prompt per request. The key replaces signing in, so store it like a password.

1. Open Settings and find the API Keys card

Open Settings

  1. Click Settings in the caregiver sidebar, then scroll to the API Keys card.

    The card sits below your notification settings. If you have no keys yet it says No API keys yet. Below the list, a Use your key panel shows the API address, a test command and SDK install commands.
    Caregiver Portal Settings page scrolled to the API Keys card, showing No API keys yet, with the Generate New API Key button outlined in a red box.

2. Label the key and choose its access

  1. Click Generate New API Key and read the notice.

    The Security & Compliance Notice explains that the key works without MFA on each request, carries your role, must be kept secret, and that everything it does is logged against your account.

  2. Type a label and choose Read-only or Read & write.

    Use a label that says where the key will live, for example Claude Code - My Phone. Read-only is selected by default and is enough for an assistant that answers questions about your schedule.
    Security and Compliance Notice dialog in the Caregiver Portal with a label typed in and the Access choice, Read-only selected, outlined in a red box.

  3. Pick an expiry, then click Generate Key.

    Choose 30, 60, 90 (recommended) or 180 days.

3. Copy the key once from the Your API Key dialog

  1. Click Copy next to the key.

    The key starts with ak_. This is the only time it is shown; AveeCare keeps only a hash, so nobody, including your office, can show it to you again.
    Your API Key dialog in the Caregiver Portal with the key, masked in this picture, outlined in a red box, the once-only warning and the Use your key examples below.

  2. Tick the confirmation box, then click Done.

    Done stays disabled until you tick I have copied and securely stored this key.

4. Connect an AI assistant or your own program

The Use your key panel has two tabs. REST API & SDKs shows the API address, a curl command to check the key works, and SDK install commands, with links to the API documentation. AI assistants (MCP) has a tab each for Claude Code, Codex, Cursor, Windsurf and other assistants, with the command or config to copy. Inside the dialog the examples already contain your new key.

5. Renew or revoke a key

  1. Renew: replace a key before it expires.

    Click Renew. You get a new key with the same label and access, and the old key stops working, so update your assistant or program straight away. Within 14 days of expiry the card shows how many days are left.

  2. Revoke: stop a key immediately.

    Click Revoke, then Revoke Key to confirm. The key shows as Revoked and stops working at once. The trash-can icon then removes it from your list.
    API Keys card in the Caregiver Portal with one Active key showing Read-only access and its expiry date, and the Revoke button outlined in a red box.

Common pitfalls

  • Closing the dialog before copying. The key is shown once. If you lose it, revoke it and generate a new one.
  • Expecting office-level access. A caregiver key carries your caregiver role. If you need company-wide data, ask your office to create a key from their own account.
  • Using one key on several devices. Create a key per phone, laptop or program, so you can revoke one without breaking the others.
  • Letting a key expire. Expired keys stop working. Renew before the date shown on the card.

Frequently asked questions

No. The key is shown once, right after you generate it. If you lost it, revoke it and generate a new one.
Whatever you can do in the caregiver portal: your own visits, schedule, profile and messages. A Read-only key can only look things up. A Read & write key can also make the changes your role allows, always in your own name.
Your office can see that the key exists, its label, access, when it was created and last used, and can revoke it. They cannot see or copy the key itself.
No. The key is tied to your account and everything it does is recorded as you. Each caregiver generates their own key.
Most caregivers will not. It is for caregivers who want an AI assistant or a small program to work with their own AveeCare data, for example summarizing the week's schedule or checking upcoming visits without opening the app.
Written by
Calvin Nesvig
Founding Partner, AveeCare

Builds AveeCare full-time. The AveeCare Help Center is written and maintained by the team that builds the product, so the steps in every article come from the same people who ship the features.

All help articlesNeed a person?