AveeCare API

Overview

The AveeCare API is a REST API that lets your own programs read and write your agency's data in AveeCare. It uses predictable resource-oriented URLs, JSON request and response bodies, standard HTTP status codes and Bearer-token authentication.

Every request is made against your own agency. A key can only see and change the data of the agency it was created in.

Quickstart

1. In AveeCare, open Settings → API Keys and create a key. Choose read for read-only access or read + write to change data. Copy the key, which starts with ak_.
2. Store it in an environment variable, for example AVEECARE_API_KEY. Never put it in browser code or a public repository.
3. Make a request.

curl "https://api.aveecare.com/v1/me" \
  -H "Authorization: Bearer $AVEECARE_API_KEY"

{
  "object": "me",
  "id": "Xk3mP9qR2tLw",
  "name": "Payroll export",
  "scopes": [
    "read",
    "write"
  ],
  "role": "RootUser",
  "email": "alice.smith@example.com",
  "expiresAt": "2027-10-05T00:00:00.000Z",
  "organization": {
    "id": "0d6c1f2a-3b4e-4c5d-9e8f-7a6b5c4d3e2f",
    "name": "AveeCare Demo Agency"
  }
}

See Authentication for scopes and error handling.

Conventions

Resources

The full machine-readable description is available as an OpenAPI 3.1 JSON file.