Added
- Contracts API: filter by
contact_id,contract_template_idandtenancy_idquery params
Added
- Identity Verifications API: webhook events
Added
- Identity Verifications API: read endpoints
- Unit Types API:
promotionexpandable association
Added
- Deals API: index filters
Added
- Unit Types API: filter by
site_idquery parameter
Added
- Contracts API: link to sign the contract on Storefront
- Unit Types API: link to create a new order on Storefront
Added
- Images API: expose sites and unit types images
Added
- Deals API: add
loseendpoint; addreopenendpoint
Fixed
- Invoices API: response payload will show accounting nominal code
Added
- Invoices API: add
subscriptionandtenancyexpandable objects and filters to invoice resource
Added
- Deals API: add
winendpoint
Added
- Contacts API: add
metadatato contact resource - Orders API: add
metadatato order resource - Tasks API: add
metadatato task resource
Added
- Notes API: add
metadatato note resource - Timeline Events API: create, update, and destroy endpoints
- Timeline Sources API: read endpoints
- Timeline Templates API: read endpoints
Added
- Contracts API:
contract.createdwebhook event;contract.signedwebhook event - Deals API:
deal.wonwebhook event;deal.reopenedwebhook event;deal.lostwebhook event
Added
- Contracts API: filter by site ID and status
- Contracts API (beta): replace
subscriptionwithtenancyin contract response
Added
- Contracts API: show endpoint; list endpoint
- Notes API: filter by resource_type
- Webhook Endpoints API: add
metadatato webhook endpoint resource
Added
- Credit Notes API: sorting
- Deals API:
deal.createdwebhook event;deal.updatedwebhook event - Units API: search filter on the list endpoint
Added
- Notes API:
note.createdwebhook event;note.updatedwebhook event; create endpoint - Sites API: search filter on the list endpoint
- Subscriptions API: filter by contact ID
- OpenAPI: add missing pagination params to Staff 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
- OpenAPI: fixes (consistency & references)
Added
- Deal Stages API: list and show endpoints
- Deals API: list and show endpoints
- Notes API: list endpoint
Added
- Staff API: search filter by name or email
- Units API: add
unit_allocationexpandable object to unit resource
Added
- Units API: grant access endpoint; deallocate endpoint
Added
- Tasks API: index filters and sorting
Added
- Units API: reserve endpoint
Added
- Tasks API:
task.reopenedwebhook event;task.updatedwebhook event - Webhook Endpoints API: endpoints scoped and managed by OAuth apps
Added
- Webhook Endpoints API: add
creatorto webhook endpoint resource
Added
- Tasks API:
task.completedwebhook event;task.createdwebhook event
Added
- Staff API: show endpoint
Added
- Staff API: list endpoint
Added
- Tasks API: open endpoint
Added
- Tasks API: complete endpoint; delete endpoint; update endpoint
- Unit Allocations API: list endpoint
Added
- OAuth 2: Authorization Code flow support
- Unit Allocations API: show endpoint
Added
- Contacts API: filter by email
Added
- Tasks API: create endpoint
Added
- Tasks API: show endpoint; list endpoint
Added
- Webhook Endpoints API: index filters
2025-12-16
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_periodto 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
Moneycomponent - Expandable responses
- Initial resource sorting
- Preparation for expandable resources in responses
- Webhooks Core