API reference Licenses List licenses

List licenses

GET methodhttps://api.anyshop.io/v1/licenses

Licenses in your API key's mode, newest first, each key masked.

Scope licenses:read

Query parameters

limitinteger How many to return: 1 to 100, default 201 to 100
starting_afterstring The last ID of the previous page; the next page starts after itUp to 64 characters
orderstring Only the licenses sold in this orderUp to 64 characters
productstring Only the licenses of this productUp to 64 characters

Example

as_live_ or as_test_

curl https://api.anyshop.io/v1/licenses \
  -H "Authorization: Bearer $ANYSHOP_API_KEY"

{
  "object": "list",
  "data": [
    {
      "object": "license",
      "id": "lic_01m3rv2f8k1q7w3e5r9t0y4u6i",
      "livemode": false,
      "status": "active",
      "key_masked": "PXF-••••-••••-7Q2M",
      "product": {
        "id": "prod_01m3rr5kmbeb2s18x1kpntjxqb",
        "name": "Pixelforge Studio"
      },
      "order": "ord_01m3rt5x2c7q9f0a4d6k8h1n3p",
      "devices": {
        "used": 1,
        "limit": 2
      },
      "expires_at": "2026-10-02T14:21:07.000Z",
      "updates_until": "2026-10-02T14:21:07.000Z",
      "last_checked_at": "2026-10-02T14:21:07.000Z",
      "created_at": "2026-10-02T14:21:07.000Z",
      "activations": [
        {
          "id": "lact_01m3rv4k2m6p8r0t2v4x6z8b0d",
          "name": "Studio Mac",
          "platform": "macOS",
          "activated_at": "2026-10-02T14:21:07.000Z",
          "last_seen_at": "2026-10-02T14:21:07.000Z"
        }
      ]
    }
  ],
  "has_more": false
}

The IDs and keys in these examples are made up. Every schema is in the OpenAPI document, served at https://api.anyshop.io/v1/openapi.json.

Returns

A list of license objects, newest first: { "object": "list", "data", "has_more" }.

Errors

Status and error.type

400invalid_requestThe request is not valid; error.param names the field
401authenticationNo API key, or it is not valid
403permissionThe key does not have the scope this needs, it is a test key where only a live key may act (the catalog), or the store is suspended (store_suspended)
404not_foundNot found in the key's store and mode
409conflictConflicts with the object's state (type conflict), or an Idempotency-Key reused for another request (type idempotency, code idempotency_key_reused)
429rate_limitedToo many requests; see Retry-After