Skip to main content
Version: 2023-02-21

Changelog

2026-04-28

Users

GET /users/

  • endpoint deprecated

2026-04-21

Notes

POST /notes/

  • endpoint added

POST /notes/search

  • endpoint added

DELETE /notes/{id}

  • endpoint added

GET /notes/{id}

  • endpoint added

PUT /notes/{id}

  • endpoint added

PATCH /notes/{id}/attachments

  • endpoint added

PUT /notes/{id}/relations

  • endpoint added

POST /notes/{id}/restore

  • endpoint added

2026-04-15

Users

GET /users/

  • ⚠️ added the new audit-logs.export enum value to the users/items/scopes response property for the response status 200
  • ⚠️ added the new audit-logs.readonly enum value to the users/items/scopes response property for the response status 200
  • ⚠️ added the new locations.agency-subaccounts.manage enum value to the users/items/scopes response property for the response status 200
  • ⚠️ added the new locations.billing.manage enum value to the users/items/scopes response property for the response status 200
  • ⚠️ added the new locations.create enum value to the users/items/scopes response property for the response status 200
  • ⚠️ added the new locations.delete enum value to the users/items/scopes response property for the response status 200
  • ⚠️ added the new locations.details.manage enum value to the users/items/scopes response property for the response status 200
  • ⚠️ added the new locations.export.list enum value to the users/items/scopes response property for the response status 200
  • ⚠️ added the new locations.features-limits.manage enum value to the users/items/scopes response property for the response status 200
  • ⚠️ added the new locations.pause-resume enum value to the users/items/scopes response property for the response status 200
  • ⚠️ added the new payments/settings.write enum value to the users/items/scopes response property for the response status 200

POST /users/

  • ⚠️ added the new audit-logs.export enum value to the scopes response property for the response status 201
  • ⚠️ added the new audit-logs.readonly enum value to the scopes response property for the response status 201
  • ⚠️ added the new locations.agency-subaccounts.manage enum value to the scopes response property for the response status 201
  • ⚠️ added the new locations.billing.manage enum value to the scopes response property for the response status 201
  • ⚠️ added the new locations.create enum value to the scopes response property for the response status 201
  • ⚠️ added the new locations.delete enum value to the scopes response property for the response status 201
  • ⚠️ added the new locations.details.manage enum value to the scopes response property for the response status 201
  • ⚠️ added the new locations.export.list enum value to the scopes response property for the response status 201
  • ⚠️ added the new locations.features-limits.manage enum value to the scopes response property for the response status 201
  • ⚠️ added the new locations.pause-resume enum value to the scopes response property for the response status 201
  • ⚠️ added the new payments/settings.write enum value to the scopes response property for the response status 201
  • added the new optional request property twilioPhone
  • added the new audit-logs.export enum value to the request property scopes/items/
  • added the new audit-logs.export enum value to the request property scopesAssignedToOnly/items/
  • added the new audit-logs.readonly enum value to the request property scopes/items/
  • added the new audit-logs.readonly enum value to the request property scopesAssignedToOnly/items/
  • added the new locations.agency-subaccounts.manage enum value to the request property scopes/items/
  • added the new locations.agency-subaccounts.manage enum value to the request property scopesAssignedToOnly/items/
  • added the new locations.billing.manage enum value to the request property scopes/items/
  • added the new locations.billing.manage enum value to the request property scopesAssignedToOnly/items/
  • added the new locations.create enum value to the request property scopes/items/
  • added the new locations.create enum value to the request property scopesAssignedToOnly/items/
  • added the new locations.delete enum value to the request property scopes/items/
  • added the new locations.delete enum value to the request property scopesAssignedToOnly/items/
  • added the new locations.details.manage enum value to the request property scopes/items/
  • added the new locations.details.manage enum value to the request property scopesAssignedToOnly/items/
  • added the new locations.export.list enum value to the request property scopes/items/
  • added the new locations.export.list enum value to the request property scopesAssignedToOnly/items/
  • added the new locations.features-limits.manage enum value to the request property scopes/items/
  • added the new locations.features-limits.manage enum value to the request property scopesAssignedToOnly/items/
  • added the new locations.pause-resume enum value to the request property scopes/items/
  • added the new locations.pause-resume enum value to the request property scopesAssignedToOnly/items/
  • added the new payments/settings.write enum value to the request property scopes/items/
  • added the new payments/settings.write enum value to the request property scopesAssignedToOnly/items/

GET /users/search

  • ⚠️ added the new audit-logs.export enum value to the users/items/scopes response property for the response status 200
  • ⚠️ added the new audit-logs.readonly enum value to the users/items/scopes response property for the response status 200
  • ⚠️ added the new locations.agency-subaccounts.manage enum value to the users/items/scopes response property for the response status 200
  • ⚠️ added the new locations.billing.manage enum value to the users/items/scopes response property for the response status 200
  • ⚠️ added the new locations.create enum value to the users/items/scopes response property for the response status 200
  • ⚠️ added the new locations.delete enum value to the users/items/scopes response property for the response status 200
  • ⚠️ added the new locations.details.manage enum value to the users/items/scopes response property for the response status 200
  • ⚠️ added the new locations.export.list enum value to the users/items/scopes response property for the response status 200
  • ⚠️ added the new locations.features-limits.manage enum value to the users/items/scopes response property for the response status 200
  • ⚠️ added the new locations.pause-resume enum value to the users/items/scopes response property for the response status 200
  • ⚠️ added the new payments/settings.write enum value to the users/items/scopes response property for the response status 200

POST /users/search/filter-by-email

  • ⚠️ added the new audit-logs.export enum value to the users/items/scopes response property for the response status 200
  • ⚠️ added the new audit-logs.readonly enum value to the users/items/scopes response property for the response status 200
  • ⚠️ added the new locations.agency-subaccounts.manage enum value to the users/items/scopes response property for the response status 200
  • ⚠️ added the new locations.billing.manage enum value to the users/items/scopes response property for the response status 200
  • ⚠️ added the new locations.create enum value to the users/items/scopes response property for the response status 200
  • ⚠️ added the new locations.delete enum value to the users/items/scopes response property for the response status 200
  • ⚠️ added the new locations.details.manage enum value to the users/items/scopes response property for the response status 200
  • ⚠️ added the new locations.export.list enum value to the users/items/scopes response property for the response status 200
  • ⚠️ added the new locations.features-limits.manage enum value to the users/items/scopes response property for the response status 200
  • ⚠️ added the new locations.pause-resume enum value to the users/items/scopes response property for the response status 200
  • ⚠️ added the new payments/settings.write enum value to the users/items/scopes response property for the response status 200

GET /users/{userId}

  • ⚠️ added the new audit-logs.export enum value to the scopes response property for the response status 200
  • ⚠️ added the new audit-logs.readonly enum value to the scopes response property for the response status 200
  • ⚠️ added the new locations.agency-subaccounts.manage enum value to the scopes response property for the response status 200
  • ⚠️ added the new locations.billing.manage enum value to the scopes response property for the response status 200
  • ⚠️ added the new locations.create enum value to the scopes response property for the response status 200
  • ⚠️ added the new locations.delete enum value to the scopes response property for the response status 200
  • ⚠️ added the new locations.details.manage enum value to the scopes response property for the response status 200
  • ⚠️ added the new locations.export.list enum value to the scopes response property for the response status 200
  • ⚠️ added the new locations.features-limits.manage enum value to the scopes response property for the response status 200
  • ⚠️ added the new locations.pause-resume enum value to the scopes response property for the response status 200
  • ⚠️ added the new payments/settings.write enum value to the scopes response property for the response status 200

PUT /users/{userId}

  • ⚠️ added the new audit-logs.export enum value to the scopes response property for the response status 200
  • ⚠️ added the new audit-logs.readonly enum value to the scopes response property for the response status 200
  • ⚠️ added the new locations.agency-subaccounts.manage enum value to the scopes response property for the response status 200
  • ⚠️ added the new locations.billing.manage enum value to the scopes response property for the response status 200
  • ⚠️ added the new locations.create enum value to the scopes response property for the response status 200
  • ⚠️ added the new locations.delete enum value to the scopes response property for the response status 200
  • ⚠️ added the new locations.details.manage enum value to the scopes response property for the response status 200
  • ⚠️ added the new locations.export.list enum value to the scopes response property for the response status 200
  • ⚠️ added the new locations.features-limits.manage enum value to the scopes response property for the response status 200
  • ⚠️ added the new locations.pause-resume enum value to the scopes response property for the response status 200
  • ⚠️ added the new payments/settings.write enum value to the scopes response property for the response status 200
  • added the new optional request property twilioPhone
  • added the new audit-logs.export enum value to the request property scopes/items/
  • added the new audit-logs.export enum value to the request property scopesAssignedToOnly/items/
  • added the new audit-logs.readonly enum value to the request property scopes/items/
  • added the new audit-logs.readonly enum value to the request property scopesAssignedToOnly/items/
  • added the new locations.agency-subaccounts.manage enum value to the request property scopes/items/
  • added the new locations.agency-subaccounts.manage enum value to the request property scopesAssignedToOnly/items/
  • added the new locations.billing.manage enum value to the request property scopes/items/
  • added the new locations.billing.manage enum value to the request property scopesAssignedToOnly/items/
  • added the new locations.create enum value to the request property scopes/items/
  • added the new locations.create enum value to the request property scopesAssignedToOnly/items/
  • added the new locations.delete enum value to the request property scopes/items/
  • added the new locations.delete enum value to the request property scopesAssignedToOnly/items/
  • added the new locations.details.manage enum value to the request property scopes/items/
  • added the new locations.details.manage enum value to the request property scopesAssignedToOnly/items/
  • added the new locations.export.list enum value to the request property scopes/items/
  • added the new locations.export.list enum value to the request property scopesAssignedToOnly/items/
  • added the new locations.features-limits.manage enum value to the request property scopes/items/
  • added the new locations.features-limits.manage enum value to the request property scopesAssignedToOnly/items/
  • added the new locations.pause-resume enum value to the request property scopes/items/
  • added the new locations.pause-resume enum value to the request property scopesAssignedToOnly/items/
  • added the new payments/settings.write enum value to the request property scopes/items/
  • added the new payments/settings.write enum value to the request property scopesAssignedToOnly/items/

2026-04-14

Marketplace

GET /marketplace/app/{appId}/installations

  • added the optional property installationDetails/allOf[#/components/schemas/InstallerDetailsDTO]/companyPlan to the response with the 200 status
  • response property installationDetails/allOf[#/components/schemas/InstallerDetailsDTO]/companyHighLevelPlan deprecated