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, can be made descending by prefixing the attribute name with example order by=created at example 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 filtering 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 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 product short code 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 order customer account order customer account name order customer account name icontains order customer account code order customer account code icontains subscription id devices hostname devices hostname icontains devices hardware id metadata created at lte created at gte created at lt created at gt product short code in is trial has max consumptions license type license template code license template code icontains is bundle success response code 200 ok content examples { "count" 54, "next" "http //saas licensespring com/api/v1/licenses/?limit=20\&offset=20", "previous" null, "results" \[ { "id" 1593781720493289, "status" "inactive", "floating in use devices" 0, "customer" { "id" 620, "total orders" 14, "total licenses" 45, "labels" \[ { "id" 3, "label id" 8, "label" "customer", "color" "#ff9f43" }, { "id" 53, "label id" 34, "label" "loyal", "color" "#3a0cd4" } ], "email" "tc\@tc com", "first name" "", "last name" "", "company name" "", "phone" "", "reference" "", "address" "", "postcode" "", "city" "", "country" "", "state" "", "clabels all" "customerloyal", "cognito user pool id" "", "metadata" {}, "company" 277, "license user" null, "clabels" \[ 8, 34 ] }, "product features" \[ { "id" 1596179495925542, "product feature" { "id" 173, "created at" "2020 09 14t11 17 43z", "updated at" "2020 09 14t11 17 43z", "name" "feature 3", "code" "f3", "is deleted" false, "feature type" "consumption", "max consumption" 2, "allow overages" false, "max overages" 0, "reset consumption" false, "consumption period" null, "metadata" {} }, "max consumption" 30, "total consumptions" 0, "expiry date" null, "allow overages" false, "max overages" 99, "reset consumption" false, "consumption period" null, "metadata" {}, } ], "product custom fields" \[], "license users" \[ { "id" 1240, "last login" null, "email" "example\@email com|uss1", "true email" "example\@email com", "created at" "2020 08 12t08 52 32z", "updated at" "2020 08 12t09 01 24z", "is admin" {}, "is active" true, "is staff" false, "first name" "john", "last name" "doe", "phone number" "00385913109161", "subscribed to email" false, "acquired consent" null, "is manager" false, "initial password" "4q3dg7! ", "is initial password" true } ], "order store id" "d2d2dce02c844d4492c9d48758aa143a", "active up to date devices" 0, "total active devices" 0, "product" { "id" 1584723961091234, "product name" "mch" }, "created at" "2020 07 03t13 08 40z", "updated at" "2020 10 15t13 40 26z", "license key" null, "active" false, "enabled" true, "time activated" "2020 10 10t14 42 16z", "time disabled" "2020 08 14t07 26 27z", "max activations" 6, "times activated" 0, "valid duration" null, "validity period" "2020 09 30", "license type" "perpetual", "enable maintenance period" true, "maintenance duration" "3m", "maintenance period" "2021 01 10", "is trial" true, "max consumptions" 0, "total consumptions" 0, "subscription id" null, "last check" null, "prevent vm" true, "allow overages" false, "max overages" 0, "reset consumption" false, "consumption period" null, "trial days" 0, "is floating" false, "is floating cloud" true, "floating users" 1, "note" null, "max license users" 0, "transfer count" 0, "floating timeout" null, "max transfers" 0, "is air gapped" false, "can borrow" false, "max borrow time" 0, "is bundle" false, "metadata" {}, "order" 1593781720493279, "order item" 1593781720493299, "disabled user" null, "last activation device" null }, ] }