Versioning Policy
The Zolt API is currently on version 1 (v1). All v1 endpoints are served from https://api.zolt.io/v1.
When Zolt introduces a breaking change — such as removing a field, changing a field’s data type, or altering authentication behavior — we will release a new major version (e.g., v2) at https://api.zolt.io/v2. The previous version remains fully supported for 12 months after the new version ships, giving you ample time to migrate.
What counts as a breaking change?
What counts as a breaking change?
The following changes are considered breaking and will always trigger a new major API version:
- Removing or renaming an existing endpoint
- Removing or renaming a required or optional field from a request or response body
- Changing the data type of an existing field (e.g.,
string→integer) - Changing the HTTP method required by an endpoint
- Altering authentication or authorization behavior in a way that could reject previously valid requests
- Adding new optional request fields
- Adding new fields to response bodies
- Adding new endpoints
- Adding new enum values to existing fields (design your parsers to handle unknown enum values gracefully)
- Improving error messages without changing
codevalues
Subscribe to the Zolt Developer Newsletter to receive advance notice of upcoming breaking changes, new API features, and deprecation timelines directly in your inbox. Sign up at zolt.io/developers/newsletter.
January 2025 — v1.3.0
New features and additions in this release:-
priorityfield on tasks — Thepriorityfield is now returned on all task objects. Accepted values arelow,medium,high, andurgent. Existing tasks that were created before this release default tomedium. You can update priority usingPATCH /tasks/{task_id}. -
filter[priority]query parameter — All task list endpoints now support filtering by priority. For example:Filter by priority -
GET /tasks/{task_id}/comments— A new endpoint for retrieving comments on a task. Returns a paginated list of comment objects, each containingid,author_id,body, andcreated_at. Comment creation and deletion endpoints are planned for a future release.List task comments
November 2024 — v1.2.0
New features and additions in this release:-
Teams API — A full set of CRUD endpoints for managing teams is now available. See the Resources reference for full documentation.
GET /teamsPOST /teamsGET /teams/{team_id}DELETE /teams/{team_id}
-
New webhook events for member activity — Two new webhook event types have been added to support member lifecycle automations:
member.invited— fired when a user is invited to join the workspace.member.joined— fired when an invited user accepts and completes their first login.
-
X-Zolt-Timestampheader on webhook payloads — All webhook POST requests now include anX-Zolt-Timestampheader containing the Unix timestamp (in seconds) of when the event was generated. Use this value alongsideX-Zolt-Signatureto protect against replay attacks.
September 2024 — v1.1.0
New features and additions in this release:- Cursor-based pagination on all list endpoints — All endpoints that return collections now support cursor-based pagination via the
cursorandlimitquery parameters and themeta.next_cursorresponse field. See the Pagination guide for full details.
- Offset pagination parameters deprecated — The
pageandoffsetquery parameters that were available on list endpoints inv1.0.0are now deprecated and will be removed in v1.2.0. Migrate to cursor-based pagination before upgrading. The deprecated parameters continue to function inv1.1.0but return aDeprecationresponse header to signal that they will be removed.
July 2024 — v1.0.0
Initial public release of the Zolt REST API. This release establishes the foundation of the Zolt API with the following capabilities:-
Projects endpoints — Create, read, update, and delete projects in your workspace.
GET /projectsPOST /projectsGET /projects/{project_id}PATCH /projects/{project_id}DELETE /projects/{project_id}
-
Tasks endpoints — Full task management within projects, including assignment and status tracking.
GET /projects/{project_id}/tasksPOST /projects/{project_id}/tasksGET /tasks/{task_id}PATCH /tasks/{task_id}DELETE /tasks/{task_id}
-
Users endpoints — Retrieve authenticated user profiles and list workspace members.
GET /users/meGET /workspace/members
-
API key authentication — All requests authenticate via a
Bearertoken in theAuthorizationheader. API keys are scoped to a workspace and generated in Settings → Developer → API Keys. -
Webhook support — Register webhook endpoints to receive real-time event notifications for task and project changes. Initial supported events:
task.created,task.updated,task.deleted,project.created,project.updated,project.deleted.