Find Tags

This end point is use for get list of tags

[GET] /ruangkerja/tags

Information

This API is a function for retrieves a list of tags 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
namestringOPTIONALqueryFilter tag contains name

Example cURL Request

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

Example Success Response

{
    "status": "success",
    "message": "Success",
    "data": {
        "currentPage": 1,
        "totalItems": 100,
        "totalPage": 10,
        "items": [
            ...,
            {
                "name": "Training User Batch 1",
                "serial": "RUKRTAG-9WHL0JGP"
            },
            {
                "name": "Training User Batch 2",
                "serial": "RUKRTAG-1YBLYP4J"
            }
        ]
    }
}

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.