GET /api/users/search

search for users in your community

Success Response Code: 200

Params

Param name Description
q
optional

search term


Value: Must be a String
page
optional

page number to view (default=1)


Value: Must be a Integer
per_page
optional

number of users to be returned per page (default=20, max=500)


Value: Must be a Integer

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/search.json?q=emily"

Examples

GET /api/users/search.json
200
{
  "users": [
    {
      "contact_info": {
        "email": "active'47@socialcast.com"
      },
      "manager": null,
      "custom_fields": [],
      "followable": true,
      "contact_id": null,
      "following_count": 0,
      "followers_count": 0,
      "status_message": null,
      "id": 51,
      "first_name": "Emily",
      "last_name": "D'øe47",
      "name": "Emily D'øe47",
      "html_name": "Emily D&#39;øe47",
      "url": "https://socialcast.socialcast.test/users/51-emilyd%C3%B8e47",
      "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%2F20180617%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20180617T234500Z&X-Amz-Expires=518400&X-Amz-SignedHeaders=host&X-Amz-Signature=9931c65824722db3ff2bd05212e83661f248073f4f1d90e99399b93a101d6eba",
        "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%2F20180617%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20180617T234500Z&X-Amz-Expires=518400&X-Amz-SignedHeaders=host&X-Amz-Signature=51dc67579ae35dc05474b1f005eeef4fb6aa236a69aab2f9e943c8731a220f62",
        "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%2F20180617%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20180617T234500Z&X-Amz-Expires=518400&X-Amz-SignedHeaders=host&X-Amz-Signature=77bd1c4ad24f3d19b645f42c4199a41c1cb7ab5ebf519c187cdb3dbf9d3ec87f",
        "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%2F20180617%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20180617T234500Z&X-Amz-Expires=518400&X-Amz-SignedHeaders=host&X-Amz-Signature=16251f66df1eb380811fb3237f78595922d2c6339563291200941e8511786ba0",
        "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%2F20180617%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20180617T234500Z&X-Amz-Expires=518400&X-Amz-SignedHeaders=host&X-Amz-Signature=024b15e076615cf62daabd1e1d2552572b81d67bb1de96d25bdf1449414c7b0b",
        "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%2F20180617%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20180617T234500Z&X-Amz-Expires=518400&X-Amz-SignedHeaders=host&X-Amz-Signature=7a1ffc5ab4a82c2c0e3e85cb569cda928c6e08450c7b39d0b232c7642a052c4f"
      },
      "username": "EmilyDøe47",
      "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
    }
  ]
}