Search User

This endpoint performs user search.

info

The search results will include only users who follow the logged-in user. If the logged-in user has a role (e.g. moderator), the results will include the entire list of platform users.

HTTP Request

GET /api/v2/pm/search/?user={search}

Parameters

Name	In	Type	Required	Description
limit	query	integer	false	Number of results to return per page
offset	query	integer	false	The initial index from which to return the results
user	query	string	true	A search term. Search in fields: username, real_name

Example Request

JavaScript

const headers = {
  'Accept':'application/json',
  'Authorization: Bearer <token>'
};

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

Bash

# You can also use wget
curl -X GET /api/v2/pm/search/?user={search} \
  -H 'Accept: application/json'
  -H "Authorization: Bearer <token>"

Responses

Status	Meaning	Description	Schema
200	OK	Response status code	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» count	integer	false	none	Total results count
» next	string(uri)¦null	false	none	Next page url
» previous	string(uri)¦null	false	none	Previous page url
» results	list(User)	false	none	List of results

Example responses

200

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