Changelog

Every change to the Apizeal API, newest first. The format follows Keep a Changelog and versions follow Semantic Versioning.

How to read this page

Category	What it means for your integration	Version bump
Breaking	Existing requests may stop working or return a different shape. Only ships in a new major version (a new URL prefix such as `/v2`) and after a deprecation notice here.	MAJOR
Added	New endpoints, fields, filters or scopes. Safe to ignore until you need them.	MINOR
Changed	Backward-compatible change in existing behavior (for example a limit raised or a description clarified). No action required.	MINOR / PATCH
Deprecated	Still works, but will be removed. The entry states the sunset date. Plan your migration.	MINOR
Removed	A previously deprecated feature is gone.	MAJOR
Fixed	A bug fix. Behavior now matches the documentation.	PATCH
Security	A security-related change. Read it even if you do nothing else.	Any

Compatibility promise

Within a major version we consider these changes non-breaking, so your code must tolerate them:

New fields in responses (ignore unknown fields).
New endpoints, new optional query parameters and new scopes.
New values in status or enum fields.
Changes to the free-text detail of errors (program against code).

Every route carries a lifecycle label in the reference: experimental (may change without a major bump — pin your usage to what you need), stable, deprecated (with a sunset date) and sunset. A deprecated route keeps working for at least 90 days after the notice.

1.1.1 2026-09-08

Fixed

Requests blocked by the security filter (WAF) now return the standard error envelope with "status": 403 and "code": "blocked"; before, status came back empty.

1.1.0 2026-09-04

Added

Notes: GET /v1/policies/{policy_id}/notes and GET /v1/contacts/{contact_id}/notes. Plain-text content only; the permissions field is exposed.
Reminders: GET /v1/policies/{policy_id}/reminders and GET /v1/contacts/{contact_id}/reminders.
Tasks: GET /v1/tasks (filters status_id, contact_id, policy_id, due_from, due_to) and GET /v1/tasks/{task_id}.
Medical appointments: GET /v1/contacts/{contact_id}/medical-appointments and GET /v1/contacts/{contact_id}/medical-appointments/{appointment_id}.
Scopes notes:read, reminders:read, tasks:read and medical:read. All API keys, existing and new, are granted every scope.

Changed

The API reference is now grouped by entity, in alphabetical order.

1.0.0 2026-08-27

Added

Initial release of the Apizeal API (read-only) for Growth accounts.
Contacts: GET /v1/contacts, GET /v1/contacts/{contact_id}, GET /v1/contacts/{contact_id}/policies.
Policies: GET /v1/policies, GET /v1/policies/{policy_id}, GET /v1/policies/{policy_id}/members.
Catalog: GET /v1/catalog/carriers, GET /v1/catalog/product-types, GET /v1/catalog/policy-statuses.
Bearer API keys created from the app (Integrations → API Keys), with optional expiration (90 or 365 days) and IP allowlist. Scopes contacts:read, policies:read, catalog:read.
Cursor pagination (next_cursor, page_size up to 100), string ids, and a single JSON error envelope with a stable code.