Management API
License
List Licenses
5min
Show all licenses the requesting manager has access permissions to.
URL: /api/v1/licenses/
Method: GET
- order_by - Which attribute to order the list by.
- default ordering is ascending, can be made descending by prefixing the attribute name with -
- Example: order_by=created_at
- Example: order_by=-created_at
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 results can be filtered by various attributes on license or related to the license.
If available, additional suffixes can be appended to attributes which further define the filter:
- __startswith - string value is a starting substring of the attribute
- __icontains - string value is a substring of the attribute (case insensitive)
Possible filters:
- id__in - Comma separated list of ids.
- Example: id__in=1593781774572379,1597395059215709,1597395059216729
- license_key
- license_key__startswith
- license_key__icontains
- order__store_id
- order__store_id__startswith
- order__store_id__icontains
- company
- customer_id
- customer_email
- customer_email__icontains
- customer_company_name__icontains
- customer__reference__icontains
- customer_name__icontains
- product_id
- product_name__icontains
- note__icontains
- license_users__id
- license_users__true_email
- license_users__true_email__icontains
- product_features__id
- license_key__isnull
- is_any_floating
- validity_period__gt
- validity_period__gte
- validity_period__lt
- validity_period__lte
- time_activated__gt
- time_activated__gte
- time_activated__lt
- time_activated__lte
- time_activated__date__gt
- time_activated__date__gte
- time_activated__date__lt
- time_activated__date__lte
- updated_at__gt
- updated_at__gte
- updated_at__lt
- updated_at__lte
- updated_at__date__gt
- updated_at__date__gte
- updated_at__date__lt
- updated_at__date__lte
- enabled
- manager__true_email
- manager__true_email__icontains
- customer__account
- customer__account__name
- customer__account__name__icontains
- customer__account__code
- customer__account__code__icontains
- customer__account__description
- customer__account__description__icontains
- customer__account__phone
- customer__account__phone__icontains
- customer__account__address
- customer__account__address__icontains
- customer__account__email
- customer__account__email__icontains
- customer__account__reference
- customer__account__reference__icontains
- subscription_id
- devices__hostname
- devices__hostname__icontains
- devices__hardware_id
- metadata
Code: 200 OK
Content Examples:
Updated 23 Apr 2024
Did this page help you?