Skip to main content

Search a specific account

This endpoint allows to perform a specific account search.

info

This operation requires authentication and admin role.

HTTP Request

GET /api/v2/account/search/

Parameters

NameInTypeRequiredDescription
usernamequerystringfalseThe username of the user
emailquerystringfalseThe email of the user
ext_idquerystringfalseA unique external id identifying the user
providerquerystringfalseThe external provider of the ext_id
info

You can pass in the query only one between: username, email or the pair ext_id and provider

info

If you are using a custom provider you can pass 'external' as provider parameter.

Example Request


const headers = {
'Accept':'application/json',
'Authorization': 'Bearer {access_token}'
};

fetch('/api/v2/account/search/',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});

Responses

StatusMeaningDescriptionSchema
200OKResponse status codeUser
info

It will return status code 200 if the user is found. If not found it will return 404. If too many parameters or too few parameters are passed it will return 400.

Example responses

{
"id": "integer",
"username": "string",
"real_name": "string",
"avatar": "string",
"followings_counter": "integer",
"followers_counter": "integer",
"posts_counter": "integer",
"discussions_counter": "integer",
"polls_counter": "integer",
"categories_counter": "integer",
"email": "string",
"email_isvalid": "boolean",
"date_joined": "string",
"bio": "string",
"location": "string",
"location_lat_lng": "string",
"position_lat_lng": "string",
"date_of_birth": "string",
"description": "string",
"gender": "string",
"status": "string",
"website": "string",
"cover": "string",
"tags": [{Tag}],
"ext_id": "integer",
"reputation": "integer",
"community_badge": "boolean",
"reg_approved": "boolean",
"deleted" : "boolean",
"company_name": "string",
"company_role": "string"
}