tags.query

Description

Query for list of tags.

Params

token

string

Access token.

filterOptions

struct

optional

Filtering options

userDefined

bool

optional

List user defined tags. If false, lists only system tags. If true, list only user's tags. If not specified, list both.

categories

array

optional

List only tags in given categories.

categoryId

string

ID of category.

onlyNonEmpty

bool

optional

default: true

Show only tags that has at least one xWG assigned.

displayOptions

struct

optional

Display options

limit

int

optional

default: 100

Maximum number of returned items. You can request at most 100 items at one method call.

offset

int

optional

default: 0

How many items to skip from start of result.

showItemCount

bool

optional

default: false

Show number of xWGs assigned to each tag.

Response

response

struct

status

int

enum

Status code

Value	Description
200	OK
400	Bad params
404	One of category from filterOptions.categories was not found.
500	Server error

statusMessage

string

Status code description

tags

array

tag

struct

name

string

Name of tag

categories

array

optional

List of categories this tag is member of. If tag is user defined, this field is missing.

category

struct

Category information

id

string

Category identifier

name

string

Name of category

itemCount

int

optional

Number of xWGs that has this tag assigned.

totalCount

int

Total number of entrys without affected by offset and limit.

Call example