Skip to main content
POST
/
v1
/
users
/
page
Pageable User Listing Operation
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
}
EOF
import 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_body
{ "users": [ { "userId": "8e94a551-5b86-40ba-ae55-b019dee5cc25", "username": "name@domain.com", "firstName": "John", "lastName": "Doe", "locale": "tr_TR", "timezone": "Europe/Istanbul", "roles": "API_USER", "status": "INACTIVE", "midName": "Bob", "account": { "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "userId": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "createdAt": "2023-11-07T05:31:56Z", "updatedAt": "2023-11-07T05:31:56Z", "mobilePhoneNumber": "<string>", "location": "<string>", "company": "<string>", "industry": "<string>", "profilePictureUrl": "<string>", "emailVerified": true, "mobilePhoneNumberVerified": true } } ], "totalRecords": 123, "pageNumber": 123, "pageSize": 123 }

Body

application/json
roles
enum<string>[]

User Roles Filter

{msg:swagger.schema.users.page-request.roles}

Available options:
GUEST,
API_USER,
STANDARD_USER,
POWER_USER,
EXTENDED_USER,
ADMIN
Example:

"['API_USER', 'STANDARD_USER']"

status
enum<string>[]

User Statuses Filter

{msg:swagger.schema.users.page-request.status}

Available options:
INACTIVE,
ACTIVE,
EXPIRED,
BLOCKED,
DELETED
Example:

"['INACTIVE', 'BLOCKED', 'EXPIRED']"

sortBy
object

Result Sorting Fields and Directions

Example:
{ "username": "asc", "status": "desc" }
pageNumber
integer<int32>

Page Number

Required range: x >= 0
Example:

0

pageSize
integer<int32>

Number of Records in the Page

Required range: 1 <= x <= 100
Example:

10

includeAccount
boolean

Include Account Details Flag

Example:

false

Response

Successful User Listing

users
object[]

User List on the Page

totalRecords
integer<int32>

Total Number of Users

pageNumber
integer<int32>

Page Number

pageSize
integer<int32>

Number of Records in the Page