📋 Changelog

API Changelog

A complete history of changes to the Proxiant API — new features, bug fixes, and deprecation notices. We follow semantic versioning. Breaking changes only happen on major version bumps.

ℹ️
Non-breaking additions (new fields, new endpoints, new webhook events) are deployed continuously without a version bump. Only breaking changes increment the API version. Write code that ignores unknown fields to remain forward-compatible.
v1.1.0 April 2025
Added
  • Added New webhook events: hive.job_posted, hive.job_accepted, and eservice.accepted. These fire when jobs interact with The Hive marketplace and eService flow. See the Webhooks reference for payload details.
  • Added New field hive_posted (boolean) on the job object. true when a job has been posted to The Hive marketplace. Returned on all job list and get responses.
  • Added New field hive_accepted_at (ISO 8601 | null) on job objects where hive_posted is true. null until a server accepts the job from The Hive.
v1.0.2 March 2025
Fixed
  • Fixed PATCH /jobs/:id status transition validation now returns a proper 422 unprocessable response with a human-readable reason when an invalid transition is attempted. Previously returned a generic 400 bad_request with no explanation, making it difficult to distinguish from other request errors.
  • Fixed The X-RateLimit-Reset header was returning the wrong timezone offset in some edge cases. Now always returns a Unix timestamp (UTC), consistent with the documented behavior.
  • Fixed GET /jobs with both due_before and due_after filters set to the same date was incorrectly returning an empty result set instead of jobs due on that exact date. Now correctly treats same-day range as inclusive on both ends.
v1.0.1 February 2025
Added
  • Added New field sister_job_ids (array of UUIDs) on the job object. When a job has related jobs — e.g., multiple defendants in the same case — their IDs are listed here. Empty array if no sister jobs exist.
  • Added New field diligence_satisfied (boolean) on the job object. true when the combination of attempts meets the diligence requirements for the job's jurisdiction and type. Used to determine affidavit eligibility.
  • Added New filter server_id on GET /jobs. Filter the job list to a specific server's assignments.
v1.0.0 January 2025
Initial Release
  • Added Initial public API release. Full REST API with bearer token authentication, paginated responses, and a consistent error envelope.
Jobs Attempts Clients Courts Invoices Affidavits Webhooks

Upcoming Changes

The following changes are planned for future releases. Items marked as breaking changes will only ship in a major version bump (v2.0), with a migration guide and advance notice.

⚠️
Breaking change in v2.0 (planned Q3 2025): The attempt.outcome field values will be renamed for consistency across the platform. Current values like no_answer will be replaced with a namespaced format. A full migration guide will be published at least 60 days before the v2.0 release. Subscribe to API announcements →
Planned
Cursor-based pagination — An alternative to page/offset pagination for high-volume integrations that need consistent ordering on fast-changing datasets.
Planned
Bulk job creation — POST /jobs/bulk to create up to 100 jobs in a single API call. Useful for migrating from other platforms.
Planned
Sandbox environment — fh_test_ prefixed keys against a separate sandbox environment for integration testing without touching real data.

Want to be notified about API changes? Email api@proxiant.co to join the developer mailing list.