Skip to main content
RevDesk versions its public REST API in the URL. The current stable surface is /v1. Additive changes—new endpoints, optional fields, enum values, and response properties—may ship within the current version. Clients should ignore response properties they do not recognize.

​
Compatibility policy

Within a stable API version, RevDesk does not remove documented fields, change their meaning, or make an optional request field required without a deprecation period. Security fixes may tighten validation immediately when accepting the old input would expose customers or third parties to material risk.

​
Deprecation notice

The /v1/jobs collection and detail routes are deprecated aliases for /v1/tasks. They remain available without a scheduled removal date, so existing integrations continue to work while new integrations use the task routes. Deprecated aliases return a Deprecation header and a successor-version link. If an incompatible removal becomes necessary, RevDesk will:
  1. Mark the affected OpenAPI operation or field as deprecated.
  2. Publish the replacement and migration instructions in these docs.
  3. Return a Deprecation response header and a Link header with rel="deprecation" from the affected endpoint.
  4. When a retirement date is known, return a Sunset header and provide at least 90 days’ notice before disabling the old behavior.

​
Monitoring changes

Use the canonical OpenAPI document for automated contract checks. The official TypeScript SDK is generated from that document and follows semantic versioning.