Skip to main content
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"
      }
    }
  ]
}

Recipes

1

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

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

full_name
string
required
User’s full name. Min 3 characters.
page
integer
default:"1"
Page of results to return.
per_page
integer
default:"10"
Number of records to return in one request. Min: 1.

Headers

QB-Token
string
required
A user session token. See Authentication page to learn more about the session token.
Authorization
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

A successful response
current_page
integer
per_page
integer
total_entries
integer
items
array of objects
An error response
errors
object
An error response
errors
object
An error response
code
string
message
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"
      }
    }
  ]
}
I