GET /api/users/company_login/:company_login

show information for a user

Success Response Code: 200

Params

Param name Description
company_login
required

company login for the user


Value: Must be a String

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

Example Curl Commands

curl -X GET -v --basic -u "emily@socialcast.com:demo" "https://demo.socialcast.com/api/users/company_login/ejames.json"
curl -X GET -v --basic -u "emily@socialcast.com:demo" "https://demo.socialcast.com/api/users/company_login.json?id=emily@socialcast.com"

Examples

GET /api/users/company_login/my_company_login.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%2F20170917%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20170917T234500Z&X-Amz-Expires=518400&X-Amz-SignedHeaders=host&X-Amz-Signature=a880159012d55f77543b641c54f4ef167ced93478840f87a405163550b0bd426",
      "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%2F20170917%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20170917T234500Z&X-Amz-Expires=518400&X-Amz-SignedHeaders=host&X-Amz-Signature=7fdcb7c429e884cf3d0e4f6b7a82c07304e074e8522b705d1ddd6ef9bda1a95b",
      "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%2F20170917%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20170917T234500Z&X-Amz-Expires=518400&X-Amz-SignedHeaders=host&X-Amz-Signature=324f0242124b2033aab8631fa4e8f8f241e087baa62af195f506a45b1f07815f",
      "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%2F20170917%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20170917T234500Z&X-Amz-Expires=518400&X-Amz-SignedHeaders=host&X-Amz-Signature=cff5fe4b91b51bb795562517bfd8ee4baa47cddb8e808e5ae7869a04ede5b11b",
      "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%2F20170917%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20170917T234500Z&X-Amz-Expires=518400&X-Amz-SignedHeaders=host&X-Amz-Signature=bb73275870bebc3815137dfcf2941dffde1b7bf56bd6354c26d4b88eb42f7493",
      "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%2F20170917%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20170917T234500Z&X-Amz-Expires=518400&X-Amz-SignedHeaders=host&X-Amz-Signature=fd0d74ae1db62e0e7ae16725a148c66d64fb0172bae353cfb6291af648c7d1ed"
    },
    "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": "my_company_login"
  }
}