Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
curl --request POST \
--url https://api.iklim.co/v1/users/page \
--header 'Content-Type: application/json' \
--data @- <<EOF
{
"roles": "['API_USER', 'STANDARD_USER']",
"status": "['INACTIVE', 'BLOCKED', 'EXPIRED']",
"sortBy": {
"username": "asc",
"status": "desc"
},
"pageNumber": 0,
"pageSize": 10,
"includeAccount": false
}
EOFimport requests
url = "https://api.iklim.co/v1/users/page"
payload = {
"roles": "['API_USER', 'STANDARD_USER']",
"status": "['INACTIVE', 'BLOCKED', 'EXPIRED']",
"sortBy": {
"username": "asc",
"status": "desc"
},
"pageNumber": 0,
"pageSize": 10,
"includeAccount": False
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
roles: '[\'API_USER\', \'STANDARD_USER\']',
status: '[\'INACTIVE\', \'BLOCKED\', \'EXPIRED\']',
sortBy: {username: 'asc', status: 'desc'},
pageNumber: 0,
pageSize: 10,
includeAccount: false
})
};
fetch('https://api.iklim.co/v1/users/page', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.iklim.co/v1/users/page",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'roles' => '[\'API_USER\', \'STANDARD_USER\']',
'status' => '[\'INACTIVE\', \'BLOCKED\', \'EXPIRED\']',
'sortBy' => [
'username' => 'asc',
'status' => 'desc'
],
'pageNumber' => 0,
'pageSize' => 10,
'includeAccount' => false
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.iklim.co/v1/users/page"
payload := strings.NewReader("{\n \"roles\": \"['API_USER', 'STANDARD_USER']\",\n \"status\": \"['INACTIVE', 'BLOCKED', 'EXPIRED']\",\n \"sortBy\": {\n \"username\": \"asc\",\n \"status\": \"desc\"\n },\n \"pageNumber\": 0,\n \"pageSize\": 10,\n \"includeAccount\": false\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.iklim.co/v1/users/page")
.header("Content-Type", "application/json")
.body("{\n \"roles\": \"['API_USER', 'STANDARD_USER']\",\n \"status\": \"['INACTIVE', 'BLOCKED', 'EXPIRED']\",\n \"sortBy\": {\n \"username\": \"asc\",\n \"status\": \"desc\"\n },\n \"pageNumber\": 0,\n \"pageSize\": 10,\n \"includeAccount\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.iklim.co/v1/users/page")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"roles\": \"['API_USER', 'STANDARD_USER']\",\n \"status\": \"['INACTIVE', 'BLOCKED', 'EXPIRED']\",\n \"sortBy\": {\n \"username\": \"asc\",\n \"status\": \"desc\"\n },\n \"pageNumber\": 0,\n \"pageSize\": 10,\n \"includeAccount\": false\n}"
response = http.request(request)
puts response.read_bodyCan only be used by users with the ADMIN role. Retrieves registered users in the system pageably according to the given filter and sorting options
curl --request POST \
--url https://api.iklim.co/v1/users/page \
--header 'Content-Type: application/json' \
--data @- <<EOF
{
"roles": "['API_USER', 'STANDARD_USER']",
"status": "['INACTIVE', 'BLOCKED', 'EXPIRED']",
"sortBy": {
"username": "asc",
"status": "desc"
},
"pageNumber": 0,
"pageSize": 10,
"includeAccount": false
}
EOFimport requests
url = "https://api.iklim.co/v1/users/page"
payload = {
"roles": "['API_USER', 'STANDARD_USER']",
"status": "['INACTIVE', 'BLOCKED', 'EXPIRED']",
"sortBy": {
"username": "asc",
"status": "desc"
},
"pageNumber": 0,
"pageSize": 10,
"includeAccount": False
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
roles: '[\'API_USER\', \'STANDARD_USER\']',
status: '[\'INACTIVE\', \'BLOCKED\', \'EXPIRED\']',
sortBy: {username: 'asc', status: 'desc'},
pageNumber: 0,
pageSize: 10,
includeAccount: false
})
};
fetch('https://api.iklim.co/v1/users/page', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.iklim.co/v1/users/page",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'roles' => '[\'API_USER\', \'STANDARD_USER\']',
'status' => '[\'INACTIVE\', \'BLOCKED\', \'EXPIRED\']',
'sortBy' => [
'username' => 'asc',
'status' => 'desc'
],
'pageNumber' => 0,
'pageSize' => 10,
'includeAccount' => false
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.iklim.co/v1/users/page"
payload := strings.NewReader("{\n \"roles\": \"['API_USER', 'STANDARD_USER']\",\n \"status\": \"['INACTIVE', 'BLOCKED', 'EXPIRED']\",\n \"sortBy\": {\n \"username\": \"asc\",\n \"status\": \"desc\"\n },\n \"pageNumber\": 0,\n \"pageSize\": 10,\n \"includeAccount\": false\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.iklim.co/v1/users/page")
.header("Content-Type", "application/json")
.body("{\n \"roles\": \"['API_USER', 'STANDARD_USER']\",\n \"status\": \"['INACTIVE', 'BLOCKED', 'EXPIRED']\",\n \"sortBy\": {\n \"username\": \"asc\",\n \"status\": \"desc\"\n },\n \"pageNumber\": 0,\n \"pageSize\": 10,\n \"includeAccount\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.iklim.co/v1/users/page")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"roles\": \"['API_USER', 'STANDARD_USER']\",\n \"status\": \"['INACTIVE', 'BLOCKED', 'EXPIRED']\",\n \"sortBy\": {\n \"username\": \"asc\",\n \"status\": \"desc\"\n },\n \"pageNumber\": 0,\n \"pageSize\": 10,\n \"includeAccount\": false\n}"
response = http.request(request)
puts response.read_bodyUser Roles Filter
{msg:swagger.schema.users.page-request.roles}
GUEST, API_USER, STANDARD_USER, POWER_USER, EXTENDED_USER, ADMIN "['API_USER', 'STANDARD_USER']"
User Statuses Filter
{msg:swagger.schema.users.page-request.status}
INACTIVE, ACTIVE, EXPIRED, BLOCKED, DELETED "['INACTIVE', 'BLOCKED', 'EXPIRED']"
Result Sorting Fields and Directions
Show child attributes
{ "username": "asc", "status": "desc" }
Page Number
x >= 00
Number of Records in the Page
1 <= x <= 10010
Include Account Details Flag
false