Get tags

Getting a list of tags

Method	get.tags
Description	Getting a list of tags
Who has access	Partner, Customer

Parameters of a request

Title	Type	Required	Description
access_token	string	yes	Authentication session key
user_id	number	no	Unique ID of an agent's customer user who makes request Is required for agent To access a list of customer users, use the method "get.customer_users"
limit	number	no	Returning entries count. Refer to "Paging"
offset	number	no	Offset that defines from which number to return the entries "limit". Default value is "0". Refer to "Paging"
filter	object	no	Refer to "Filters"
fields	array	no	Refer to "Viewing returning data"
sort	array	no	Refer to "Data sorting"

Parameters of a reply

Title	Type	Filtering	Sorting	Description
id	number	yes		Tag unique ID
name	string	yes	yes	Tag name
is_system	boolean			Sign of a system tag that cannot be deleted

JSON request structure

{
  "jsonrpc":"2.0",
  "id":"number",
  "method":"get.tags",
  "params":{
    "access_token":"string",
    "user_id":"number",
    "offset":"number",
    "limit":"number",
    "filter":{

    },
    "sort":[
      {
        "field":"string",
        "order":"string"
      }
    ],
    "fields":[
      "string"
    ]
  }
}

JSON reply structure

{
  "jsonrpc":"2.0",
  "id":"number",
  "result":{
    "metadata":{

    },
    "data":[
      {
        "id":"number",
        "name":"string",
        "is_system":"boolean"
      }
    ]
  }
}

List of returning errors

Refer to the section "List of errors for the methods with the verb get"