Get User Data

Get User Data

Purpose

To get the user/Location of your Organization.

User API accept post request with filter conditions. Response include filter users array with matching conditions.

API return JSON array of users.

Request URL

https://live.membroz.com/api/users/filter

Request Method

POST
Note
  • Send authkey in https header
  • You must use only Field API names in the input. You can obtain the field API names from Fields metadata API
  • Enterprise customer can replace domain name with their hosting Url. for example https://app.xyz.com/api/users
  • API will return matching records in array or error message.

Request JSON

Attribute Data Type Mandatory Description
search Array yes Add search fields to filter out return data.
Example: { "search":[{ "searchfield": "status", "searchvalue": "active", "criteria": "eq", "datattype": "text" }]}
Only status = "active" records will return
select Array Add select fields to restrict return data schema.
Example: Example: { "fieldname": "branchname", "value": 1 }
Only branchname will return
sort object Sort return array based on sort input
Example: { "branchname" : 1}
limit number limit return array size
Example: limit: 10
only 10 records will return in the array

Sample Request

curl --location --request POST 'https://live.membroz.com/api/users/filter' \
--header 'authkey:  XXXXXXX' \
--header 'Content-Type: application/json' \
--data-raw '{ 
    "search": [
        { "searchfield": "status", "searchvalue": "active", "criteria": "eq", "datatype": "text" }
    ]
}'
OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{ \r\n    \"search\": [\r\n        { \"searchfield\": \"status\", \"searchvalue\": \"active\", \"criteria\": \"eq\", \"datatype\": \"text\" }\r\n    ]\r\n}");
Request request = new Request.Builder()
  .url("https://live.membroz.com/api/users/filter")
  .method("POST", body)
  .addHeader("authkey", " XXXXXXX ")
  .addHeader("Content-Type", "application/json")
  .build();
Response response = client.newCall(request).execute();
 "https://live.membroz.com/api/users/filter",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS =>"{ \r\n    \"search\": [\r\n        { \"searchfield\": \"status\", \"searchvalue\": \"active\", \"criteria\": \"eq\", \"datatype\": \"text\" }\r\n    ]\r\n}",
  CURLOPT_HTTPHEADER => array(
    "authkey:  XXXXXXX ",
    "Content-Type: application/json"
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

import requests

url = "https://live.membroz.com/api/users/filter"

payload = "{ \r\n    \"search\": [\r\n        { \"searchfield\": \"status\", \"searchvalue\": \"active\", \"criteria\": \"eq\", \"datatype\": \"text\" }\r\n    ]\r\n}"
headers = {
  'authkey': ' XXXXXXX' ,
  'Content-Type': 'application/json'
}

response = requests.request("POST", url, headers=headers, data = payload)

print(response.text.encode('utf8'))

  'Content-Type': 'application/json'
}

response = requests.request("GET", url, headers=headers, data = payload)

print(response.text.encode('utf8'))

require "uri"
require "net/http"

url = URI("https://live.membroz.com/api/users/filter")

https = Net::HTTP.new(url.host, url.port);
https.use_ssl = true

request = Net::HTTP::Post.new(url)
request["authkey"] = " XXXXXXX "
request["Content-Type"] = "application/json"
request.body = "{ \r\n    \"search\": [\r\n        { \"searchfield\": \"status\", \"searchvalue\": \"active\", \"criteria\": \"eq\", \"datatype\": \"text\" }\r\n    ]\r\n}"

response = https.request(request)
puts response.read_body

var client = new RestClient("https://live.membroz.com/api/users/filter");
client.Timeout = -1;
var request = new RestRequest(Method.POST);
request.AddHeader("authkey", " XXXXXXX ");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{ \r\n    \"search\": [\r\n        { \"searchfield\": \"status\", \"searchvalue\": \"active\", \"criteria\": \"eq\", \"datatype\": \"text\" }\r\n    ]\r\n}",  ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Possible Errors

HTTP Status Error Code Message Reason
permission denied 403 You do not have permission

Sample Response

    {
        "_id": "5f5b8aede1012425ecacbadd",
        "isfirstlogin": false,
        "status": "active",
        "username": "cmgouveia@outlook.com.br",
        "password": "$2a$10$xgC8U/2boCMGcCYnNB4Xg.r96lTz4dF.1rXiPnvsXbXFkYi9DQV3y",
        "role": "5eafc58fcf26f78f43ab6c6e",
        "anroiddevices": [],
        "iosdevices": [],
        "designationid":"5eafc410680347432840e941",
    "addedby": "5e954c7b9df11624f81e785b",
        "property": {
            "fullname": "Trainer for Yoga - KHUSHI UPDATED",
            "email": "cmgouveia@outlook.com.br",
            "mobile_number": "08758363925",
            "date_of_birth": null,
            "address": "B1/402, Silver residency, Hanuman Sheri",
            "joining_date": null,
            "salary": null,
            "publicview": "no",
            "role": "5eafc58fcf26f78f43ab6c6e",
            "designationid": "5eafc410680347432840e941"
        },
        "createdAt": "2020-09-11T14:34:21.613Z",
        "updatedAt": "2020-09-16T05:10:07.210Z",
        "fullname": "Trainer for Yoga - KHUSHI UPDATED ",
        "namenumber": "Trainer for Yoga - KHUSHI UPDATED  | 08758363925",
        "updatedby": "5e954c7b9df11624f81e785b"
    },
}