Skip to content

List license devices

Pages the devices one of the customer's licenses counts, latest activated first, with those freed or gone inactive.

Needs the read scope.

Pages its answer: pass the cursor back for the next page, at most 100 items a page.

Filters: status (eq, in).

Sorts: activated, last_seen.

Call

  • Tool: list_license_activations
  • Scope: read
  • Reads only.
  • Acts on a store.

Arguments

Name Type Required Description
product object Yes
license object Yes
query object No
{
  "type": "object",
  "properties": {
    "product": {
      "anyOf": [
        {
          "type": "object",
          "properties": {
            "id": {
              "type": "string",
              "minLength": 1,
              "maxLength": 512
            }
          },
          "required": [
            "id"
          ],
          "additionalProperties": false
        },
        {
          "type": "object",
          "properties": {
            "slug": {
              "type": "string",
              "minLength": 1,
              "maxLength": 512
            }
          },
          "required": [
            "slug"
          ],
          "additionalProperties": false
        }
      ]
    },
    "license": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "minLength": 1,
          "maxLength": 512
        }
      },
      "required": [
        "id"
      ],
      "additionalProperties": false
    },
    "query": {
      "type": "object",
      "properties": {
        "filter": {
          "type": "object",
          "properties": {
            "status": {
              "anyOf": [
                {
                  "type": "string",
                  "enum": [
                    "active",
                    "inactive",
                    "deactivated"
                  ]
                },
                {
                  "type": "object",
                  "properties": {
                    "eq": {
                      "type": "string",
                      "enum": [
                        "active",
                        "inactive",
                        "deactivated"
                      ]
                    },
                    "in": {
                      "type": "array",
                      "items": {
                        "type": "string",
                        "enum": [
                          "active",
                          "inactive",
                          "deactivated"
                        ]
                      },
                      "minItems": 1,
                      "maxItems": 50
                    }
                  },
                  "minProperties": 1,
                  "additionalProperties": false
                }
              ]
            }
          },
          "additionalProperties": false
        },
        "sort": {
          "type": "object",
          "properties": {
            "name": {
              "type": "string",
              "enum": [
                "activated",
                "last_seen"
              ]
            },
            "direction": {
              "type": "string",
              "enum": [
                "asc",
                "desc"
              ]
            }
          },
          "additionalProperties": false
        },
        "limit": {
          "type": "integer",
          "minimum": 1,
          "maximum": 100
        },
        "cursor": {
          "type": "string",
          "maxLength": 8192
        },
        "count": {
          "type": "boolean"
        }
      },
      "additionalProperties": false
    }
  },
  "required": [
    "product",
    "license"
  ],
  "additionalProperties": false
}

Answer

Name Type Required Description
total number No
items array of object Yes
cursor string or null Yes

The answer’s full shape is on its API reference page.

Type to search…

↑↓ navigate↵ selectEsc close