GET /api/userinfo

get information on current user

Success Response Code: 200

Response Fields

contact_info the user's contact information. Includes phone numbers, email addresses, instant messenger services, and location Hash<string, string>
manager user's manager's ID Integer
custom_fields user's settings for community-defined custom fields - also includes business unit and department information Array<Hash<string, string>>
followable whether this user can be followed Boolean
contact_id if the current user is following this user, the contact record Integer
following_count the number of users that the user is following Integer
followers_count the number of users are following the user Integer
status_message unused; always null String
id user's id Integer
name user's full name String
first_name user's first name (or preferred first name if set) String
last_name user's last name String
url url to interact with the user's record String
avatars urls for the user's avatar in various sizes Hash<string, string>
username user's username String
active whether the user is currently active Boolean
terminated whether the user has been terminated Boolean
inactive whether the user is inactive Boolean
role user's role within the community (community_admin, sbi_admin, reach_admin, town_hall_admin, external_contributor_admin, thanks_admin, broadcast_message_admin, client_admin, content_moderator, challenge_admin, tenant_admin) String
title user's title within the organization String
type type of user String
out_of_office whether the user is currently out of the office Boolean
out_of_office_on start of out-of-office period DateTime
back_in_office_on end of out-of-office period DateTime
company_login user's company login String
can_invite_external_contributors whether the user is allowed to invite external conributors to groups Boolean
community[name] name of the community String
community[subdomain] subdomain of the community String
community[domain] full domain of the community String
community[attachments_enabled] whether attachments are enabled for the community Boolean
community[maximum_attachment_size] maximum attachment size for the community (in bytes) Boolean
community[private_messages_enabled] whether private messages are enabled for the community Boolean
community[thanks_enabled] whether this community has thanks enabled Boolean
community[conversations_enabled] whether conversations are enabled for this community Boolean
community[external_contributors_enabled] whether external contributors are allowed for this community Boolean
community[google_hangouts_enabled] whether google hangouts integration is enabled for this community Boolean
community[version] version of Socialcast currently running String
community[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
community[profile_photo_change_allowed] whether users in this community are allowed to change their profile photos Boolean
community[mobile_crash_reports_enabled] whether mobile apps registered for a user in this community should send crash reports Boolean
community[airwatch_mobile_sdk_enabled] whether mobile apps connecting to this community must use the Airwatch SDK Boolean
community[one_drive_business_enabled] whether OneDrive for Business integration is enabled for the community Boolean
community[one_drive_business_client_id] client id of the application registered with Azure portal that enables authentication for OneDrive for Business integration String
community[google_drive_enabled] whether Google Drive integration is enabled for the community Boolean
community[google_drive_api_key] api_key of the project registered with Google's Developer Console with Picker API enabled String
community[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/userinfo.json"

Examples

GET /api/userinfo.json
200
{
  "user": {
    "contact_info": {
      "email": "active'46@socialcast.com"
    },
    "manager": null,
    "custom_fields": [],
    "followable": false,
    "contact_id": null,
    "following_count": 0,
    "followers_count": 0,
    "status_message": null,
    "id": 50,
    "first_name": "J'øhn46",
    "last_name": "D'øe46",
    "name": "J'øhn46 D'øe46",
    "html_name": "J&#39;øhn46 D&#39;øe46",
    "url": "https://socialcast.socialcast.test/users/50-j%C3%B8hn46d%C3%B8e46",
    "avatars": {
      "is_system_default": false,
      "id": 4,
      "square16": "https://s3.amazonaws.com/socialcast_test/tenants/1/profile_photos/4/rails_square16.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=stubbed-akid%2F20170722%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20170722T234500Z&X-Amz-Expires=518400&X-Amz-SignedHeaders=host&X-Amz-Signature=21a4b08f689dd03d557cfa02023b6552775b7023b60806fca85c34befa6ca356",
      "square30": "https://s3.amazonaws.com/socialcast_test/tenants/1/profile_photos/4/rails_square30.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=stubbed-akid%2F20170722%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20170722T234500Z&X-Amz-Expires=518400&X-Amz-SignedHeaders=host&X-Amz-Signature=51c5ef35993c97add35eb7da39e3ad20bc9e5d31a0526a025952dd541d26fbf0",
      "square45": "https://s3.amazonaws.com/socialcast_test/tenants/1/profile_photos/4/rails_square45.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=stubbed-akid%2F20170722%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20170722T234500Z&X-Amz-Expires=518400&X-Amz-SignedHeaders=host&X-Amz-Signature=7c3fc15a3bb8117cc7c0d528846559d4a061592c53ac0cdf2ebf6d5a19ae2383",
      "square70": "https://s3.amazonaws.com/socialcast_test/tenants/1/profile_photos/4/rails_square70.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=stubbed-akid%2F20170722%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20170722T234500Z&X-Amz-Expires=518400&X-Amz-SignedHeaders=host&X-Amz-Signature=2841a6ee6d194b62b2a37688bcfeb8b5d6179b3e70760811c7f3625372fc5293",
      "square140": "https://s3.amazonaws.com/socialcast_test/tenants/1/profile_photos/4/rails_square140.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=stubbed-akid%2F20170722%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20170722T234500Z&X-Amz-Expires=518400&X-Amz-SignedHeaders=host&X-Amz-Signature=04def3541eca95ac71866e7c5e712dd01baaa51cf0efc07650aaa73587f31fd8",
      "original": "https://s3.amazonaws.com/socialcast_test/tenants/1/profile_photos/4/rails.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=stubbed-akid%2F20170722%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20170722T234500Z&X-Amz-Expires=518400&X-Amz-SignedHeaders=host&X-Amz-Signature=9f6f6c9ddcd7be17eaaff5a762ea6b5ca3fcc55fa8cbcce003c46106f90cb884"
    },
    "username": "Jøhn46Døe46",
    "active": true,
    "terminated": false,
    "inactive": false,
    "role": "member",
    "type": "User",
    "title": null,
    "out_of_office": false,
    "out_of_office_on": null,
    "back_in_office_on": null,
    "company_login": null,
    "thanks_points": 3,
    "can_invite_external_contributors": false,
    "preferences": {
      "mobile_notifications_enabled": true,
      "email_reply_to_comment": true,
      "email_on_follow": true,
      "email_on_at_reply": true,
      "email_on_chat_at_reply": false,
      "email_new_people_to_follow": false,
      "email_accept_invite": false,
      "email_me_when_employee_is_sent_thanks": true,
      "receipt_for_share_email": true,
      "receipt_for_message_follow": false,
      "nudge_email": true,
      "email_on_image_comment": true,
      "email_on_link_comment": true,
      "email_on_status_message_comment": true,
      "email_on_worklog_comment": true,
      "email_on_question_comment": true,
      "email_on_review_request_comment": true,
      "email_on_help_request_comment": true,
      "email_on_broadcast_message_comment": true,
      "email_on_chat_reply_comment": true,
      "email_on_share_message_comment": true,
      "email_on_chat_comment": true,
      "email_on_chat_share_comment": true,
      "email_on_new_remark": true,
      "email_on_idea_comment": true,
      "email_on_new_challenge_comment": true,
      "email_on_challenge_voting_end_comment": true,
      "email_on_challenge_change": true,
      "email_on_project_share_with_group_comment": true,
      "email_on_project_completed_comment": true,
      "email_on_project_change": true,
      "email_on_new_town_hall_comment": true,
      "email_on_answers_my_town_hall_questions": true,
      "email_on_becoming_moderator_or_speaker_of_town_hall": true,
      "email_on_new_group_comment": true,
      "email_on_group_broadcast_message_comment": true,
      "email_on_external_contributor_joined_comment": true,
      "email_on_web_feed_comment": true,
      "email_on_poll_comment": true,
      "email_on_profile_photo_comment": true,
      "email_on_thanks_comment": true,
      "email_on_joined_community_comment": true,
      "push_notification_on_group_chat_message": false,
      "push_notification_on_chat_mention": true,
      "push_notifications_enabled_for_group_chat": true,
      "social_chat_beta": true
    },
    "community": {
      "name": "socialcast, Test & CØ.",
      "subdomain": "socialcast",
      "domain": "socialcast.socialcast.test",
      "attachments_enabled": true,
      "maximum_attachment_size": 104857600,
      "private_messages_enabled": false,
      "thanks_enabled": true,
      "thanks_max_recipients": 10,
      "version": "master",
      "default_profile_photo_id": 4,
      "profile_photo_change_allowed": true,
      "mobile_crash_reports_enabled": true,
      "airwatch_mobile_sdk_enabled": false,
      "external_contributors_enabled": true,
      "google_hangouts_enabled": true,
      "post_enabled": true,
      "group_chat_enabled": true,
      "group_chat_notification_preferences_enabled": false,
      "group_chat": true,
      "one_to_one_group_beta": false,
      "attachment_blacklist": [],
      "one_drive_business_enabled": false,
      "one_drive_business_client_id": null,
      "conversations_enabled": true,
      "air_watch_content_api_key": null,
      "air_watch_content_enabled": false,
      "air_watch_content_selector_url": null,
      "presence_enabled": false,
      "google_drive_enabled": false
    }
  }
}
GET /api/userinfo.json
200
{
  "user": {
    "contact_info": {
      "email": "active'46@socialcast.com"
    },
    "manager": null,
    "custom_fields": [],
    "followable": false,
    "contact_id": null,
    "following_count": 0,
    "followers_count": 0,
    "status_message": null,
    "id": 50,
    "first_name": "J'øhn46",
    "last_name": "D'øe46",
    "name": "J'øhn46 D'øe46",
    "html_name": "J&#39;øhn46 D&#39;øe46",
    "url": "https://socialcast.socialcast.test/users/50-j%C3%B8hn46d%C3%B8e46",
    "avatars": {
      "is_system_default": false,
      "id": 4,
      "square16": "https://s3.amazonaws.com/socialcast_test/tenants/1/profile_photos/4/rails_square16.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=stubbed-akid%2F20170722%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20170722T234500Z&X-Amz-Expires=518400&X-Amz-SignedHeaders=host&X-Amz-Signature=21a4b08f689dd03d557cfa02023b6552775b7023b60806fca85c34befa6ca356",
      "square30": "https://s3.amazonaws.com/socialcast_test/tenants/1/profile_photos/4/rails_square30.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=stubbed-akid%2F20170722%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20170722T234500Z&X-Amz-Expires=518400&X-Amz-SignedHeaders=host&X-Amz-Signature=51c5ef35993c97add35eb7da39e3ad20bc9e5d31a0526a025952dd541d26fbf0",
      "square45": "https://s3.amazonaws.com/socialcast_test/tenants/1/profile_photos/4/rails_square45.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=stubbed-akid%2F20170722%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20170722T234500Z&X-Amz-Expires=518400&X-Amz-SignedHeaders=host&X-Amz-Signature=7c3fc15a3bb8117cc7c0d528846559d4a061592c53ac0cdf2ebf6d5a19ae2383",
      "square70": "https://s3.amazonaws.com/socialcast_test/tenants/1/profile_photos/4/rails_square70.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=stubbed-akid%2F20170722%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20170722T234500Z&X-Amz-Expires=518400&X-Amz-SignedHeaders=host&X-Amz-Signature=2841a6ee6d194b62b2a37688bcfeb8b5d6179b3e70760811c7f3625372fc5293",
      "square140": "https://s3.amazonaws.com/socialcast_test/tenants/1/profile_photos/4/rails_square140.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=stubbed-akid%2F20170722%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20170722T234500Z&X-Amz-Expires=518400&X-Amz-SignedHeaders=host&X-Amz-Signature=04def3541eca95ac71866e7c5e712dd01baaa51cf0efc07650aaa73587f31fd8",
      "original": "https://s3.amazonaws.com/socialcast_test/tenants/1/profile_photos/4/rails.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=stubbed-akid%2F20170722%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20170722T234500Z&X-Amz-Expires=518400&X-Amz-SignedHeaders=host&X-Amz-Signature=9f6f6c9ddcd7be17eaaff5a762ea6b5ca3fcc55fa8cbcce003c46106f90cb884"
    },
    "username": "Jøhn46Døe46",
    "active": true,
    "terminated": false,
    "inactive": false,
    "role": "member",
    "type": "User",
    "title": null,
    "out_of_office": false,
    "out_of_office_on": null,
    "back_in_office_on": null,
    "company_login": null,
    "thanks_points": 3,
    "can_invite_external_contributors": false,
    "preferences": {
      "mobile_notifications_enabled": true,
      "email_reply_to_comment": true,
      "email_on_follow": true,
      "email_on_at_reply": true,
      "email_on_chat_at_reply": false,
      "email_new_people_to_follow": false,
      "email_accept_invite": false,
      "email_me_when_employee_is_sent_thanks": true,
      "receipt_for_share_email": true,
      "receipt_for_message_follow": false,
      "nudge_email": true,
      "email_on_image_comment": true,
      "email_on_link_comment": true,
      "email_on_status_message_comment": true,
      "email_on_worklog_comment": true,
      "email_on_question_comment": true,
      "email_on_review_request_comment": true,
      "email_on_help_request_comment": true,
      "email_on_broadcast_message_comment": true,
      "email_on_chat_reply_comment": true,
      "email_on_share_message_comment": true,
      "email_on_chat_comment": true,
      "email_on_chat_share_comment": true,
      "email_on_new_remark": true,
      "email_on_idea_comment": true,
      "email_on_new_challenge_comment": true,
      "email_on_challenge_voting_end_comment": true,
      "email_on_challenge_change": true,
      "email_on_project_share_with_group_comment": true,
      "email_on_project_completed_comment": true,
      "email_on_project_change": true,
      "email_on_new_town_hall_comment": true,
      "email_on_answers_my_town_hall_questions": true,
      "email_on_becoming_moderator_or_speaker_of_town_hall": true,
      "email_on_new_group_comment": true,
      "email_on_group_broadcast_message_comment": true,
      "email_on_external_contributor_joined_comment": true,
      "email_on_web_feed_comment": true,
      "email_on_poll_comment": true,
      "email_on_profile_photo_comment": true,
      "email_on_thanks_comment": true,
      "email_on_joined_community_comment": true,
      "push_notification_on_group_chat_message": false,
      "push_notification_on_chat_mention": true,
      "push_notifications_enabled_for_group_chat": true,
      "social_chat_beta": true
    },
    "community": {
      "name": "socialcast, Test & CØ.",
      "subdomain": "socialcast",
      "domain": "socialcast.socialcast.test",
      "attachments_enabled": true,
      "maximum_attachment_size": 104857600,
      "private_messages_enabled": false,
      "thanks_enabled": true,
      "thanks_max_recipients": 10,
      "version": "master",
      "default_profile_photo_id": 4,
      "profile_photo_change_allowed": true,
      "mobile_crash_reports_enabled": true,
      "airwatch_mobile_sdk_enabled": false,
      "external_contributors_enabled": true,
      "google_hangouts_enabled": true,
      "post_enabled": true,
      "group_chat_enabled": true,
      "group_chat_notification_preferences_enabled": false,
      "group_chat": true,
      "one_to_one_group_beta": false,
      "attachment_blacklist": [],
      "one_drive_business_enabled": false,
      "one_drive_business_client_id": null,
      "conversations_enabled": true,
      "air_watch_content_api_key": null,
      "air_watch_content_enabled": false,
      "air_watch_content_selector_url": null,
      "presence_enabled": false,
      "google_drive_enabled": false
    }
  }
}