Starmind API documentation

The Starmind API is a RESTful interface for Starmind, which gives you access to all its data and functions.

Changelog

Description Type
2.45.0
Added sort criterion first_seen in user list endpoint (GET /users). addition
Added sort criteria view_count and solution_count in question list endpoint (GET /questions). addition
Deprecated sort criterion views in question list endpoint (GET /questions) in favour of view_count to reflect naming of response parameter. deprecation
2.43.0
Added is_hidden and is_system properties to the user resource. addition
Deprecated include_deleted parameter in user list endpoint (GET /users) in favour of include-parameter which supports inclusion of hidden and system users as well. deprecation
2.42.0
Adjusted behaviour of sort parameter when searching for users, questions or tags. The sort param will now apply to search-queries as well, unlike before when search was ordered by relevance only, ignoring any sort parameter.
To retain old behaviour, remove any sort-param when searching for users, questions or tags. sort criteria are evaluated like in SQLs ORDER BY.
E.g. ?sort=name.asc,id.asc will sort records by name and among identical names by id.
change
2.41.0
Added a company property to the user resource. It can be used in the appendix_user_info_clip and appendix_user_search_clip user settings. addition
2.38.0
Added endpoint POST /search/experts to search for experts based on any text query. addition
Adjusted ordering of solutions in GET /questions/:id/complete endpoint.
Expiration of a solution does not have influence on ordering anymore. An expired solution (in the array of solutions) will appear before a valid solution if its rating is higher.
change
2.36.0
Removed the NetworkSetting announcement_emails_enabled. Announcement emails will always be sent unless email_delivery_enabled is set to false. removal
Deprecated the public settings user_score_enabled and user_score_frontend_enabled in favor of the field user_score. deprecation
Added input field to layout settings endpoint. addition
2.35.0
Added user_creation_default_roles to GET /settings endpoint. addition
Deprecated the content field in the webhooks data payload JSON schema in favour of the new target_object field. deprecation
2.34.0
Added endpoints: set disclaimer agreement and remove disclaimer agreement. addition
If the network setting disclaimer_enabled is set to true all communication channels (besides webhooks) are disabled for a user who did not accept the disclaimer yet. change
2.33.0
Deprecated score in response of GET /statistics/network/experts endpoint. Use newly added details instead to get more fine-grained expert information. change
The GET /search/questions/similar endpoint is deprecated in favour of the new GET /search/questions-similar endpoint. change
2.30.0
Added a new user network setting property user_creation_default_roles to the GET /settings/user endpoint. addition
Added published (timestamp) to all question and solution entities on all endpoints. addition
Changed default for network setting announcement_emails_enabled to true change
2.29.0
Added a new AuthType-Permission "extended_user_properties_change_allowed" to the GET /settings endpoint and deprecated the permission "location_about_change_allowed". change
2.28.0
Added endpoint: activities of a specified user. addition
2.27.0
Changed field separator of CSV export files from comma to tab. Affected export endpoints: tag export, user export. change
2.26.0
Added new notification types validation_new_expert, question_changed_to_solution_author, solution_changed_to_question_poser and solution_changed_to_solution_rater. addition
2.25.0
Tags relations for question drafts are only created as actual tags when the question is published. They are no longer included in the response of tag endpoints. change
Add endpoint to create tags addition
2.24.0
Remove mail_footer_reply_to from layout settings change
Add feedback_to and footer_reply_to to email settings addition
Add email notification settings endpoint. addition
2.21.0
The start and end points of the user-scores bulk export are now always at midnight in the UTC timezone. The start and end parameters can be used as before, but any time or time zone specifications will be ignored. change
2.19.0
Added department, position and country properties to the user resource. addition
2.15.0
Refactor roles change
Added network setting solution_value_allow_all with default false addition
2.14.0
Added endpoint to set and retrieve Webhook settings. addition
Added endpoint to set and retrieve Custom JS settings. addition
2.13.0
Added network setting announcement_emails_enabled with default false addition
Added endpoint to set and retrieve RSS settings. addition
Added settings endpoints for OpenSearch settings. addition
Added role-filter to GET /users. addition
While the search index is still being loaded, an error is thrown for search requests, rather than silently falling back to an empty result. change
2.12.0
Added settings endpoints for solution value settings. addition
2.11.0
Added endpoint to restore a solution. addition
2.10.0
Added endpoint to set and retrieve content settings. addition
Extended network settings endpoint with available_interface_languages. addition
2.9.0
Changed max tag length from 255 to 191 characters. change
Changed max email length from 255 to 191 characters. change
Changed max custom filter name length from 255 to 191 characters. change
2.7.0
Added sort questions by views support. addition
Added view_count field to question response GET /questions. addition
2.6.0
Extended favicon support. Changed reset favicon endpoint. change
Added tag export endpoint addition
2.5.0
Added asynchronous question import execution. change
2.3.0
Added share notification types. addition
Added POST /questions/:ID/share endpoint. addition
Added POST /solutions/:ID/share endpoint. addition
2.2.0
Added mention notification types. addition
Renamed application setting from allow_forward_to_inactive to allow_inactive_user_interaction. change
Added a trending filter to the GET /questions endpoint. addition
2.1.0
Added POST /tags/:ID/merge endpoint. addition
0.24.0
Added asynchronous Tag bulk import. addition
Added DELETE /tags/:ID endpoint. addition
0.23.0
Added flagged filter to GET /questions endpoint. addition
Added PUT /heartbeat endpoint. addition
Added endpoints to set and retrieve layout and ribbon settings addition
0.22.0
User bulk imports are now executed asynchronous. change
Added GET /import/users/status endpoint. addition
Added GET /import/users/:ID/status endpoint. addition
Added additional error code (FileTooLarge) to the error code reference. addition
Added network setting email_delivery_enabled with default false addition
Changed default value of network setting hint_emails_enabled to false. change
Renamed network setting emails_enabled to notification_channel_email_enabled and changed default value to false. change
0.21.0
Added content export via XML endpoints addition
Added additional error code to the error code reference addition
Added PUT /questions/:id/restore endpoint. addition
Added auth_type for each user. addition
Added new role api_user, which is mandatory for API authentication. change
0.20.0
Added GET /export/user-scores endpoint. addition
Added tag property to PUT /tags/:id endpoint. addition
Added include_deleted parameter to GET /questions endpoint. addition
Added tag_relations property to the response of the GET /questions endpoint. addition
Added is_deleted property to Question object. addition
Rework error handling by introducing error codes for validation failures. change
0.19.0
Rework error handling by introducing error codes. change
Added tag subscription endpoints to subscribe users to a tag. addition
Added the flag excluded_from_suggestions to the tag object. addition
Added a PUT /tags/:id endpoint. addition
0.18.0
Added a POST /search/tags/suggestions endpoint and deprecated the GET /search/tags/suggestions endpoint. change
Added user import via JSON endpoint addition
Changed response of existing user import endpoints. change
Changed format of notification settings in user settings endpoint change
0.15.0
Added tags endpoint addition
Added GET custom-filters endpoint and allow to apply custom filter on question GET endpoint. addition
Add X-Act-On-Behalf-Unique-Id header to allow a technical user to act on behalf other users identified by their unique id.
Only one of the X-Act-On-Behalf headers is allowed at once!
addition
0.14.0
Added user-score settings endpoint addition
Added score_level and score_points properties to the user object addition
Removed solutions, comments, tags properties from question endpoints removal
Removed comments property from solution endpoints removal
Add bulk question import endpoint addition
Removed the language parameter from the tag search endpoint change
0.13.0
Add bulk user import endpoint addition
Add countries endpoint addition
First- and lastname are now returned for deleted users. change
Add last_seen property to user endpoints addition
Removed includeInactive parameter on user list endpoint. By default now all users are listed. Use filter active or inactive to only show the respective users. change
Allow users to be filtered user list endpoint. addition
Added include_deleted parameter to user list endpoint. addition
Add sort parameter to user list endpoint addition
Added search logging endpoints. addition
Added question image add and delete endpoints. addition
Added comment promotion endpoint. addition
Added promoted_solution to comment response. addition
0.12.0
Added question escalation endpoints. addition
Added tag subscription endpoints. addition
Added question flagging endpoints. addition
0.11.0
Added support for user customfields. addition
Added first_seen to user response. addition
Added target_type field to notification response GET /notifications. addition
0.10.0
Added endpoint to set the time a solution saved: PUT /solutions/:id/time-saved. addition
0.8.0
Add X-Act-On-Behalf header to allow a technical user to act on behalf other users.
This removes the ability to specify the user id via query parameter or along with the payload!
change
Added endpoint for a user to set initial tag relation for himself: PUT /users/my-tag-relations. addition
Add network setting question_title_max_length addition
Increased the maximum number of tags per question to 10. change
Add default user image to settings endpoint GET /settings
addition
Moved POST admin/users to POST /users endpoint.
Moved PUT admin/users/:id/restore to PUT /users/:id/restore endpoint.
Moved DELETE admin/users/:id to DELETE /users/:id endpoint.
change
Removed POST /admin/auth in favor of POST /auth/login. removal
Moved GET /admin/questions/:id/experts to GET /questions/:id/experts endpoint. change
0.7.0
Changed input of tags for creating/updating a question and removed id from tag response
POST /questions
PUT /questions/:id
change
Added several network statistics endpoints: addition
0.6.0
Added endpoint to set initial tag relation PUT /users/:id/tag-relations endpoint. addition
Changed response of GET /search/tags endpoint. change
Added content_editing to settings endpoint addition
Added GET /statistics/network/experts endpoint. addition
0.5.0
Added GET /users/:id/settings endpoint. addition
Added solution_count to question response. addition
Added GET /users/:id/expertise endpoint. addition
Added /users/:id/password endpoint. addition
Added DELETE /users/:id/image endpoint. addition
Changed response of POST /users/:id/image endpoint. change
0.4.0
Added GET /users/me/activities endpoint. addition
has_unfollowed property for question follow responses. addition
Changed response of GET /users/:id/expertise endpoint. change

Structure

This documentation consists of these parts:

  • Concepts
    This part explains the underlying concepts of the Starmind API, like the data-types and errors.

  • Resources
    A look at the different endpoints and the data they return.

  • Reference
    Lists of things like possible settings and data types.