API Reference

Change log

A timeline of changes, updates and features for the API.

💡Note on "Likelihood of impact"

We attempt to document every possible breaking change. Each record below has a corresponding "Likelihood of impact" value which is meant to serve as a reference for you on whether the change or update may affect your integration in some way.

Upcoming

  • Add email capabilities to Projects.
    • Projects will have their own unique email address and inbox which will allow the sending and receiving of Project emails directly through the API.
  • Add new calendar system.

History

Oct 29, 2024

Likelihood of impact: Low

  • Fix task assignee name not updating when assignee is changed.
  • Add ability to update lead connection default site type.

Oct 17, 2024

Likelihood of impact: Low

  • Add support for new leads system.
    • The new lead system will allow you to accept incoming leads from multiple sources as well as in multiple different formats.

Aug 27, 2024

Likelihood of impact: Medium

  • Add first 3 contacts to project webhook payload for ProjectStatusUpdate event.

Aug 12, 2024

Likelihood of impact: Low

  • Add model_type and model_id to project note creation.
  • Add endpoints to update / delete project notes.
  • Add API CRUD support for TaskNotes.
  • Add polymorphic support for managing linked contacts.
  • Add date range query filters to project notes for created and updated at.
  • Additional bug fixes and optimizations.

Jul 24, 2024

Likelihood of impact: Low

  • Add CRUD support for jet stream users.
  • Add Webhooks support for jet stream replies and users.
  • Add automatic retry for failed Webhooks.
  • Add endpoints for managing account notes.

Jun 24, 2024

Likelihood of impact: Low

  • Add Webhook support for project status changes.

May 7, 2024

Likelihood of impact: Low

  • Add ability to update project status id.

Mar 12, 2024

Likelihood of impact: Low

Jan 29, 2024

Likelihood of impact: Low

  • Add Users and Teams support to global search endpoint.
  • Add endpoints for managing a TeamCompany.
  • Add endpoints for managing a TeamMember.
  • Add read-only endpoints for TeamNote.
  • Add endpoints for managing a Team.

Jan 22, 2024

Likelihood of impact: Low

  • Add additional attributes to Projects including various financial data and notable dates.

Jan 12, 2024

Likelihood of impact: Low

  • Add ability to "result" appointments.
  • Add support for Webhooks.

Jan 3, 2024

Likelihood of impact: Low

  • Add a "date_range" filter to Appointments to allow filtering Appointments to a specific date range.