List Licenses
Show all licenses the requesting manager has access permissions to.
URL: /api/v1/licenses/
Method: GET
Query Parameters
Ordering
order_by- Which attribute to order the list by.Default ordering is ascending. Make descending by prefixing the attribute name with
-.Example:
order_by=created_atExample:
order_by=-created_at
Pagination
Default pagination is 20 results per page.
limit- Number of results to return per page.Example:
limit=20
offset- The initial index from which to return the results.Example:
offset=21
The /api/v1/licenses/ endpoint has a maximum pagination limit of 100 items per request. If a higher value is specified, the API does not return an error; instead, the response is automatically capped at 100 items.
Exact Filter
license_keyactiveorder__store_idorder__customer_accountorder__customer_account__nameorder__customer_account__codecustomer_idcustomer_emailcustomer__accountcustomer__account__namecustomer__account__codecustomer__account__descriptioncustomer__account__phonecustomer__account__addresscustomer__account__emailcustomer__account__referenceproduct_idproduct_short_codeproduct_features__idproduct__authorization_methodlicense_users__idlicense_users__true_emaildevices__hostnamedevices__hardware_iddevices__ossubscription_idlicense_template_idlicense_template__codelicense_user_group
Icontains Filter
Matches records where the string value is a case-insensitive substring of the field.
license_key__icontainsorder__store_id__icontainsorder__customer_account__name__icontainsorder__customer_account__code__icontainscustomer_email__icontainscustomer_company_name__icontainscustomer_name__icontainscustomer__reference__icontainscustomer__account__name__icontainscustomer__account__code__icontainscustomer__account__description__icontainscustomer__account__phone__icontainscustomer__account__address__icontainscustomer__account__email__icontainscustomer__account__reference__icontainsproduct_name__icontainslicense_users__true_email__icontainsdevices__hostname__icontainsdevices__hardware_id__icontainsdevices__os__icontainslicense_template__code__icontainsnote__icontains
Startswith Filter
Matches records where the string value is a starting substring of the field.
license_key__startswithorder__store_id__startswith
In Filter
product_short_code__incustomer_label__in
Date & Time Filters
Comparators:
__gt— greater than__gte— greater than or equal__lt— less than__lte— less than or equal__date__gt,__date__gte,__date__lt,__date__lte— same comparisons but applied to the date portion only
These can be applied to the following fields:
validity_periodtime_activatedupdated_atcreated_at
Boolean filters
enabledis_any_floatingis_air_gappedis_bundlebundle_license__isnullis_trialhas_max_consumptionsis_hardware_key_authactivecustomer__account__isnull
Success Response
Code: 200 OK
Content Example:
Was this helpful?