Concatenated news items are no longer supported in /timeline/?type=news. This means the API now returns only published news items when the status parameter is not provided
v2025.0.11 April 25, 2025
Added isDynamic property on appMenuItem resource for IdP Saml entries
v2025.0.10 March 13, 2025
Added numImpreciseActiveMembersCount property to the network resource
v2025.0.9 March 11, 2025
Added spectrum object to properties property of the NetworkThemeDto
v2025.0.8 February 25, 2025
Added isAnonymous property for message with type poll
Introduced /polls/{pollEID}/voters/{answerEID}/, which returns the list of users who voted for an answer in a poll.
v2025.0.7 February 11, 2025
Added support of property htmlBody for message with type update or task
v2025.0.6 February 10, 2025
Added new property knowledge_base_article search type to /networks/{networkEID}/search/
endpoint. You need explicitly specify this type in the type query parameter to search for knowledge base articles.
v2025.0.5 January 30, 2025
Trying to change user's password on /networks/{eid}/users/xid/{xid}/ endpoint for non-emailless accounts will be successful with a warning in the response
Introduce properties on NetworkTheme resource
v2025.0.4 January 27, 2025
Added new property knowledgeBaseHomeHeader to network themes
Added new property knowledgeBaseCategoryHeader to network themes
Added new property knowledgeBasePageHeader to network themes
v2025.0.3 January 21, 2025
Added new query parameter actionability to /alerts/markread endpoint
actionable and non-actionable are the valid values
category query parameter in /alerts/markread has to be specified and BE will no longer set to USER by default.
v2025.0.2 January 13, 2025
Added new property numNonActionRequiredAlertsCoalesced to whoami.networks._user
Added new property numActionRequiredAlerts to whoami.networks._user
v2025.0.1 January 6, 2025
Added new endpoint /polls/{eid}/reactivate for reactivating an ended poll
Added alert type poll_reactivated
v2025.0.0 January 2nd, 2025
Added audienceType property to our knowledge base categories
Version 2024
v2024.3.2 December 17, 2024
Added an object property readTime to news response that has unit and value properties for showing the time needed to read a news item
v2024.3.1 December 10, 2024
Added a new query parameter ancestors to accept multiple ancestors when filtering groups
v2024.3.0 November 28, 2024
Pagination is being done by parsing the url query parameters limit and offset instead of blindly trusting PHP global objects
Breaking change: The offset query parameter will not be carried over to sub-resources, be explicit by setting offset[resource]. Default value is zero. This does not apply to'limit, that is still carried over.
Breaking change: Query parameter offset[messages] is no longer supported to paginate task collection, use offset or offset[self] instead
v2024.2.6 November 6, 2024
Added deletedAt property to pages for soft deletion
Added coverImage property to our knowledge base pages
Added Knowledge Base Categories: admins can create, edit view and delete them through new endpoints /networks/:networkEid/knowledge-base/categories/:categoryEid/
v2024.2.5 October 23, 2024
Deprecated deleted property from user resource, use userState instead
v2024.2.4 August 5, 2024
Own user birthday info is always being returned on fetching user profile data. Both on /networks/:networkEID/users/:profileEID/ and /networks/:networkEID/users/?embed=users endpoints
v2024.2.3 July 5, 2024
Removed support for Urban Airship as a notificationProvider on the /my-devices/ and /whitelabel-apps/ endpoints
v2024.2.2 May 2, 2024
Added projectId to the /whitelabel-apps/ endpoint for both creation and retrieval
Added notificationProviderVersion to the /whitelabel-apps/ endpoint for both creation and retrieval
v2024.2.1 April 15, 2024
Added journey question step support
Added a new endpoint /networks/{networkEID}/journeys/{journeyEID}/questions/ to create question
Added a new endpoint /networks/{networkEID}/journeys/{journeyEID}/steps/questions/{stepEID}/submit to submit choices as a participant
Journey admin participant export is now returning quiz result
v2024.2.0 February 21, 2024
Images uploaded with type="file" will no longer generate thumbnails, thus not being restricted to 20MP anymore
v2024.1.2 February 1, 2024
Added a new alert type journey_failed_to_launch to notify the journey launcher about unsuccessful journey launch
v2024.1.1 January 25, 2024
Added a new property reactable to message to separate comments and reactions
Added two new properties allowCommentsPreference and allowReactionsPreference to the network settings to allow comments and reactions preference
Added smsInvitation SmsInvitationDto type property to invitation list
v2023.0.11 October 13, 2023
Added isDuplicate boolean type property to news items
Added originalAuthor object type property to duplicated news items
Added originalAuthor to the embedded query parameter which can be used in /messages or messages/[newsEID]/
endpoints
v2023.0.10 September 25, 2023
Added comments on comments functionality
Added $parentCommentEID property to the MessageDto
Added a new query parameter parentCommentEID to the endpoint /network/{networkEID}/messages/ to fetch threads
v2023.0.9 September 19, 2023
Added a new endpoint /network/{networkEID}/news/{messageEID}/duplicate/ for duplicating a news item
Added AlertTypes::DUPLICATION_PROCESS_SUCEEDED
Added AlertTypes::DUPLICATION_PROCESS_FAILED
v2023.0.8 September 7, 2023
Added a new endpoint /network/{networkEID}/tasks/{taskEID}/recipients/ for listing the recipients of a multiple assignee group tasks
v2023.0.7 July 14, 2023
Added the new field messageType to push notifications
v2023.0.6 June 20, 2023
Created a new endpoint /push-notifications/debug/ to facilitate the diagnostic of issues with Push Notification
Updated "Pagination" page, added Pagination support by message type section
v2023.0.5 May 2, 2023
Network has a property mobileNumber which is the mobile number of the network's sender to be used when sending SMS messages
v2023.0.4 April 18, 2023
Network invitation expose the mobile number of the inviter
User Sync endpoint supports to send SMS when inviting users
v2023.0.3 March 23, 2023
Added AlertTypes::NEWS_ADDRESSEE_EXPORT_SUCCESS
Added AlertTypes::NEWS_ADDRESSEE_EXPORT_FAILURE
v2023.0.2 February 20, 2023
Added multiple recipients for task management
Added $excludedRecipients property to the MessageDto
v2023.0.1 January 04, 2023
Added birthday widget available for mobile as menu item
Version 1.6
v1.6.8 October 10, 2018
Property defaultEmblemThumbnailUrl added to Group resource
v1.6.7 August 21, 2018
API supports custom network domains
v1.6.6 July 18, 2018
Property numVideoViews added to Message resource
v1.6.5 June 5, 2018
Links will not override properties with the same name
v1.6.3 March 15, 2018
Property responsive added to App Manifest resource
Version 1.5
v1.5.9 December 14, 2017
Property numUnrespondedEvents added to Badge counter resource
v1.5.7 October 24, 2017
A network is no longer limited to having a single white label app
HAL whitelabelApps relation added to Network resource
HAL networks relation added to Whitelabel App resource
Read-only property numNetworks added to Whitelabel App resource
Property platform added to Whitelabel App resource
Introduced Platform enum with values android and ios
Property downloadUrl added to Whitelabel App resource
Introduced Network Identity object
v1.5.6 October 12, 2017
Deprecated property appStoreUrl from Whitelabel App Resource
Deprecated property googlePlayUrl from Whitelabel App Resource
Property addedRecipients added to Message resource (in write-context)
Property removedRecipients added to Message resource (in write-context)
Read-only property reason added to Bubble object
Introduced Bubble Reason enum
Bubbled updates now contain a reason that indicates why bubbling took place. Up until this version new_comment was the only reason for an update to bubble.
Editing event can cause it to bubble up. Three separate reasons were added for this: date_time_changed, location_changed and details_changed
v1.5.5 September 28, 2017
Introduced GET collection endpoint on past User Devices subresource
HAL account relation added to User resource (for authorized clients only)
Deprecated property whitelabelApp from Network Resource (write-context)
Property appVersion added to UserDevice resource
Property appDistributorEnabled added to Network resource
New invitees to a private event now receive an alert
Invitees of a private event will now receive an alert when the date/time and/or its location have been changed
Introduction of a custom error code -38: invalid date range
v1.5.2 August 17, 2017
Introduced event editing
Introduced POST and PUT update endpoints on Events resource
Introduced GET collection endpoint on past Events subresource
Property eventHeaderBackgroundUrl added to Network Theme subresource
Introduced event_header_background file type
Bug: news addressees no longer include suspened users
Bug: fixed property whitelisting issue related to null values
v1.5.1 August 3, 2017
Introduced event cancelation and reactivation
Introduction of cancel and reinstate permissions on Message resources
Introduced cancel and reinstate action endpoints on Message resource
Read-only property canceled added to Event object of Message resource
v1.5.0 June 15, 2017 - 20 July, 2017
Introduced event message type
Introduced Event object
Introduced GET collection endpoint on Message (type event) resource
Query filter tz introduced for the Message (type event) resource collection
Introduction of rsvp permission on Message resources
Introduced rsvp action endpoint on Message resource
HAL rsvp relation added to Message (type event) resource
Introduced Invitation Response (i.e. RSVP) enum
Read-only property responderCounts added to Event object of Message resource
Property rsvp added to user metadata of Message (type event) subresource
Property rsvp added to metadata of User resource
Version 1.4
v1.4.8 May 31, 2017
From now no all different Network Administrator roles (e.g. enterprise_admin) will be returned as admin in the Role, and Membership resource and user metadata of the Network resource
Property favicon added to Network resource (in write-context)
HAL favicon relation added to Network resource
Renamed property event in the Message Resource to announcement
Property fallbackUrl added to App Entry Point object.
The fallback URL may contain an alternative location for devices that cannot handle the regular entry point URL
v1.4.7 May 18, 2017
Introduced host-info endpoint
Read-only property speakapDomain added to Network resource
Read-only property baseUrl added to Network resource
HAL hostInfo relation added to Network resource
v1.4.5 April 5, 2017
Introduced GET collection endpoint on Message Addressees subresource
Read-only property numReaders added to Message resource
Authors of news items and users with administrative privileges over any of the recipients are able to view the readers of news
Introduced Email Settings resource
Introduced POST and PUT update endpoints on Email Settings resource
Read-only property emailSettings added to Network resource
Incoming links to Speakap can now include an Identity Provider (idp) parameter. This will cause an immediate redirect to the relevant authentication service
v1.4.4 March 9, 2017
Property urlAppendNetwork added to App Entry Point object
Apps that have the abovementioned property added to external entry points of their manifest will get two query parameters appended to SSO redirect URIs: network_eid and network_auth_url
v1.4.3 February 23, 2017
Introduction of like permission on Message resources
Updates and news items can be locked from now on. Locked messages and their comments cannot be liked nor can they be commented on any longer
Property locked added to Message resource
Uncommentable messages will have their numComments and numLikes properties set to 0
The HAL resource of uncommentable messages will no longer have comments and/or likers relations
Group memberships that are “externally managed” will be protected from deletion by Speakap administrators. Externally managed means that third-party HR-software dictates the creation and removal of these kind of memberships
Read-only property lockedBy added to Membership object of groups
Property lockedBy added to membership metadata of User Groups subresource
v1.4.2 February 14, 2017
Bug: fixed sending app alerts to multiple user recipients
v1.4.1 January 12, 2017
All group managements permissions are now transitive: network administrators can manage all groups, group administrators can manage all subgroups
Query filter permission introduced for the Group resource collection
Whitelisted dimensions for on demand thumbnails: 390x170, 300x170 and Wx270
v1.4 December 1, 2016
Introduced various video thumbnail formats
Added HLS, DASH and video to file display previews of streaming video
Introduction of uploading and streaming video
Introduced video stream playback endpoint on File Resource
Introduced GET video stream endpoint on File Resource
For updates in write context files need to be attached in the category corresponding to their file type
Read-only property numImages added to Message resource
Read-only property numVideos added to Message resource
Read-only property numFiles added to Message resource
Property images added to Message resource (in write-context)
Property videos added to Message resource (in write-context)
Property files added to Message resource (in write-context)
Read-only property videoEnabled added to Network resource
Read-only property marketEnabled added to Network Features subresource
Introduced video_processing_complete alert type
HAL images relation added to Message resource
HAL videos relation added to Message resource
HAL files relation added to Message resource
Version 1.3
v1.3.8 October 18, 2016
Property hasMenuItem added to App Entry Point object
Applications can send alerts to users by targeting their XID
Alerts can now be sent to users with a pending invitation
v1.3.7 September 29, 2016
Property headerBackgroundUrl of the User resource no longer returns a thumbnail, but the URL of the original image
HAL organizationGroups relation added to User resource
Introduced internal contact label type
Introduced various thumbnail formats
v1.3.6 September 19, 2016
Introduced whitelist for thumbnails that are generated on demand
Users can now hide their primary email address
Read-only property hidden added to Email Address object
Property defaultPrimaryEmailPrivacySetting added to Network object
Introduced File Dimensions object
Property dimensions added to File object of Message resource
v1.3.4 - v1.3.5 September 5, 2016
Introduced different timeline sorting options
Introduced Preferences object
Property preferences added to User Settings subresource
v1.3.3 July 28, 2016
Deprecated Usage resource
v1.3.2 July 14, 2016
Introduced subscribe action endpoint on Message resource
Introduced unsubscribe action endpoint on Message resource
Property widgetHeight added to App Entry Point object
v1.3.1 June 30, 2016
Property subscribed added to user metadata of Message resource
Introduced message_activity_comment alert type
v1.3 June 16, 2016
Introduces editing updates and comments
Property superseded added to Message resource
Version 1.2
v1.2.2 April 29, 2016
Deprecated non-standard HTTP status texts in JSON error response
v1.2.1 March 24, 2016
Introduced DELETE by XID endpoint on User resource
Introduced suspend action endpoint on Membership resource
Suspended users are reactivated when reinvited
v1.2 March 10, 201z
Introduced accept Terms of Service action endpoint
Introduction of SAML Signle Sign On
Introduced Access Preconditions object
Property identity added to Ivitee object
Property autoActivate added to Ivitee object
Introduced Identity object
Property accessPreconditions added to user metadata of Network resource
Introduced reactivate Network Invite Result type
Introduced Single Sign On object
Property sso added to Network resource (in write-context)
Version 1.1
v1.1.16 January 28, 2016
Both published news items and drafts returned in news collection
Property whitelabelApp added to User Device resource
v1.1.15 December 17, 2015
Changed default timezone format (colon introduced between hours and minutes)
Application permission list_group_members added
Application permission list_networks added
v1.1.14 December 7, 2015
Introduced GET collection endpoint on Whitelabel App resource
Introduced GET endpoint on Whitelabel App resource
Introduced POST new endpoint on Whitelabel App resource
Introduced PUT update endpoint on Whitelabel App resource
Introduction of the rich news editor
Property whitelabelApp added to App Manifest resource (in write-context)
Read-only property lastModified added to Message resource
Read-only property lastEdited added to Message resource
HAL lastEditoroMes relation added to Message resource
Property status added to Message resource
Property htmlBody added to Message resource
Property headerBackground added to Message resource (in write-context)
Read-only property headerBackground added to Message resource
HAL headerBackground relation added to Message resource
Read-only property newsHeaderBackground added to Network Theme resource
v1.1.13 October 29, 2015
Application permission get_network_timeline added
v1.1.12 October 15, 2015
Introduced DELETE endpoint on Sessions resource
Introduced resolvelocation action endpoint
Introduced resolvelocation action endpoint
Introduced GET collection endpoint on Sessions resource
Introduced POST update endpoint on Sessions resource
v1.1.11 October 1, 2015
Introduced GET collection endpoint on Group Widgets subresource
Introduced POST bulk update endpoint on Group Widgets subresource
Introduced PUT bulk update endpoint on Group Widgets subresource
Introduction of group widgets
v1.1.10 September 17, 2015
Introduced GET endpoint of Spotlight Widget on Group Resource
Introduced POST update endpoint of Spotlight Widget on Group Resource
Renamed property type to widgetType in Widget Resource
Property type added to Widget resource
Property XID added to Group resource
Property membersMayPost added to Group resource
Property recipients added to Share entity
### v1.1.9 September 7, 2015
Application permission get_user_groups added
Application permission post_to_any_group added
Introduced DELETE endpoint on Alert resource
Introduced POST update endpoint on Alert resource
Property emailDeliveryFormat added to Network subresource
v1.1.8 July 28, 2015
Application permission get_profile_xid added
Application permission list_groups added
Introduced DELETE endpoint on User Authorized Apps subresource
Introduced GET by XID endpoint on User resource
Introduced GET collection endpoint on User Authorized Apps subresource
Introduced PATCH endpoint on User resource
Introduced POST new endpoint on User Authorized Apps subresource
Introduced POST update by XID endpoint on User resource
Introduced POST update endpoint on User Authorized Apps subresource
Introduction of Single Sign On for Speakap applications
Property redirectUris added to Group resource
Property scope added to user metadata of App resource
Property authorized added to user metadata of App resource
v1.1.7 July 9, 2015
Query filter label introduced for the Group resource collection
Query filter q introduced for the Label resource collection
Introduced DELETE endpoint on Label resource
Introduced GET collection endpoint on Label resource
Introduced GET endpoint on Label resource
Introduced POST new endpoint on Label resource
Introduced POST update endpoint on Label resource
Introduced PUT update endpoint on Label resource
Introduced label recipients
Introduced Label resource
v1.1.6 June 26, 2015
Application permission list_network_roles added
Query filter exclude_group introduced for the User resource collection
Read-only property total added to Pagination object
v1.1.5 June 11, 2015
Application permission upload_into_folders added
Query filter ancestor introduced for the Group resource collection
Read-only property created added to successful JSON response
v1.1.4 April 30, 2015
Deprecated property relationshipStatus from User Resource
v1.1.3 April 16, 2015
Introduced sync-user action endpoint of Network resource
Property XID added to User resource
v1.1.2 April 2, 2015
Query filter addable_to introduced for the User resource collection
v1.1.1 March 19, 2015
Query filter addressable_for introduced for the Group resource collection
Group’s name is not longer appended with the parent group name
v1.1 March 5, 2015
Introduction of Enterprise Speakap
Application permission infinite_limit added
Query filter disable_participant_matching introduced for the Conversation resource collection
Query filter include_hidden introduced for the Group resource collection
Query filter parent introduced for the Group resource collection
Query filter scope introduced for the Group resource collection
Query filter type introduced for the Group resource collection
Query filter scope introduced for the User resource collection
Introduced GET collection endpoint on Group Types subresource
Introduced GET endpoint on Group Types subresource
Introduced GET collection endpoint on Group Relations subresource
Introduced POST new endpoint on Business Unit resource
Introduced POST new endpoint on Department resource
Introduced POST new endpoint on Group Relations subresource
Introduced POST update endpoint on Group Types subresource
Introduced POST new endpoint on Group Relations subresource
Introduced POST new endpoint on Group Types subresource
Introduced add action endpoint on Group Users subresource
Introduced merge action endpoint on Group Users subresource
Introduced POST new endpoint on Local Department resource
Introduced POST update endpoint on Network Subscription subresource
Introduced PUT update endpoint on Group Types subresource
Introduced PUT update endpoint on Network Subscription subresource
Property parent added to Group resource (in write-context)
HAL parentGroup relation added to Group resource
HAL subgroups relation added to Group resource
Read-only property hidden added to Group resource
Introduced Business Unit resource
Introduced Department resource
Introduced Local Department resource
Introduced Group Role entity
Introduced Group Relation resource
Introduced user and group cover images
Property groupHeaderBackgroundUrl added to Network Theme subresource
Property userHeaderBackgroundUrl added to Network Theme subresource
Read-only property group:basic added to search result metadata
Read-only property group:business_unit added to search result metadata
Read-only property group:any_department added to search result metadata
Read-only property message:file:document added to search result metadata
Version 1.0
v1.0.25 - v1.0.26 December 18, 2014
Query filter role introduced for the Group resource collection
Introduced GET collection endpoint on Group Users subresource
Introduced GET collection endpoint on Message Recipients subresource
Introduced GET collection endpoint on News Recipients subresource
Property privacy added to User Settings subresource
Read-only property numRecipients added to Message resource
Property permissions added to user metadata of Message resource
v1.0.24 November 20, 2014
Introduced GET collection endpoint on Alert Groups subresource
Introduced GET collection endpoint on Alert Originators subresource
Introduced GET collection endpoint on User Groups subresource
Introduced add action endpoint on User Groups subresource
Introduced remove action endpoint on User Groups subresource
Introduced added_to_groups alert type
Introduced removed_from_groups alert type
Read-only property numGroups added to Alert resource
Introduced Folder Name object
Read-only property hasSubFolders added to File entity