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
{
  "users": [
    {
      "userId": "8e94a551-5b86-40ba-ae55-b019dee5cc25",
      "username": "[email protected]",
      "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",
        "type": "INDIVIDUAL",
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z",
        "mobilePhoneNumber": "<string>",
        "location": "<string>",
        "company": "<string>",
        "industry": "<string>",
        "profilePictureUrl": "<string>",
        "subscriptionPlan": "NONE",
        "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