List Users by Full Name

curl -X GET \
-H "QB-Token: a1e6b25b27ab3771a391b5c1173b572aed012bba" \
https://api.quickblox.com/users/by_full_name.json?full_name=Alex%20Miller

{
  "current_page": 1,
  "per_page": 10,
  "total_entries": 1,
  "items": [
    {
      "user": {
        "id": 96754523,
        "full_name": "Alex Miller",
        "email": "alex@gmail.com",
        "login": "Alex",
        "phone": "+3123555",
        "website": "https://mysite.com",
        "created_at": "2019-08-27T21:08:55Z",
        "updated_at": "2019-08-27T21:08:55Z",
        "last_request_at": null,
        "external_user_id": 126672,
        "facebook_id": "888766",
        "twitter_id": "982366",
        "blob_id": null,
        "custom_data": null,
        "age_over16": true,
        "allow_statistics_analysis": true,
        "allow_sales_activities": true,
        "parents_contacts": "",
        "user_tags": "android,web"
      }
    }
  ]
}

{
  "errors": {
    "base": [
      "Required session does not exist"
    ]
  }
}

{
  "errors": {
    "base": [
      "Users retrieving forbidden in admin panel, application settings. Setup it here https://admin.quickblox.com/apps/{app_id}/service/users/settings"
    ]
  }
}

{
  "code": null,
  "message": "Couldn't find user"
}

GET

users

by_full_name.json

curl -X GET \
-H "QB-Token: a1e6b25b27ab3771a391b5c1173b572aed012bba" \
https://api.quickblox.com/users/by_full_name.json?full_name=Alex%20Miller

{
  "current_page": 1,
  "per_page": 10,
  "total_entries": 1,
  "items": [
    {
      "user": {
        "id": 96754523,
        "full_name": "Alex Miller",
        "email": "alex@gmail.com",
        "login": "Alex",
        "phone": "+3123555",
        "website": "https://mysite.com",
        "created_at": "2019-08-27T21:08:55Z",
        "updated_at": "2019-08-27T21:08:55Z",
        "last_request_at": null,
        "external_user_id": 126672,
        "facebook_id": "888766",
        "twitter_id": "982366",
        "blob_id": null,
        "custom_data": null,
        "age_over16": true,
        "allow_statistics_analysis": true,
        "allow_sales_activities": true,
        "parents_contacts": "",
        "user_tags": "android,web"
      }
    }
  ]
}

{
  "errors": {
    "base": [
      "Required session does not exist"
    ]
  }
}

{
  "errors": {
    "base": [
      "Users retrieving forbidden in admin panel, application settings. Setup it here https://admin.quickblox.com/apps/{app_id}/service/users/settings"
    ]
  }
}

{
  "code": null,
  "message": "Couldn't find user"
}

Recipes

List users by full name with API key

1. Use 'Authorization' header to pass API key

curl -X GET \
-H 'Content-Type: application/json' \
-H 'Authorization: ApiKey 28irlNAGasWDSupO9Vw0BBMZfuHrAUYKpmroS9yBORI' \
https://api.quickblox.com/users/by_full_name.json?full_name=John%20Doe

2. As a result, the API returns a list of users.

curl -X GET \
-H 'Content-Type: application/json' \
-H 'Authorization: ApiKey 28irlNAGasWDSupO9Vw0BBMZfuHrAUYKpmroS9yBORI' \
https://api.quickblox.com/users/by_full_name.json?full_name=John%20Doe

Query Parameters

string

required

User’s full name. Min 3 characters.

integer

default:"1"

Page of results to return.

integer

default:"10"

Number of records to return in one request. Min: 1.

Headers

string

required

A user session token. See Authentication page to learn more about the session token.

string

default:"ApiKey {your_api_key}"

required

API key from Dashboard. Expected format: ApiKey {your_api_key}. Must be used either QB-Token or Authorization.

Responses

200

A successful response

integer

array of objects

Show properties

object

Show properties

integer

string

integer

string

boolean

string

401

An error response

object

Show properties

array of strings

403

An error response

object

Show properties

array of strings

404

An error response

string

curl -X GET \
-H "QB-Token: a1e6b25b27ab3771a391b5c1173b572aed012bba" \
https://api.quickblox.com/users/by_full_name.json?full_name=Alex%20Miller

{
  "current_page": 1,
  "per_page": 10,
  "total_entries": 1,
  "items": [
    {
      "user": {
        "id": 96754523,
        "full_name": "Alex Miller",
        "email": "alex@gmail.com",
        "login": "Alex",
        "phone": "+3123555",
        "website": "https://mysite.com",
        "created_at": "2019-08-27T21:08:55Z",
        "updated_at": "2019-08-27T21:08:55Z",
        "last_request_at": null,
        "external_user_id": 126672,
        "facebook_id": "888766",
        "twitter_id": "982366",
        "blob_id": null,
        "custom_data": null,
        "age_over16": true,
        "allow_statistics_analysis": true,
        "allow_sales_activities": true,
        "parents_contacts": "",
        "user_tags": "android,web"
      }
    }
  ]
}

{
  "errors": {
    "base": [
      "Required session does not exist"
    ]
  }
}

{
  "errors": {
    "base": [
      "Users retrieving forbidden in admin panel, application settings. Setup it here https://admin.quickblox.com/apps/{app_id}/service/users/settings"
    ]
  }
}

{
  "code": null,
  "message": "Couldn't find user"
}

List Users List Users by Tags

⌘I

​Recipes

​Query Parameters

​Headers

​Responses

Recipes

Query Parameters

Headers

Responses