Find Users

This end point is use for get list of users

[GET] /ruangkerja/users

Information

This API is a function for retrieves a list of users in your organization.

Headers

NameTypeExampleRequiredDescription
Authorizationstringaccess_tokenYESToken of authentication. Get from Authentication API
Acceptstringapplication/jsonYESDefines the message format that is expected by the client
Content-Typestringapplication/jsonYESDefines the message format of the request body that is sent by the client

Parameter

NameTypeRequiredLocationDescription
pageintYESqueryQuery for skip page of collection
pageSizeintYESqueryQuery for limit result data from server. Maximum value 100
isActiveboolOPTIONALqueryFilter user status active or inactive
employeeIDstringOPTIONALqueryFilter user exact employee id
namestringOPTIONALqueryFilter user contains name
emailstringOPTIONALqueryFilter user contains email
phonestringOPTIONALqueryFilter user contains phone

Example cURL Request

curl --location --request GET 'https://api.ruangkerja.id/ruangkerja/users?page=1&pageSize=10' \
--header 'Authorization: access_token'

Example Success Response

{
    "status": "success",
    "message": "Success",
    "data": {
        "currentPage": 1,
        "totalItems": 100,
        "totalPage": 10,
        "items": [
            ...,
            {
                "employeeID": "EMPLY001",
                "name": "John Doe",
                "username": "johndoe",
                "email": "john.doe@example.com",
                "phone": "6281122334455",
                "isActive": true,
                "companyName": "PT Ruang Raya Indonesia",
                "companySerial": "CMP-RUANGGURU",
                "organizationDisplayName": "Ruangkerja",
                "organizationLevelSerial": "CMP-RUANGKERJA",
                "tags": [
                    {
                        "serial": "TAG-SERIAL-01",
                        "name": "Example Tag"
                    }
                ]
            }
        ]
    }
}

Example Failed Response

{
    "errorCode": 123,
    "message": "rpc error: code = PermissionDenied desc = Token is not valid",
    "detail": "rpc error: code = PermissionDenied desc = Token is not valid"
}

See also: Error Dictionary.