Staffbase Developer Portal RSS Feed

Changelog - February 09, 2023

Thu, 09 Feb 2023 00:00:00 GMT

In News, when the User API was used to search for posts, acknowledgments were not displayed. This has been fixed.

Changelog - April 13, 2023

Thu, 13 Apr 2023 00:00:00 GMT

In User API, the creation date of the user account got incorrectly overwritten with the activation date. This has been fixed.

Changelog - June 16, 2023

Fri, 16 Jun 2023 00:00:00 GMT

In User API, the source response field of a user has been removed. Instead, you can now use the creation response field.

Changelog - July 14, 2023

Fri, 14 Jul 2023 00:00:00 GMT

Users and tokens assigned as editors on a specific plugin could set properties via API on these plugins, which exceeded their permission level. This has been fixed. Now, users and tokens with editorial access for specific plugins can only set the plugin properties available to them in the Studio user interface.

Changelog - May 11, 2023

Thu, 11 May 2023 00:00:00 GMT

Introducing Contact API that allows you to sync your recipients’ email addresses and other attributes from any third-party human resources system directly into Employee Email for creating custom distribution lists.

Changelog - August 10, 2023

Thu, 10 Aug 2023 00:00:00 GMT

Introducing Tags API for more scalable and user-friendly format for returning tags used in user profiles. The Tags API will replace the user/tags endpoint under the User API. The user/tags endpoint will soon be removed. If you are still using user/tags endpoint, Staffbase recommends migrating to the Tags API.
Introducing a new addition to the Analytics API: the User timeseries endpoint. This endpoint returns information on total, registered, active, and engaged users for a specific time frame. It comes with significant improvements, offering enhanced functionality and improved performance to ensure your integrations are future-proof.
As part of this update, the existing User timeseries with SCIM endpoint will be deprecated. Staffbase will continue to support this endpoint until the beginning of 2024, after which it will no longer be supported. Staffbase recommends migrating to the User timeseries endpoint.

Changelog - August 31, 2023

Thu, 31 Aug 2023 00:00:00 GMT

In User API, the verificationCode, pending and enabled response fields of a user account will be removed until 31/08/2024. Instead, you can now use:
secret for the verificationCode response field
status for the pending and enabled response fields
It also replaced the enabled property with the status property to enable or disable a user with a request.

Changelog - October 25, 2023

Wed, 25 Oct 2023 00:00:00 GMT

When updating pending user details with the User API, the profile fields were not populated. This has been fixed quickly.

Changelog - December 01, 2023

Fri, 01 Dec 2023 00:00:00 GMT

The Profile API is no longer available as a public Staffbase API. You can use User API for the same purposes. Contact Staffbase Support or your Customer Success Manager for more information.

Changelog - December 31, 2023

Sun, 31 Dec 2023 00:00:00 GMT

The Leave Webservice and Shift Webservice are no longer available as public Staffbase APIs.

Changelog - March 05, 2024

Tue, 05 Mar 2024 00:00:00 GMT

The content types multipart/form-data and application/x-www-form-urlencoded have been removed from the Chat API.

Changelog - March 06, 2024

Wed, 06 Mar 2024 00:00:00 GMT

If you use SAML SSO, you now have the option to configure the SAML domain hints. These hints ensure that users don't attempt to authenticate with the identity provider (IdP) using domains that are not allowed when using the Staffbase platform. To activate this feature, contact Staffbase Support or your Customer Success Manager. It's worth noting that this feature currently works with Microsoft Entra ID as the IdP, although it may also work with other IdPs.

Changelog - April 09, 2024

Tue, 09 Apr 2024 00:00:00 GMT

In Campaigns API, the sort parameter has been improved. Now, you have the following enum values for the sort parameter:
updated_DESC - Sort the reference list in descending order based on the last updated date
created_DESC - Sort the references attached to a campaign based on the date they were created in descending order, from newest to oldest.
updated_ASC - Sort the references attached to a campaign based on the date they were last updated in ascending order, from oldest to newest.
scheduledFor_ASC - Sort the reference list in ascending order based on the publishing order.
scheduledFor_DESC - Sort the reference list in descending order based on the publishing order.
In addition, the default value has been changed from updated_DESC to created_DESC.

Changelog - May 16, 2024

Thu, 16 May 2024 00:00:00 GMT

Introducing the (New) CSV Import API that offers advanced functionalities and an improved user experience. To get started, see the Get Started With New CSV Import guide. Use this beta feature instead of the (Legacy) CSV Import API, which is planned to be deprecated in the future. Staffbase strongly recommends migrating to the new CSV Import API as soon as possible. Learn more.
Introducing the Quick Links API that allows you to add custom header links to enable quick access to content for your users. Learn more.

Changelog - July 17, 2024

Wed, 17 Jul 2024 00:00:00 GMT

It is now possible to use the vertical bar | as a CSV separator in the (New) CSV Import API.

Changelog - July 30, 2024

Tue, 30 Jul 2024 00:00:00 GMT

In the Campaigns API, there are now two new endpoints available for adding and removing content pieces as references. They are:
Create a campaign reference
Delete a campaign reference

Changelog - August 31, 2024

Sat, 31 Aug 2024 00:00:00 GMT

In the User API, the enabled, pending, and verificationCode response fields of a user have been removed, as announced last year. To access the same information, use the following properties instead:
- status
- secret

Changelog - September 17, 2024

Tue, 17 Sep 2024 00:00:00 GMT

In the Notifications API, a new error code has been added to the response of the Send notifications endpoint. The error code 429 is returned when too many requests are sent in parallel and exceeds the rate limits. When this error occurs, wait a short period before retrying the request. To avoid this error, we recommend staggering API calls instead of sending them all at once.
In the Campaigns API, the Create campaign references endpoint now returns the plannedAt parameter. This parameter shows at what time and date the post is planned to be published and it is returned with the response body. The plannedAt parameter provides a date and time in ISO 8601 format. For example, 2024-09-17T12:00:00Z.

Changelog - October 01, 2024

Tue, 01 Oct 2024 00:00:00 GMT

In the Analytics API, the maximum limit for Content and Post ranking has been adjusted to 50000.

Changelog - February 19, 2024

Mon, 19 Feb 2024 00:00:00 GMT

The user/tags endpoint under the User API has been removed. You can use Tags API instead.

Changelog - October 17, 2024

Thu, 17 Oct 2024 00:00:00 GMT

Pages API: The Pages API simplifies creating new pages with content from external sources, making it ideal for organizations migrating to the Staffbase platform or consolidating scattered information. It helps preserve valuable content and ensures a seamless transition during migration. Additionally, you can manage your pages using the Pages API.
Learn more about the Pages API use cases:
- Extract Page Content Using the Pages API
- Import External Content to Pages
File Management API: Introducing File Management API that offers a range of methods to streamline file management tasks on your platform, such as adding files to your File Manager and creating, updating, or deleting collections. Whether you need to import assets from an external source, set up files for a new editor, or manage collections centrally as an administrator, the File Management API makes it simple and efficient. Learn more on getting started with the File Mangement API.
Spaces API: The Spaces API simplifies creating and managing Spaces in your platform. It brings enhanced flexibility and automation, allowing you to integrate Spaces management into your workflows.

Changelog - December 10, 2024

Tue, 10 Dec 2024 00:00:00 GMT

Starting December 10, 2024, Staffbase will discontinue support for the following generic URLs as reply URLs:
- de.eyo.net (DE)
- backend.staffbase.com (US)

If you use any of these domains as reply URLs, you must update your Identity Provider (IdP) settings with your Staffbase platform domain to the list of allowed reply URLs. This is essential to avoid disruptions to your API integrations and SAML-SSO authentication flow. If you are impacted, your Customer Success Manager or Support team will reach out to you to assist you further.

Changelog - January 29, 2025

Wed, 29 Jan 2025 00:00:00 GMT

The Quicklinks API now includes a new parameter visibleInPublicArea, which allows Quicklinks to be available in the public area.

This update does not change the default behavior of existing Quicklinks. When creating a new Quicklink, it remains unavailable in the public area by default.

Changelog - February 04, 2025

Tue, 04 Feb 2025 00:00:00 GMT

In the (New) CSV Import API, the errors response field of an import has been removed. Instead, we are developing a more scalable and user-friendly error reporting functionality with the endpoint /users/imports/{import_Id}/errors.

Changelog - February 26, 2025

Wed, 26 Feb 2025 00:00:00 GMT

Introducing the Email Performance API that retrieves detailed tracking data for emails sent through Staffbase Email. This API provides key performance metrics, including the number of emails sent, opened, and clicked, helping you measure engagement and optimize your communication strategy. Discover more about its capabilities.
The Spaces API now includes a new endpoint to retrieve a list of spaces using query, filter, and sorting options. Additionally, the newly introduced section array enables you to identify and assign spaces across one or more products available on your platform, such as Employee App, Front Door Intranet, or Staffbase Email.
In the (New) CSV Import API, the Update CSV import configuration endpoint now includes an additional optional field, type. This parameter defines whether it is a user import or a contact import for Staffbase Email.

Changelog - February 05, 2025

Wed, 05 Feb 2025 00:00:00 GMT

The News API now includes a new endpoint dedicated for retrieving acknowledgments on a news post.

Changelog - March 27, 2025

Thu, 27 Mar 2025 00:00:00 GMT

When a user’s avatar image was set to null via an API call, the user was unable to access the Studio. This has been fixed.

Changelog - April 15, 2025

Tue, 15 Apr 2025 00:00:00 GMT

The News API now includes a new search endpoint that allows you to search for news posts using a query string. It retrieves a list of news posts that match the search query in the content, hashtags, image descriptions, teasers, or titles of the posts. This is particularly useful for third-party federated search solutions, enabling you to fetch news post details without indexing or storing the data in external systems.
The new Profile API comes with a search endpoint that allows you to search user profiles using any query text you provide. It searches across all searchable fields within user profiles. This is especially useful for third-party federated search solutions, enabling you to fetch user profile details without indexing or storing the data in external systems.

Changelog - April 02, 2025

Wed, 02 Apr 2025 00:00:00 GMT

In the News API, the campaignId parameter has been deprecated in the following endpoints:
- POST Create a news post
- PUT Update a news post
To assign a post to a campaign, use the campaignId parameter in the create campaign reference endpoint of the Campaigns API. The campaignId parameter will be removed from the News API endpoints on November 1, 2025. This change ensures that campaign-related actions are handled consistently through the Campaigns API.

Changelog - April 22, 2025

Tue, 22 Apr 2025 00:00:00 GMT

The new Search Settings API lets you fine-tune the redesigned search results page to fit your organization's needs. Show or hide sections and the flyout, rename or reorder sections, set up a custom redirect URL after search input validation, and define which sites or knowledge bases should be searchable in Microsoft or ServiceNow.
The new Installation API introduces a search endpoint that allows you to search plugins installed on your platform based on the query you provide. This is particularly useful to fetch plugin details into your federated search solutions. The endpoint returns plugin information with accurate relevance and proper permission handling, directly from the Staffbase platform, based on your users’ search input.

Changelog - April 23, 2025

Wed, 23 Apr 2025 00:00:00 GMT

The Media API now includes a new search endpoint that allows you to search for media items based on the query you provide. This is particularly useful for integrating media results into federated search solutions. The endpoint returns media information that matches the filename, content, or type directly from the Staffbase platform, based on your users’ search input.

Changelog - May 02, 2025

Fri, 02 May 2025 00:00:00 GMT

The Campaigns API now supports emails assigned to campaigns. It has been updated to reflect recent changes in platform capabilities. The sourceType parameter, which specifies the type of content assigned to a campaign, no longer supports the EXTERNAL_CONTENT value. Instead, a new content source type, EMAIL, has been added to support Staffbase Email.

Changelog - May 05, 2025

Mon, 05 May 2025 00:00:00 GMT

In the Search Settings API, To align with best practices followed across other Staffbase APIs, the following changes have been made:
- The update internal sections endpoint has been added.
- The update integration sections endpoint now uses the PUT method instead of PATCH.
- The update search settings endpoint has been removed as its behavior can be achieved via the other three update endpoints.

Changelog - May 22, 2025

Thu, 22 May 2025 00:00:00 GMT

The File Management API is now offically out of beta. It offers a range of methods to streamline file management tasks on your platform, such as adding files to your File Manager and creating, updating, or deleting collections. Whether you need to import assets from an external source, set up files for a new editor, or manage collections centrally as an administrator, the File Management API makes it simple and efficient. Learn more on getting started with the File Mangement API.

Changelog - June 13, 2025

Fri, 13 Jun 2025 00:00:00 GMT

The Media API now includes a new endpoint dedicated for replacing media files. This endpoint allows you to replace existing media files with new ones while maintaining the original URL, ensuring that any references to the original file remain valid. This is particularly useful for updating media content without needing to change links or references in your content.

Changelog - June 16, 2025

Mon, 16 Jun 2025 00:00:00 GMT

The Spaces API now includes a new parameter for the Search spaces endpoint. You can now use the relevance_desc parameter to sort search results by relevance in descending order, making it easier to find the most relevant spaces first.

Changelog - June 23, 2025

Mon, 23 Jun 2025 00:00:00 GMT

The Users Sync API is now available for use. Utilize this API to synchronize users from the Staffbase platform, ensuring that your user data is always up-to-date and consistent across your applications.

Changelog - June 27, 2025

Fri, 27 Jun 2025 00:00:00 GMT

The Notifications API now offers two new endpoints:
- Send a notification: Notify specific users or user groups using the notification center, push notifications, or both.
- Send a plugin notification: Notify specific users or user groups about a particular plugin instance using the notification center, push notifications, or both. This is particularly useful for plugin developers targeting a plugin instance's audience. Both endpoints allow you to customize the notification’s text, icon, and image for more personalized, context-aware messages.
In the Notifications API, the two new enhanced endpoints replace the existing Send notifications endpoint, which is now deprecated and scheduled for removal by end of 2025. Staffbase strongly recommends switching to the new endpoints to ensure continued support and access to enhanced functionality.

Changelog - August 07, 2025

Thu, 07 Aug 2025 00:00:00 GMT

The Update Internal Section endpoint in the Search Settings API now includes the following changes:
- The request body schema has been updated to accurately reflect the required structure.
- The iconURL property is now read-only and can no longer be updated.

Changelog - August 08, 2025

Fri, 08 Aug 2025 00:00:00 GMT

The CSV Import API is now offically out of beta. It has introduced partialTag property to support partial CSV imports. This is especially useful if you want to:
- Create conditional groups based on partial CSV tags
- Migrate to the CSV Import API if you previously used partial CSV imports with the legacy method
Starting October 31, 2025, the (Legacy) CSV Import API will no longer be offered. If you use it for user management, Staffbase strongly recommends switching to the CSV Import API before this date.

Changelog - August 25, 2025

Mon, 25 Aug 2025 00:00:00 GMT

The Media API now includes a new endpoint to retrieve publicly accessible media URLs. This makes it easier to share media content for display without requiring authentication. Learn more.
Starting March 1, 2026, Staffbase APIs will no longer return publicly accessible media URLs when fetched with an API token. This means that the media URLs fetched would require authentication. Instead, publicly accessible media URLs can only be retrieved via the Make media URLs public endpoint. If you use APIs to fetch media files, ensure that you update your implementation accordingly before this date. Learn more.

Changelog - September 24, 2025

Wed, 24 Sep 2025 00:00:00 GMT

The User API introduces the following updates:
- New versions of existing endpoints: Several endpoints of the User API now have new versions with improved performance and usability. Staffbase recommends migrating to these versions to benefit from the enhancements. Updated endpoints include:
  - List users
  - Invite users
  - Return a user
  - Delete a user
- New endpoints: To replace certain legacy behaviors and improve efficiency, the following new endpoints have been added:
  - Update a user
  - Search users
Deprecated: Return metadata endpoint has been deprecated due to low usage. It is planned to be removed on January 1, 2026. Learn more about Staffbase API lifecycle and deprecation policy.

Use the migration guide to test and plan your migration. Learn more about Staffbase versioning policy before you plan your migration.

Changelog - September 04, 2025

Thu, 04 Sep 2025 00:00:00 GMT

The Search Settings API now includes a new parameter redirectUrlMobile in addition to the existing redirectUrl parameter. This allows you to specify a different redirect URL for mobile devices, enhancing the user experience by directing mobile users to a mobile-optimized search engine. If not specified, it defaults to the value of redirectUrl.

Changelog - October 08, 2025

Wed, 08 Oct 2025 00:00:00 GMT

The Chat API now includes a new endpoint to delete group chat conversations. Learn more.

Changelog - October 14, 2025

Tue, 14 Oct 2025 00:00:00 GMT

When using the latest version of SCIM, the following issues were reported and have now been fixed:
- In rare cases, profile fields were not updated correctly.
- User reactivation did not work as expected.

Changelog - October 28, 2025

Tue, 28 Oct 2025 00:00:00 GMT

Access to the Tags API is now limited to administrators and group administrators to improve platform security.

Changelog - October 30, 2025

Thu, 30 Oct 2025 00:00:00 GMT

Introducing the Groups API that simplifies creating and managing groups in your platform. It brings enhanced flexibility and automation, allowing you to integrate groups management into your workflows.

Changelog - November 03, 2025

Mon, 03 Nov 2025 00:00:00 GMT

The CSV Import API now includes a new endpoint to get the changelog of an import. This allows users to track changes made during CSV imports more effectively.

Changelog - November 07, 2025

Fri, 07 Nov 2025 00:00:00 GMT

The Email Performance API now includes two new endpoints, list emails and get email metadata, to help users retrieve email performance data more efficiently.

Changelog - November 17, 2025

Mon, 17 Nov 2025 00:00:00 GMT

In the CSV Import API and the latest User API endpoints, the response Not Found (404) is now returned for single-entity actions when the user does not have permission to perform the action on any of the entities in the request. Previously, a Forbidden (403) response was returned in this case. This change improves security by preventing information leakage about the existence of entities.

Changelog - December 15, 2025

Mon, 15 Dec 2025 00:00:00 GMT

The Groups API now supports managing group members using externalId in addition to userId. When using the PATCH method to update members, you have more flexibility in how you add or remove users.

Changelog - January 07, 2026

Wed, 07 Jan 2026 00:00:00 GMT

In the CSV Import API, the import status response now includes a reactivated field in the changes summary alongside existing metrics (created, updated, deactivated, deleted). Previously, reactivated users were not tracked as a separate metric.

Changelog - January 21, 2026

Wed, 21 Jan 2026 00:00:00 GMT

The Groups API now supports filtering group members by their status using the status query parameter.

Changelog - January 30, 2026

Fri, 30 Jan 2026 00:00:00 GMT

In the User API a new field activatedAt has been added to the user object, indicating the date and time when a user account was activated on the platform.

Changelog - February 02, 2026

Mon, 02 Feb 2026 00:00:00 GMT

When retrieving a user via the Users API, the response now includes both the value and source for the userName object, matching the existing structure for email object. Previously, the userName response included only the value. With this change, email and userName behave the same way, making it easier to understand the source as well.

Changelog - February 03, 2026

Tue, 03 Feb 2026 00:00:00 GMT

In the Pages API the response schema now includes a new field isOutdated. This boolean field indicates whether the page content is outdated based on its update reminder settings. This addition helps you easily identify pages that may require updates or reviews.

Changelog - February 24, 2026

Tue, 24 Feb 2026 00:00:00 GMT

In the User API, the latest version endpoints are now officially out of beta and is available for production use. The previous version endpoints remain fully supported and continue to work as before. However, Staffbase recommends migrating to the latest version for improved performance and additional features. For more information on the changes and how to migrate, refer to the User API migration guide.
The User API return metadata endpoint has been removed. This endpoint was deprecated in September 2025.
The Groups API, which was in beta since October 2025, is now officially out of beta and is available in production. Use it to create and manage groups on the Staffbase platform more efficiently.

Changelog - February 26, 2026

Thu, 26 Feb 2026 00:00:00 GMT

You can now define allowed IP ranges when creating an API token. This lets you restrict token usage to specific source IP addresses or ranges using CIDR notation. If a request is made with the token from an IP address outside the configured ranges, the request is rejected. Use this option to limit token exposure, enforce network-level access control, and reduce the risk of unauthorized use in case a token is compromised.

Changelog - March 01, 2026

Sun, 01 Mar 2026 00:00:00 GMT

Staffbase APIs no longer return publicly accessible media URLs when fetched with an API token. This means that the media URLs returned by these requests would require authentication. To obtain publicly accessible media URLs, use the Make media URLs public endpoint.

Changelog - April 02, 2026

Thu, 02 Apr 2026 00:00:00 GMT

The Groups API now includes a new relevance_DESC sort parameter to retrieve groups based on their relevance to the search query, with the most relevant groups appearing first in the results.