Getting a list of tags
| Method | get.tags |
|---|---|
| Description | Getting a list of tags |
| Available to | Partner, Client |
Request parameters
| Title | Type | Required | Description |
|---|---|---|---|
access_token |
string | yes | Authentication session key |
user_id |
number | no | Unique user identifier of the client agent on behalf of which the request is made Is required for the agentTo obtain a list of client users, you must use the method "get.customer_users" |
limit |
number | no | Number of records returned. See section "Paging" |
offset |
number | no | Shift determines from which record number to return "limit" records. Default is "0". See section "Paging" |
filter |
object | no | See section "Filtering criteria" |
fields |
array | no | See section "View of returned data" |
sort |
array | no | See section "Sorting data" |
Response parameters
| Title | Type | Filtering | Sorting | Description |
|---|---|---|---|---|
id |
number | yes | Unique tag identifier | |
name |
string | yes | yes | Tag name |
is_system |
boolean | yes | yes | A sign that the tag is systemic and cannot be deleted |
JSON request structure```json
{ "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 response structure```json
{
"jsonrpc":"2.0",
"id":"number",
"result":{
"metadata":{
},
"data":[
{
"id":"number",
"name":"string",
"is_system":"boolean"
}
]
}
}
List of returned errors
See the section "List of errors for methods with the verb get"