Getting started

The Cicini Public API is a read-only, API key authenticated HTTP API for organization data.

Base URL

Environment	Base URL
Production	`https://cicini.com`
Local development	`http://localhost:3000`

All paths are relative to that base (for example /api/public/v1/customers).

Prerequisites

A Cicini organization on a plan with API access (Professional or Enterprise — Free and Starter cannot create API keys).
An API key created in the dashboard under Settings → Integrations → API keys (cic_test_… or cic_live_…).
A backend or CLI that can send Authorization: Bearer … (never embed live keys in a browser SPA).

First request

export CICINI_API_KEY="cic_test_YOUR_KEY"
export CICINI_BASE_URL="https://cicini.com"   # or http://localhost:3000

curl -sS \
  -H "Authorization: Bearer $CICINI_API_KEY" \
  -H "Accept: application/json" \
  "$CICINI_BASE_URL/api/public/v1/customers?limit=10"

Success shape

{
  "data": [
    {
      "id": "clx…",
      "firstName": "Ada",
      "lastName": "Lovelace",
      "displayName": "Ada Lovelace",
      "email": "ada@example.com"
    }
  ],
  "pagination": {
    "limit": 10,
    "offset": 0,
    "total": 42,
    "hasMore": true
  }
}

Failure example (missing key)

{
  "error": "Unauthorized",
  "message": "API key required in Authorization header"
}

Status: 401.

Conventions

Convention	Detail
Protocol	HTTPS in production
Format	JSON request/response; `Accept: application/json`
Auth	`Authorization: Bearer <api_key>` only
Time fields	ISO-8601 strings (for example `2026-07-19T15:00:00.000Z`)
Money	Integer cents where present (`priceCents`, `amountPaidCents`)
Org scope	Inferred from the API key — you never pass `orgId` on public v1

Pagination (summary)

Query	Default	Limits
`limit`	`50`	Integer 1–100
`offset`	`0`	Integer ≥ 0

Loop while pagination.hasMore is true, increasing offset by limit. Full guide: Pagination.

What to call next

Goal	Endpoint
Sync CRM contacts	`GET /api/public/v1/customers`
Export schedule	`GET /api/public/v1/appointments`
Understand failures	Errors
Plan / rate honesty	Rate limits · API surface

Interactive parameter docs: API Reference tab (OpenAPI playground).

Get started

Core resources

Examples

Getting started

Getting started

Base URL

Prerequisites

First request

Success shape

Failure example (missing key)

Conventions

What to call next

​Getting started

​Base URL

​Prerequisites

​First request

​Success shape

​Failure example (missing key)

​Conventions

​Pagination (summary)

​What to call next

Getting started

Base URL

Prerequisites

First request

Success shape

Failure example (missing key)

Conventions

Pagination (summary)

What to call next