Search users

Get list of users, you can apply filters using the 'username' or 'email' parameters. Please note that at least one of these parameters must be provided in order to receive any results.

Query Parameters

username string

search using username

email string

search using email

client_auth_token string required

Client API token

Responses

• 200
• 403
• 500

---

Users list, respose will have user id and username or email

application/json

Schema

Example (from schema)

Example 1

Example 2

---

Schema

items object[]
Array [
id integer
User Id.
username string
Username.
]

{
  "items": [
    {
      "id": 0,
      "username": "string"
    }
  ]
}

{
  "items": [
    {
      "id": 1885,
      "username": "naveed"
    }
  ]
}

{
  "items": [
    {
      "id": 1885,
      "email": "naveedahmada0362gmail.com"
    }
  ]
}

Forbidden, api key is missing or invalid

application/json

Schema

Example (from schema)

Example 1

---

Schema

success boolean

Default value: false

message string
status integer

Default value: 401

{
  "success": false,
  "message": "string",
  "status": 401
}

{
  "success": false,
  "message": "You don't have permission!"
}

Internal server error, api will respond with 500 if something went wrong processing the request.

application/json

Schema

Example (from schema)

---

Schema

success boolean required

Default value: false

message string required

Default value: internal server error

error message

{
  "success": false,
  "message": "internal server error"
}

Loading...