Customers - Cicini API

Read-only access to the organization customer directory.

List customers

GET /api/public/v1/customers

Auth: Bearer API key with scope clients:read
OpenAPI operationId: listCustomers dateOfBirth and gender are included only when the key also has clients.sensitive:read. Notes are never returned.

Query parameters

Name	Type	Default	Description
`limit`	integer	`50`	Page size (1–100)
`offset`	integer	`0`	Rows to skip

Validated by publicCustomersQuerySchema.

Response

{
  "data": [
    {
      "id": "clxcustomer…",
      "firstName": "Ada",
      "lastName": "Lovelace",
      "displayName": "Ada Lovelace",
      "email": "ada@example.com",
      "primaryPhone": "+1…",
      "createdAt": "2026-01-15T12:00:00.000Z",
      "updatedAt": "2026-01-15T12:00:00.000Z"
    }
  ],
  "pagination": {
    "limit": 50,
    "offset": 0,
    "total": 1,
    "hasMore": false
  }
}

Response fields are an allowlist (publicCustomerSchema). With clients.sensitive:read, the same object also includes dateOfBirth and gender.

Filters and scope

Behavior	Detail
Org scope	Key’s organization only
Soft-delete	Only `isActive: true` customers
Order	Newest `createdAt` first
Search	No public search query today — page through `data`

Example

curl -sS \
  -H "Authorization: Bearer $CICINI_API_KEY" \
  "https://cicini.com/api/public/v1/customers?limit=25&offset=0" | jq .

Errors

Status	When
`400`	Bad `limit` / `offset`
`401`	Missing or invalid API key
`403`	Missing `clients:read` (`WWW-Authenticate: Bearer error="insufficient_scope"`) or plan does not allow API access
`500`	Server error

See Errors.

Not available on public v1

GET /customers/:id
POST / PATCH / DELETE customers
Import/export CSV via API key