Versioning

What this is: how the API changes and how you hear about it. When you need it: before you ship something that depends on it.

curl

curl -s "$TASKSMATE_API_URL/openapi.public.json" | python -c "import json,sys; print(json.load(sys.stdin)['info']['version'])"

Python

import tasksmate
print(tasksmate.API_VERSION)   # the contract date this SDK was generated from

tm

tm --version

Today: 0.x — pre-release, no compatibility promise yet

• The version: the API is /v1 and its contract is dated 2026-09-25 — the info.version of /openapi.public.json and the api_version in every webhook payload.
• Until v1 is declared stable, any release may change anything.
• So: pin the SDK to an exact version, and read the changelog before upgrading.

How a deprecation is announced

• In the contract: the operation is marked deprecated (a badge in the reference).
• On the wire: a retired operation answers Deprecation, Sunset (the date it goes) and, when there is one, a Link: <…>; rel="successor-version".
• The Python SDK turns those headers into one DeprecationWarning per operation.

Deprecated in the contract today:

• projects.replace PUT /v1/projects/{project_id}
• tasks.replace PUT /v1/tasks/{task_id}
• organization-members.replace PUT /v1/organization-members/{user_id}/{org_id}
• designations.replace PUT /v1/designations/{designation_id}
• project-members.replace PUT /v1/project-members/{user_id}/{project_id}
• teams.replace PUT /v1/teams/{team_id}
• teams.replace_member PUT /v1/teams/{team_id}/members/{user_id}
• goals.replace PUT /v1/projects/{project_id}/goals/{goal_id}

What v1 will promise

When TasksMate declares v1 stable, this page will carry the written compatibility promise:

• which changes are additive and safe;
• how long a deprecated operation keeps working after its Sunset is announced;
• how dated versions move.

Until then, the 0.x note above applies to every page of this site.