Get licenses

Gets the list of the licenses.

get

Query parameters

PackageIdstringOptional

The package id filter.

SubscriptionTypeIdstringOptional

The subscription type id filter.

LicenseCodestringOptional

The license code filter.

DescriptionstringOptional

The description filter.

IsUsedbooleanOptional

This is used to filter the license by used status.

StartDatestring · date-timeOptional

The start date filter.

EndDatestring · date-timeOptional

The end date filter.

TagsstringOptional

The tags filter.

Statusstring · enumOptional

This enum is used to map the status of License.

Possible values:

Typestring · enumOptional

This enum is used to check which type of delivery is used for the license.

Possible values:

UsedBystringOptional

The user who used the license. The value is code of the user.

UsedDatestring · date-timeOptional

The used date filter.

TestModebooleanOptional

The test mode filter.

KeywordsstringOptional

The keyword to filter.

CreatedUserIdstringOptional

The user who created the license. The value is code of the user.

SortDataFieldstringOptional

The sort data field to sort. By default, the value is ID.

SortOrderstring · enumOptional

Specifies the sorting order type for a collection.

Possible values:

PageNumberinteger · int32Optional

The page number of the pagination. Default value is 0.

PageSizeinteger · int32Optional

The page size of the pagination. Default value is 200.

Header parameters

Brand-URLstringRequired

The brand URL of the request. This is used to identify the brand.

Example: YOUR_BRAND_URL

Auth-KeystringRequired

Auth-Key is required to authenticate the request. If missing, the server will return 401 Unauthorized.

Example: YOUR_AUTH_KEY

Responses

200

The request was successful.

application/json

401

The user is not authorized to access the requested resource. The request is missing the required Auth-Key header.

application/json

429

API call exceeded rate limit due to too many requests.

application/json

get

HTTPcURLJavaScriptPython

GET /api/v1/licenses HTTP/1.1
Host: protocol.jframework.io
Brand-URL: text
Auth-Key: text
Accept: */*

{
  "success": true,
  "statusCode": 200,
  "message": "The request was successful.",
  "data": {
    "items": [
      {
        "id": "sApKpllz4sAplsmzha",
        "packageId": "sApKpllz4sAplsmzha",
        "subscriptionTypeId": "sApKpllz4sAplsmzha",
        "code": "JFWCODELICENSE",
        "type": "Normal",
        "amount": 1,
        "currencyCode": "USD",
        "description": "This is a trial license",
        "startDate": "2025-09-19T11:20:20.4223131+07:00",
        "endDate": "2025-10-19T11:20:20.4223138+07:00",
        "tags": "#tag1, #tag2",
        "status": "Active",
        "usedByUserId": "aPlasizhyPls",
        "usedDate": "2025-10-19T11:20:20.4223147+07:00",
        "testMode": false,
        "modifiedDate": "2025-09-19T11:20:20.4223156+07:00"
      }
    ],
    "totalItems": 1,
    "pageNumber": 0,
    "pageSize": 10
  },
  "errors": []
}