Get List User

Developing

GET

/v1/users

Request Example

Shell

JavaScript

Java

Swift

curl --location -g --request GET '/v1/users?page=1&per_page=5&sort=fullname&order=DESC&search=example&role_id={{$string.uuid}}&status_pu=&is_active={{$datatype.boolean}}&is_email_verified={{$datatype.boolean}}&type'

Response Example

{
    "message": "Sukses mengambil data list user",
    "data": {
        "items": [
            {
                "id": "99c49e3f-6570-4554-b36b-3aee5f963b79",
                "fullname": "USER QWERY",
                "type": "tenant",
                "email": "qwerty@example.com",
                "type_label": "Tenan",
                "role_id": "19209eff-6d21-4a95-9f1c-118835d9f009",
                "role_key": "operasional_tenan",
                "role_name": "Operasional Tenan",
                "company_name": "PT Example Company",
                "status_pu": "registered",
                "is_active": true,
                "is_email_verified": false
            },
            {
                "id": "c7c7f4c6-9b7d-419e-8ee4-cee51b864d2a",
                "fullname": "Smith Johnson 23",
                "type": "internal",
                "email": "smith23@example.com",
                "type_label": "Internal",
                "role_id": "6a57bd4f-4e48-4892-877f-4149f5e4fe35",
                "role_key": "administrator_internal",
                "role_name": "Administrator Internal",
                "company_name": "PT Internal Services",
                "status_pu": "registered",
                "is_active": true,
                "is_email_verified": false
            },
            {
                "id": "56173282-07d5-4305-a614-18ceebdecd32",
                "fullname": "user abc",
                "type": "tenant",
                "email": "user1sd@example.com",
                "type_label": "Tenan",
                "role_id": "19209eff-6d21-4a95-9f1c-118835d9f009",
                "role_key": "operasional_tenan",
                "role_name": "Operasional Tenan",
                "company_name": "PT Example Company",
                "status_pu": "registered",
                "is_active": true,
                "is_email_verified": false
            },
            {
                "id": "51eb6b14-06f0-4928-bf59-458adead1ced",
                "fullname": "User Ops 121",
                "type": "tenant",
                "email": "ops121@mail.com",
                "type_label": "Tenan",
                "role_id": "19209eff-6d21-4a95-9f1c-118835d9f009",
                "role_key": "operasional_tenan",
                "role_name": "Operasional Tenan",
                "company_name": "PT Example Company",
                "status_pu": "registered",
                "is_active": true,
                "is_email_verified": false
            },
            {
                "id": "f1a50e71-e2a8-4694-9fa2-e67f6286aed4",
                "fullname": "User Ops 55",
                "type": "tenant",
                "email": "ops55@mail.com",
                "type_label": "Tenan",
                "role_id": "19209eff-6d21-4a95-9f1c-118835d9f009",
                "role_key": "operasional_tenan",
                "role_name": "Operasional Tenan",
                "company_name": "PT Example Company",
                "status_pu": "registered",
                "is_active": true,
                "is_email_verified": false
            }
        ],
        "meta": {
            "page": 1,
            "total": 9,
            "per_page": 5,
            "total_page": 2
        }
    }
}

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Query Params

page

number

optional

Example:

per_page

number

optional

Example:

sort

string

optional

Example:

fullname

order

string

optional

ASC | DESC

Example:

DESC

string

optional

Example:

example

role_id

string

optional

Example:

status_pu

string

optional

registered | not_registered

is_active

boolean

optional

Example:

is_email_verified

boolean

optional

Example:

type

string

optional

internal | tenant | customer

Responses

🟢200Success

application/json

Body

message

string

required

data

object

required

items

array [object {12}]

required