Get User ID
Endpoint Name: getuserid
Request type : POST
Authorization: Bearer token as header
Endpoint Details: The getuserid endpoint will be used to user id of a particular user.
Method
URL
POST
URL/access/klearstack/getuserid
Request Body
Parameters
Description
Required or Optional
username
Username of the user to be logged in
Required
company_name
Name of the company for which the user is logging in
Required
Shell
Request Body
curl -X POST "URL/access/klearstack/getuserid" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer your_token_here" \
-d '{
"username": "Replace_User_Name_Here",
"company_name": "Replace_Company_Name_Here"
}'
Python
Request Body
import requests
# API URL
url = "URL/access/klearstack/getuserid"
# Request payload
data= {
"username": "Replace_User_Name_Here",
"company_name": "Replace_Company_Name_Here"
}
# Headers
headers = {
"Content-Type": "application/json",
"Authorization": "Bearer your_token_here"
}
# Make the POST request
response = requests.post(url, data=data, headers=headers)
# Print the response
if response.status_code == 200:
print(response.json())
else:
print("Error:", response.text)
Java
Request Body
import okhttp3.*;
import java.io.IOException;
public class GetUserIDAPI {
public static void main(String[] args) {
OkHttpClient client = new OkHttpClient();
// JSON payload
String jsonPayload = "{ \"username\": \"Replace_User_Name_Here\", \"company_name\": \"Replace_Company_Name_Here\" }";
RequestBody body = RequestBody.create(
jsonPayload, MediaType.parse("application/json"));
Request request = new Request.Builder()
.url("URL/access/klearstack/getuserid")
.post(body)
.addHeader("Content-Type", "application/json")
.addHeader("Authorization", "Bearer your_token_here")
.build();
try (Response response = client.newCall(request).execute()) {
if (response.isSuccessful()) {
System.out.println("Response: " + response.body().string());
} else {
System.out.println("Error: " + response.body().string());
}
} catch (IOException e) {
e.printStackTrace();
}
}
}
Node.js
Request Body
const axios = require('axios');
const url = "URL/access/klearstack/getuserid";
const payload = {
username: "Replace_User_Name_Here",
company_name: "Replace_Company_Name_Here"
};
axios.post(url, payload, {
headers: {
"Content-Type": "application/json",
"Authorization": "Bearer your_token_here"
}
})
.then(response => console.log(response.data))
.catch(error => console.error("Error:", error.response ? error.response.data : error.message));
JavaScript (XMLHttpRequest)
Request Body
var payload = JSON.stringify({
username: "Replace_User_Name_Here",
company_name: "Replace_Company_Name_Here"
});
var xhr = new XMLHttpRequest();
xhr.open("POST", "URL/access/klearstack/getuserid", true);
xhr.setRequestHeader("Content-Type", "application/json");
xhr.setRequestHeader("Authorization", "Bearer your_token_here");
// Handle response
xhr.onreadystatechange = function () {
if (xhr.readyState === XMLHttpRequest.DONE) {
if (xhr.status === 200) {
console.log("Response:", xhr.responseText);
} else {
console.error("Error:", xhr.responseText);
}
}
};
// Send request
xhr.send(payload);
API Response
Status code
Example Response
200
{
"_id": "5ce90642bf184f25555b1244",
"release_version": “7.8.9”
}
500
One or Many Required parameters from company name must be missing, E.g error “Company Name”,
PreviousGet New Access Token Using Existing Refresh TokenNextUpload A Single Document And Get Batch ID
Last updated