GET /api/community_info

get information about current community

Success Response Code: 200

Response Fields

name name of the community String
subdomain subdomain of the community String
domain full domain of the community String
attachments_enabled whether attachments are enabled for the community Boolean
maximum_attachment_size maximum attachment size for the community (in bytes) Boolean
private_messages_enabled whether private messages are enabled for the community Boolean
thanks_enabled whether this community has thanks enabled Boolean
conversations_enabled whether conversations are enabled for this community Boolean
version version of Socialcast currently running String
default_profile_photo_id the id of the default profile photo to be used for a user that does not have a photo set Integer
profile_photo_change_allowed whether users in this community are allowed to change their profile photos Boolean
mobile_crash_reports_enabled whether mobile apps registered for a user in this community should send crash reports Boolean
external_contributors_enabled whether external contributors are allowed for this community Boolean
attachment_blacklist File extensions prohibited for upload (if configured). All other extensions are allowed. Example: ["exe", "bat", "html"]. This field is returned only if attachments are enabled and a blacklist is set Array<String>
attachment_whitelist File extensions allowed for upload (if configured). All other extensions are prohibited. Example: ["png", "jpg", "gif"]. This field is returned only if attachments are enabled and a whitelist is set Array<String>
one_drive_business_enabled whether OneDrive for Business integration is enabled for the community Boolean
one_drive_business_client_id client id of the application registered with Azure portal that enables authentication for OneDrive for Business integration String
google_drive_enabled whether Google Drive integration is enabled for the community Boolean
google_drive_api_key api_key of the project registered with Google's Developer Console with Picker API enabled String
google_drive_client_id client_id of the project registered with Google's Developer Console with Picker API enabled String

Example Curl Commands

curl -X GET -v --basic -u "emily@socialcast.com:demo" "https://demo.socialcast.com/api/community_info.json"