itemLabels Query

Description

Searches for item labels by term with pagination. Labels are typically used to categorize or tag items.

query itemLabels($term: String, $page: Int, $limit: Int) {
  itemLabels(term: $term, page: $page, limit: $limit) {
    labels {
      id
      name
    }
    pagination {
      limit
      count
      page
      pages
      hasMore
    }
  }
}

Variables

{
    "term": "term",
    "page": 1,
    "limit": 20
}

Response

{
    "itemLabels": {
        "labels": [
            {
                "id": 4310187029444,
                "name": "example"
            }
        ],
        "pagination": {
            "limit": 20,
            "count": 10,
            "page": 1,
            "pages": 1,
            "hasMore": true
        }
    }
}

Arguments

Name	Type	Description
term	String	Search term to match against label names.
page	Int	The requested page number. Defaults to 1 if not specified.
limit	Int	Number of labels per page. You can request a specific page size, and it will be used if it does not exceed the server-enforced maximum. If your requested size exceeds the maximum, the server will enforce the maximum limit.

Returns

ItemLabelsResult!