GET /api/users/suggest

suggest users in your community for autocompletion

Success Response Code: 200

Params

Param name Description
q
required

search term


Value: Must be a String
admins
optional

only include admins (default=false)


Value: Must be one of: <code>true</code>, <code>false</code>.
include_external_contributors
optional

include external contributors in the suggestion results


Value: Must be one of: <code>true</code>, <code>false</code>.

Response Fields

users see #show for details Array<User>

Example Curl Commands

curl -X GET -v --basic -u "emily@socialcast.com:demo" "https://demo.socialcast.com/api/users/suggest.json?q=Jenni"

Examples

GET 
200
{
  "users": [
    {
      "contact_info": {
        "email": "active'4@socialcast.com"
      },
      "manager": null,
      "custom_fields": [],
      "followable": false,
      "contact_id": null,
      "following_count": 0,
      "followers_count": 0,
      "status_message": null,
      "id": 4,
      "first_name": "Abcdjoe",
      "last_name": "Zebulon",
      "name": "Abcdjoe Zebulon",
      "html_name": "Abcdjoe Zebulon",
      "url": "https://socialcast.socialcast.test/users/4-abcdjoezebulon",
      "avatars": {
        "is_system_default": false,
        "id": 1,
        "square16": "https://s3.amazonaws.com/socialcast_test/tenants/1/profile_photos/1/rails_square16.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=stubbed-akid%2F20170529%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20170529T234500Z&X-Amz-Expires=518400&X-Amz-SignedHeaders=host&X-Amz-Signature=e862ceada5f6931a521d9c2a5d29e3e67b09404969da7ad086ed3be85aa50ae7",
        "square30": "https://s3.amazonaws.com/socialcast_test/tenants/1/profile_photos/1/rails_square30.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=stubbed-akid%2F20170529%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20170529T234500Z&X-Amz-Expires=518400&X-Amz-SignedHeaders=host&X-Amz-Signature=8e20955d3d655ed40d7b14e48ac9157afa60fb63783138eff5d0aaeb6806447f",
        "square45": "https://s3.amazonaws.com/socialcast_test/tenants/1/profile_photos/1/rails_square45.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=stubbed-akid%2F20170529%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20170529T234500Z&X-Amz-Expires=518400&X-Amz-SignedHeaders=host&X-Amz-Signature=0acdddc29acbc3bad56389f023da6ab45720d63c52b95926e18d4bb1af548bc6",
        "square70": "https://s3.amazonaws.com/socialcast_test/tenants/1/profile_photos/1/rails_square70.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=stubbed-akid%2F20170529%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20170529T234500Z&X-Amz-Expires=518400&X-Amz-SignedHeaders=host&X-Amz-Signature=0bc205fb9c9ccf25fb993d8f8015f9a5340ea67ed14928be7f2a31659bf35eef",
        "square140": "https://s3.amazonaws.com/socialcast_test/tenants/1/profile_photos/1/rails_square140.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=stubbed-akid%2F20170529%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20170529T234500Z&X-Amz-Expires=518400&X-Amz-SignedHeaders=host&X-Amz-Signature=52a4c4206eef4b4d61e0e5fc80021c1b9c1daeb50df9f6b970956788013225bd",
        "original": "https://s3.amazonaws.com/socialcast_test/tenants/1/profile_photos/1/rails.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=stubbed-akid%2F20170529%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20170529T234500Z&X-Amz-Expires=518400&X-Amz-SignedHeaders=host&X-Amz-Signature=853731d227edf4612c5c17fa01dad17678b7d072beddfe4f04ee2720fe43f059"
      },
      "username": "AbcdjoeZebulon",
      "active": true,
      "terminated": false,
      "inactive": false,
      "role": "tenant_admin",
      "type": "User",
      "title": null,
      "out_of_office": false,
      "out_of_office_on": null,
      "back_in_office_on": null,
      "company_login": null
    }
  ]
}