Overview of Staffbase API Lifecycle

Learn about the different stages an API goes through at Staffbase.

Employee App
Staffbase Intranet
Staffbase Email

Staffbase continuously enhances its APIs to keep pace with platform growth, expanding feature sets, and evolving security requirements. Each API or endpoint progresses through defined lifecycle stages, managed by the respective development team. The speed of progression varies depending on the scope and complexity.

Not all stages apply to every endpoint or API. The development team determines the stage of an endpoint or API based on its stability and readiness.

New endpoints or APIs first undergo internal testing, followed by a closed beta, where a small group of customers tests them for a limited period. After this initial phase, an endpoint or API is released with one of the following statuses:

  • Beta
  • Production
  • Deprecated
  • Removed

You are always notified of API changes and updates via the Developer Portal changelog.

Every API is tied to a feature. To use an API, ensure the related feature is activated for your platform. Contact Staffbase Support or your Customer Success Manager for details.

Endpoints and APIs released as beta are still under development, but safe enough for you to test and use. The main purpose of the beta is to identify any bugs or usability issues and ensure the API meets quality standards before moving into production. You are also highly encouraged to share feedback, which can play a key role in shaping the final version. Beta endpoints and APIs are marked with a beta label.

Beta endpoints and APIs are under development and may not function as expected. They:

  • Are subject to change based on user feedback and testing results
  • Changes may not include versioning and can occur without notice
  • May have limited functionality or incomplete features
  • May be removed by Staffbase at any time
  • May never be released into production

Any updates will be communicated through the Developer Portal Changelog. Staffbase aims to keep disruptive changes to a minimum.

APIs in production are fully developed and actively supported. They are stable to integrate into applications and are maintained with ongoing improvements. Most of the improvements are backward compatible, meaning your existing integrations continue to work without any changes. However, in some cases, breaking changes are required. In those cases, new versions are introduced. Learn more about API versioning at Staffbase.

When a production endpoint or API is planned to be deprecated in the future, it is marked as Legacy in the documentation.

When an endpoint or API is deprecated, it means it is no longer recommended for use and will be removed in the future. Deprecated endpoints and APIs are still functional, but they are no longer actively maintained or supported. You should avoid using deprecated endpoints and APIs in new applications and plan to migrate existing integrations to supported alternatives. Deprecated endpoints and APIs are marked with a deprecation label in the documentation.

Deprecated APIs are still available for use, but are no longer under active development or maintenance. They are scheduled for eventual removal. Common reasons for deprecation include:

  • A new version of an endpoint has replaced the existing one.
  • The associated feature has been deprecated.

When an API is deprecated, Staffbase:

Removed endpoints or APIs are no longer available, and any requests made to them will fail. The removal is communicated well in advance through the Developer Portal changelog, and alternatives are provided, where applicable. The API specification and supporting documentation are also removed.