---
title: "List licenses"
description: "Pages the customer's licenses of a software product, the live one and the ones it replaced, newest first, each with its key and status."
---

> Documentation Index
> Fetch the complete documentation index at: https://docs.sherpo.io/llms.txt
> Use this file to discover all available pages before exploring further.

# List licenses

Needs the read scope.

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

Sorts: created.

## Call

- Tool: `list_licenses`
- Scope: `read`
- Reads only.
- Acts on a store.

## Arguments

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `product` | `object` | Yes | The software product whose licenses to list. |
| `query` | `object` | No |  |

```json
{
  "type": "object",
  "properties": {
    "product": {
      "description": "The software product whose licenses to list.",
      "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
        }
      ]
    },
    "query": {
      "type": "object",
      "properties": {
        "filter": {
          "type": "object",
          "properties": {},
          "additionalProperties": false
        },
        "sort": {
          "type": "object",
          "properties": {
            "name": {
              "type": "string",
              "enum": [
                "created"
              ]
            },
            "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"
  ],
  "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](/customer-api/reference/list-licenses).

Source: https://docs.sherpo.io/customer-mcp/tools/list_licenses/index.mdx
