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

Name	Type	Example	Required	Description
Authorization	string	access_token	YES	Token of authentication. Get from Authentication API
Accept	string	application/json	YES	Defines the message format that is expected by the client
Content-Type	string	application/json	YES	Defines the message format of the request body that is sent by the client

Parameter

Name	Type	Required	Location	Description
page	int	YES	query	Query for skip page of collection
pageSize	int	YES	query	Query for limit result data from server. Maximum value 100
isActive	bool	OPTIONAL	query	Filter user status active or inactive
employeeID	string	OPTIONAL	query	Filter user exact employee id
name	string	OPTIONAL	query	Filter user contains name
email	string	OPTIONAL	query	Filter user contains email
phone	string	OPTIONAL	query	Filter 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": "[email protected]",
                "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"
}

Find Users

Information #

Headers #

Parameter #

Example cURL Request #

Example Success Response #

Example Failed Response #

Information

Headers

Parameter

Example cURL Request

Example Success Response

Example Failed Response