Skip to main content
​
Invoices API
Added
  • Invoices API: due time-range filters (due_after, due_before); due_date sorting on the invoices list endpoint
​
Invoices API
Added
  • Invoices API: invoice.overdue webhook event, fired when an invoice becomes overdue for payment; collection_status and due_date fields on the Invoice resource; collection_status filter on the invoices list endpoint
​
Credit Notes API
Added
  • Credit Notes API: accounting_code field on line items, also included in the credit_note.created and credit_note.updated webhook payloads
​
Tenancies API
Added
  • Tenancies API: tenancy.auto_reservation.succeeded, tenancy.auto_reservation.partially_succeeded, and tenancy.auto_reservation.failed webhook events
​
Contract Templates APIContracts APICoupons APICredit Notes APIDeal Stages APIInvoices APINotes APIOrders Line Items APIProducts APIProtection Levels APISites APISubscriptions APITasks APITenancies APITimeline Sources APITimeline Templates APIUnit Allocations APIUnit Types APIUnits APIWebhook Endpoints APIOrders API
Added
  • Contract Templates API: updated and created time-range filters
  • Contracts API: updated time-range filters
  • Coupons API: updated and created time-range filters
  • Credit Notes API: updated time-range filters
  • Deal Stages API: updated and created time-range filters
  • Invoices API: updated time-range filters
  • Notes API: updated time-range filters
  • Orders Line Items API: updated and created time-range filters
  • Products API: updated time-range filters
  • Protection Levels API: updated and created time-range filters
  • Sites API: updated and created time-range filters
  • Subscriptions API: updated and created time-range filters
  • Tasks API: updated time-range filters
  • Tenancies API: updated and created time-range filters
  • Timeline Sources API: updated time-range filters
  • Timeline Templates API: updated time-range filters
  • Unit Allocations API: updated and created time-range filters
  • Unit Types API: updated and created time-range filters
  • Units API: updated time-range filters
  • Webhook Endpoints API: updated and created time-range filters
Changed
  • Orders API: payment URLs and the new payment details email are now generally available.
​
Orders API
Added
  • Orders API: beta support for the new payment details email; abandon endpoint and order.abandoned webhook event
Fixed
  • Orders API: emails is marked as deprecated in favor of the email_notifications field in the Create and Update requests
​
Unit Types API
Added
  • Unit Types API: live_prices field
​
Orders API
Added
  • Orders API: beta support for new payments URLs
​
Subscriptions API
Added
  • Subscriptions API: subscription.resumed webhook event
Fixed
  • Subscriptions API: subscription.cancelled webhook event emits for every subsequent cancellation after the first
​
Products API
Added
  • Products API: images
​
Tenancies API
Fixed
  • Tenancies API: webhook response payloads will be presented with tenancy data root
​
Deals API
Added
  • Deals API: deal.stage_changed webhook event
​
Contacts API
Added
  • Contacts API: add status field and filter by status
​
Deals API
Added
  • Deals API: create, update, and destroy endpoints
​
Orders API
Added
  • Orders API: filter by source and billing_period, plus updated_at and starts_at time-range filters
​
Contacts API
Added
  • Contacts API: filter by use_case, type, source marketing_source
​
Contacts API
Added
  • Contacts API: expose identity_check
​
Contracts API
Added
  • Contracts API: filter by contact_id, contract_template_id and tenancy_id query params
​
Identity Verifications API
Added
  • Identity Verifications API: webhook events
​
Identity Verifications APIUnit Types API
Added
  • Identity Verifications API: read endpoints
  • Unit Types API: promotion expandable association
​
Deals API
Added
  • Deals API: index filters
​
Unit Types API
Added
  • Unit Types API: filter by site_id query parameter
​
Contracts APIUnit Types API
Added
  • Contracts API: link to sign the contract on Storefront
  • Unit Types API: link to create a new order on Storefront
​
Images API
Added
  • Images API: expose sites and unit types images
​
Deals API
Added
  • Deals API: add lose endpoint; add reopen endpoint
​
Invoices API
Fixed
  • Invoices API: response payload will show accounting nominal code
​
Invoices API
Added
  • Invoices API: add subscription and tenancy expandable objects and filters to invoice resource
​
Deals API
Added
  • Deals API: add win endpoint
​
Contacts APIOrders APITasks API
Added
  • Contacts API: add metadata to contact resource
  • Orders API: add metadata to order resource
  • Tasks API: add metadata to task resource
​
Notes APITimeline Events APITimeline Sources APITimeline Templates API
Added
  • Notes API: add metadata to note resource
  • Timeline Events API: create, update, and destroy endpoints
  • Timeline Sources API: read endpoints
  • Timeline Templates API: read endpoints
​
Contracts APIDeals API
Added
  • Contracts API: contract.created webhook event; contract.signed webhook event
  • Deals API: deal.won webhook event; deal.reopened webhook event; deal.lost webhook event
​
Contracts API
Added
  • Contracts API: filter by site ID and status
Fixed
  • Contracts API: replace subscription with tenancy in contract response
​
Contracts APINotes APIWebhook Endpoints API
Added
  • Contracts API: show endpoint; list endpoint
  • Notes API: filter by resource_type
  • Webhook Endpoints API: add metadata to webhook endpoint resource
​
Credit Notes APIDeals APIUnits API
Added
  • Credit Notes API: sorting
  • Deals API: deal.created webhook event; deal.updated webhook event
  • Units API: search filter on the list endpoint
​
Notes APISites APISubscriptions API
Added
  • Notes API: note.created webhook event; note.updated webhook event; create endpoint
  • Sites API: search filter on the list endpoint
  • Subscriptions API: filter by contact ID
Fixed
  • OpenAPI: add missing pagination params to Staff API
​
Contacts APINotes APIUnits API
Added
  • Contacts API: search filter on the list endpoint
  • Notes API: update endpoint; destroy endpoint; show endpoint
  • Units API: overlock endpoint; remove overlock endpoint
Fixed
  • OpenAPI: fixes (consistency & references)
​
Deal Stages APIDeals APINotes API
Added
  • Deal Stages API: list and show endpoints
  • Deals API: list and show endpoints
  • Notes API: list endpoint
​
Staff APIUnits API
Added
  • Staff API: search filter by name or email
  • Units API: add unit_allocation expandable object to unit resource
​
Units API
Added
  • Units API: grant access endpoint; deallocate endpoint
​
Tasks API
Added
  • Tasks API: index filters and sorting
​
Units API
Added
  • Units API: reserve endpoint
​
Tasks APIWebhook Endpoints API
Added
  • Tasks API: task.reopened webhook event; task.updated webhook event
  • Webhook Endpoints API: endpoints scoped and managed by OAuth apps
​
Webhook Endpoints API
Added
  • Webhook Endpoints API: add creator to webhook endpoint resource
​
Tasks API
Added
  • Tasks API: task.completed webhook event; task.created webhook event
​
Staff API
Added
  • Staff API: show endpoint
​
Staff API
Added
  • Staff API: list endpoint
​
Tasks API
Added
  • Tasks API: open endpoint
​
Tasks APIUnit Allocations API
Added
  • Tasks API: complete endpoint; delete endpoint; update endpoint
  • Unit Allocations API: list endpoint
​
Unit Allocations API
Added
  • OAuth 2: Authorization Code flow support
  • Unit Allocations API: show endpoint
​
Contacts API
Added
  • Contacts API: filter by email
​
Tasks API
Added
  • Tasks API: create endpoint
​
Tasks API
Added
  • Tasks API: show endpoint; list endpoint
​
Webhook Endpoints API
Added
  • Webhook Endpoints API: index filters
​
Contacts APIContract Templates APICoupons APICredit Notes APIInvoices APIOrders APIOrders Line Items APIProduct Categories APIProducts APIProtection Levels APISites APISubscriptions APITenancies APIUnit Types APIUnits API
Official release of the 2025-09 version.Added
  • Contacts API: initial
  • Contract Templates API: initial
  • Coupons API: initial
  • Credit Notes API: PDF support; filters; initial
  • Filters: Time ranged filters
  • Invoices API: PDF support; filters; initial
  • Orders API: orders summary; support for starts at now; update action; filters; initial version of the create action; add billing_period to the order; initial version of index and show actions
  • Orders Line Items API: delete endpoint; update endpoint; create endpoint; list endpoint
  • Product Categories API: initial
  • Products API: filters; initial
  • Protection Levels API: initial
  • Sites API: initial
  • Subscriptions API: initial
  • Tenancies API: initial
  • Unit Types API: Base Price; initial
  • Units API: filters; initial
  • Add the Money component
  • Expandable responses
  • Initial resource sorting
  • Preparation for expandable resources in responses
  • Webhooks Core