Get Available Tags API

Require Authentication

This API is used to get available or used tags for the company based on combination of deviceID and token.

URL

api/manageassets/tags

Required parameter (POST)

deviceID
token

Optional parameter (GET)

All optional parameters use GET method. So it should be embedded in the URL, e.g: api/manageassets/tags?q=tag%20name&o=tags_text

q «contains keyword that want to be looked for. Keyword will search iconName field only»
o «used to sort data, contains field name. Available value: tags_text, total_pins. Default value: tags_text»
ot «used to sort data, contains sort type. Available value: asc, desc. Default value: asc»
per_page «indicates how many data that will be displayed in each call. Value must be a number between 1 to 500. Default value: 500»
offset «indicates the first data index that will be displayed in each call. Value must be a number with minimum value is 0. Default value: 0»

Example JSON Payload

{
	"deviceID": "ABCD-EFGH-IJKL-MNOP",
	"token": "bb602ab13b8090268cd6e3bb9dfa39e2"
}

Possible return HTTP status code

Return message

{
  "status": "success",
  "message": {
    "current_parameter": "?o=total_pins&ot=desc&per_page=500&offset=0",
    "next_parameter": "",
    "previous_parameter": "",
    "start": 0,
    "total": 4,
    "lists": [{
      "pinstagsID": 1,
      "tags_text": "tags",
      "companyID": 1,
      "total_pins": 1
    }, {
      "pinstagsID": 2,
      "tags_text": "tag",
      "companyID": 1,
      "total_pins": 0
    }, {
      "pinstagsID": 3,
      "tags_text": "ta",
      "companyID": 1,
      "total_pins": 0
    }, {
      "pinstagsID": 5,
      "tags_text": "tags api",
      "companyID": 1,
      "total_pins": 0
    }]
  }
}

Note: use "next_parameter" and "previous_parameter" to go to next or previous result page. Just combine it with the API URL, e.g: "api/manageassets/tags"+next_parameter or "api/manageassets/tags"+previous_parameter

Superfy Platform API Documentation