---
title: "List license instances."
method: GET
path: "/v1/licenses/{id}/instances"
tags: ["Licenses"]
---

# List license instances.

`GET /v1/licenses/{id}/instances`

Retrieve a paginated list of instances (activations) for a license key. Use an instance id from this list to deactivate it via the deactivate endpoint.

## Path parameters

- `id` string, required

## Query parameters

- `page_number` number
- `page_size` number

## Response `200`

Successfully retrieved license instances

- LicenseInstanceListEntity
  - `items` LicenseInstanceEntity[], required — List of license instance items
    - `id` string, required — Unique identifier for the object.
    - `mode` 'test' | 'prod' | 'sandbox', required — String representing the environment.
    - `object` string, required — A string representing the object’s type. Objects of the same type share the same value.
    - `name` string, required — The name of the license instance.
    - `status` 'active' | 'deactivated', required — The status of the license instance.
    - `created_at` string, date-time, required — The creation date of the license instance.
  - `pagination` PaginationEntity, required
    - `total_records` number, required — Total number of records in the list
    - `total_pages` number, required — Total number of pages available
    - `current_page` number, required — The current page number
    - `next_page` number, nullable, required — The next page number, or null if there is no next page
    - `prev_page` number, nullable, required — The previous page number, or null if there is no previous page

## Other responses

- `400` — Bad Request - Invalid input parameters
- `401` — Unauthorized - Invalid or missing API key
- `404` — Not Found - Resource does not exist

---

[API](https://skmtc.net/creem/apis/creem-api.md) · [All operations](https://skmtc.net/creem/apis/creem-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/creem/creem-api/versions/aa593160d96c/schema)