Breaking (!) API changes for v2 API, June 27 to July 4

In the week of June 27 to July 4, 2025, the mittwald API introduced several enhancements, including new endpoints for managing LeadFyndr profiles and leads, updates to response properties for customer memberships, and changes to the avatar reference format across multiple project membership endpoints.

Breaking changes

This document contains changes that can under certain circumstances be considered breaking. Please review the changes carefully.

While we generally strive to avoid breaking changes in accordance with our API stability guarantees, we occasionally might perform changes that would be considered breaking in the strictest sense of the term, but we do not consider as breaking in a practical sense. We will always provide ample notice and documentation for such changes.

Summary

• The property type/format of the '/items/avatarRef' response has changed from 'string' to 'string'/'uuid' for status '200' in the following operations:

  • GET /v2/project-memberships (List ProjectMemberships belonging to the executing user)
  • GET /v2/project-memberships/{projectMembershipId} (Get a ProjectMembership)
  • GET /v2/projects/{projectId}/memberships (List Memberships belonging to a Project)
  • GET /v2/projects/{projectId}/memberships/self (Get the executing user's membership in a Project)
  • Note: This change is a breaking change.

• The following endpoints have been added:

  • GET /v2/cities (Get cities in DACH)
  • GET /v2/customers/{customerId}/lead-fyndr-profile (Get your LeadFyndr profile)
  • GET /v2/customers/{customerId}/lead-fyndr-profile-request (Get your LeadFyndr request)
  • POST /v2/customers/{customerId}/lead-fyndr-profile-request (Create a new access request for LeadFyndr)
  • GET /v2/customers/{customerId}/lead-fyndr-profile/tariff (Get lead tariff options)
  • GET /v2/customers/{customerId}/leads (Get all leads)
  • GET /v2/customers/{customerId}/leads/{leadId} (Get a simple lead)
  • GET /v2/customers/{customerId}/memberships (List Memberships belonging to a Customer)
  • GET /v2/customers/{customerId}/unlocked-leads (Get all unlocked leads)
  • GET /v2/customers/{customerId}/unlocked-leads/{leadId} (Get a detail of an unlocked lead)
  • POST /v2/customers/{customerId}/unlocked-leads/{leadId} (Unlock a lead)
  • DELETE /v2/customers/{customerId}/unlocked-leads/{leadId}/reservation (Remove a reservation on an unlocked lead)
  • POST /v2/customers/{customerId}/unlocked-leads/{leadId}/reservation (Reserve an unlocked lead)

• The following properties have been added to the response with status '200' for the operation GET /v2/customer-memberships (List CustomerMemberships belonging to the executing user):

  • An optional property '/items/avatarRef'
  • Required properties '/items/firstName' and '/items/lastName'

• The following properties have been added to the response with status '200' for the operation GET /v2/customer-memberships/{customerMembershipId} (Get a CustomerMembership):

  • An optional property 'avatarRef'
  • Required properties 'firstName' and 'lastName'

• The following properties have been added to the response with status '200' for the operation GET /v2/customers/{customerId}/memberships (List Memberships belonging to a Customer):

  • An optional property '/items/avatarRef'
  • Required properties '/items/firstName' and '/items/lastName'

• Non-success responses with status '412' have been added for the following operations:

  • PUT /v2/dns-zones/{dnsZoneId}/record-sets/{recordSet} (Update a record set on a DNSZone)
  • POST /v2/dns-zones/{dnsZoneId}/record-sets/{recordSet}/actions/set-managed (Set a record set on a DNSZone to managed)

Disclaimer: This summary is AI-generated. If you find any discrepancies, please refer to the detailed changes below.

Detailed changes

Changes in "List ProjectMemberships belonging to the executing user"

• ⚠️ Breaking: the '/items/avatarRef' response's property type/format changed from 'string'/'' to 'string'/'uuid' for status '200'

For details, refer to the GET/v2/project-memberships/ endpoint.

Changes in "Get a ProjectMembership"

• ⚠️ Breaking: the 'avatarRef' response's property type/format changed from 'string'/'' to 'string'/'uuid' for status '200'

For details, refer to the GET/v2/project-memberships/{projectMembershipId}/ endpoint.

Changes in "List Memberships belonging to a Project"

• ⚠️ Breaking: the '/items/avatarRef' response's property type/format changed from 'string'/'' to 'string'/'uuid' for status '200'

For details, refer to the GET/v2/projects/{projectId}/memberships/ endpoint.

Changes in "Get the executing user's membership in a Project"

• ⚠️ Breaking: the 'avatarRef' response's property type/format changed from 'string'/'' to 'string'/'uuid' for status '200'

For details, refer to the GET/v2/projects/{projectId}/memberships/self/ endpoint.

Changes in "Get cities in DACH"

• endpoint added

For details, refer to the GET/v2/cities/ endpoint.

Changes in "List customer memberships belonging to the executing user"

• added the optional property '/items/avatarRef' to the response with the '200' status

• added the required property '/items/firstName' to the response with the '200' status

• added the required property '/items/lastName' to the response with the '200' status

For details, refer to the GET/v2/customer-memberships/ endpoint.

Changes in "Get a customer membership"

• added the optional property 'avatarRef' to the response with the '200' status

• added the required property 'firstName' to the response with the '200' status

• added the required property 'lastName' to the response with the '200' status

For details, refer to the GET/v2/customer-memberships/{customerMembershipId}/ endpoint.

Changes in "Get your LeadFyndr profile"

• endpoint added

For details, refer to the GET/v2/customers/{customerId}/lead-fyndr-profile/ endpoint.

Changes in "Get your LeadFyndr request"

• endpoint added

For details, refer to the GET/v2/customers/{customerId}/lead-fyndr-profile-request/ endpoint.

Changes in "Create a new access request for LeadFyndr"

• endpoint added

For details, refer to the POST/v2/customers/{customerId}/lead-fyndr-profile-request/ endpoint.

Changes in "Get lead tariff options. How many leads did you unlock this month?"

• endpoint added

For details, refer to the GET/v2/customers/{customerId}/lead-fyndr-profile/tariff/ endpoint.

Changes in "Get all leads. Use the unlocked routes for more lead details"

• endpoint added

For details, refer to the GET/v2/customers/{customerId}/leads/ endpoint.

Changes in "Get a simple lead. Use the unlocked route for more detail leads"

• endpoint added

For details, refer to the GET/v2/customers/{customerId}/leads/{leadId}/ endpoint.

Changes in "List Memberships belonging to a Customer"

• added the optional property '/items/avatarRef' to the response with the '200' status

• added the required property '/items/firstName' to the response with the '200' status

• added the required property '/items/lastName' to the response with the '200' status

For details, refer to the GET/v2/customers/{customerId}/memberships/ endpoint.

Changes in "Get all unlocked leads. Organisation can unlock leads"

• endpoint added

For details, refer to the GET/v2/customers/{customerId}/unlocked-leads/ endpoint.

Changes in "Get a detail of a unlocked lead. Organisation can unlock leads"

• endpoint added

For details, refer to the GET/v2/customers/{customerId}/unlocked-leads/{leadId}/ endpoint.

Changes in "Unlock a lead for the given customerId"

• endpoint added

For details, refer to the POST/v2/customers/{customerId}/unlocked-leads/{leadId}/ endpoint.

Changes in "Removes a reservation on a unlocked lead for the given customerId"

• endpoint added

For details, refer to the DELETE/v2/customers/{customerId}/unlocked-leads/{leadId}/reservation/ endpoint.

Changes in "Reserve a unlocked lead for the given customerId"

• endpoint added

For details, refer to the POST/v2/customers/{customerId}/unlocked-leads/{leadId}/reservation/ endpoint.

Changes in "Update a record set on a DNS Zone"

• added the non-success response with the status '412'

For details, refer to the PUT/v2/dns-zones/{dnsZoneId}/record-sets/{recordSet}/ endpoint.

Changes in "Set a record set on a DNS Zone to managed"

• added the non-success response with the status '412'

For details, refer to the POST/v2/dns-zones/{dnsZoneId}/record-sets/{recordSet}/actions/set-managed/ endpoint.

Client package releases

mittwald JavaScript SDK Release 4.177.0

The mittwald JavaScript SDK has been updated to version 4.177.0. This release includes an update to the generated client, enhancing the SDK's functionality. For more details, you can view the release on GitHub.

mittwald JavaScript SDK Release 4.176.0

The mittwald JavaScript SDK has been updated to version 4.176.0. This release includes updates to the generated client, enhancing the SDK's functionality and performance. For more details, you can view the release on GitHub: mittwald JavaScript SDK 4.176.0.

mittwald JavaScript SDK Release 4.175.0

The mittwald JavaScript SDK has been updated to version 4.175.0. This release includes an update to the generated client, enhancing the SDK's functionality. For more details, you can view the release on GitHub here.

mittwald JavaScript SDK Release 4.174.0

The mittwald JavaScript SDK version 4.174.0 has been released. This update includes important bug fixes and new features:

• Bug Fixes: Resolved issues with scheduled DEV client updates.
• Features: Updated the generated client to enhance functionality.

For more details, visit the release page.

mittwald JavaScript SDK Release 4.173.0

The mittwald JavaScript SDK has been updated to version 4.173.0. This release includes an update to the generated client, enhancing the SDK's functionality. For more details, you can view the release on GitHub.

mittwald JavaScript SDK Release 4.172.0

The mittwald JavaScript SDK has been updated to version 4.172.0. This release includes an update to the generated client, enhancing the SDK's functionality. For more details, you can view the release on GitHub.

mittwald JavaScript SDK Release 4.171.0

The mittwald JavaScript SDK has been updated to version 4.171.0. This release includes new features such as scheduled DEV client updates and updates to the generated client. For more details, you can view the release on GitHub here.