License API
List License Users for Customer
6 min
{ "tab" "examples", "url" "/api/v4/customer license users", "name" "/api/v4/customer license users", "method" "get", "request" { "pathparameters" \[], "queryparameters" \[ { "kind" "required", "name" "product", "type" "string", "children" \[], "description" "product short code" }, { "kind" "required", "name" "customer", "type" "string", "children" \[], "description" " attach the assigned license user email (eq user\@example com)" } ], "headerparameters" \[ { "kind" "required", "name" "date", "type" "string", "children" \[], "description" "in rfc7231 format (see \\"license api authorization\\"), eg thu, 17 nov 2022 20 51 35 gmt" }, { "kind" "required", "name" "authorization", "type" "string", "children" \[], "description" "see \\"license api authorization\\" article" } ], "bodydataparameters" \[], "formdataparameters" \[] }, "results" { "languages" \[ { "id" "qlx3ifr3fpkeqnnhkuaxk", "code" "{\n \\"customer\\" {\n \\"email\\" \\"test\@example com\\",\n \\"first name\\" \\"\\",\n \\"last name\\" \\"\\",\n \\"company name\\" \\"\\",\n \\"phone\\" \\"\\",\n \\"reference\\" \\"\\",\n \\"address\\" \\"\\",\n \\"postcode\\" \\"\\",\n \\"city\\" \\"\\",\n \\"country\\" \\"\\",\n \\"state\\" \\"\\"\n },\n \\"users\\" \[\n {\n \\"email\\" \\"test1\@example com\\",\n \\"is active\\" true,\n \\"first name\\" \\"\\",\n \\"last name\\" \\"\\",\n \\"phone number\\" \\"\\",\n \\"is initial password\\" true,\n \\"initial password\\" \\"t218 uv@\\",\n \\"license id\\" 34524352345,\n \\"order store id\\" \\"67e58562adfsfsdf1aff4b1f551d30326\\",\n \\"order id\\" 45367563535423\n },\n {\n \\"email\\" \\"test2\@example com\\",\n \\"is active\\" true,\n \\"first name\\" \\"0\\",\n \\"last name\\" \\"0\\",\n \\"phone number\\" \\"0\\",\n \\"is initial password\\" false,\n \\"initial password\\" \\"\\",\n \\"license id\\" 786856745645,\n \\"order store id\\" \\"gdfge34r4fqf44qqrf43f\\",\n \\"order id\\" 653456345635\n }\n ]\n}", "language" "200", "customlabel" "" } ], "selectedlanguageid" "qlx3ifr3fpkeqnnhkuaxk" }, "examples" { "languages" \[ { "id" "rktbuadyllwfz1vu8nl5p", "language" "curl", "code" "curl location request get '/api/v4/customer license users?product=string\&customer=string' \\\\\n header 'accept application/json' \\\\\n header 'date string' \\\\\n header 'authorization string'", "customlabel" "" }, { "id" "ivwgkp 7mcj4iukjvnqug", "language" "nodejs", "code" "var request = require('request');\nvar options = {\n 'method' 'get',\n 'url' '/api/v4/customer license users?product=string\&customer=string',\n 'headers' {\n 'accept' 'application/json',\n 'date' 'string',\n 'authorization' 'string'\n }\n};\nrequest(options, function (error, response) {\n if (error) throw new error(error);\n console log(response body);\n});\n", "customlabel" "" }, { "id" "72eeqkoxhaug8cdccomyt", "language" "javascript", "code" "var myheaders = new headers();\nmyheaders append(\\"accept\\", \\"application/json\\");\nmyheaders append(\\"date\\", \\"string\\");\nmyheaders append(\\"authorization\\", \\"string\\");\n\nvar requestoptions = {\n method 'get',\n headers myheaders,\n redirect 'follow'\n};\n\nfetch(\\"/api/v4/customer license users?product=string\&customer=string\\", requestoptions)\n then(response => response text())\n then(result => console log(result))\n catch(error => console log('error', error));", "customlabel" "" }, { "id" "q4i equjgsbrz5cuexagw", "language" "python", "code" "import requests\n\nurl = \\"/api/v4/customer license users?product=string\&customer=string\\"\n\npayload={}\nheaders = {\n 'accept' 'application/json',\n 'date' 'string',\n 'authorization' 'string'\n}\n\nresponse = requests request(\\"get\\", url, headers=headers, data=payload)\n\nprint(response text)\n", "customlabel" "" }, { "id" "cnfu8wgdfp v9yj3b 7t0", "language" "ruby", "code" "require \\"uri\\"\nrequire \\"net/http\"\n\nurl = uri(\\"/api/v4/customer license users?product=string\&customer=string\\")\n\nhttp = net http new(url host, url port);\nrequest = net http get new(url)\nrequest\[\\"accept\\"] = \\"application/json\\"\nrequest\[\\"date\\"] = \\"string\\"\nrequest\[\\"authorization\\"] = \\"string\\"\n\nresponse = http request(request)\nputs response read body\n", "customlabel" "" } ], "selectedlanguageid" "q4i equjgsbrz5cuexagw" }, "description" "returns a list of all license users assigned to licenses belonging to the requested customer (only for user based products)", "currentnewparameter" { "label" "query parameter", "value" "queryparameters" } } schema request query parameters type licenseusersforcustomerrequestparams = { product string, customer string, } json schema response body type licenseusersforcustomerresponsebody = { customer { address string, city string, company name string, country string, customer account string | null, email string, first name string, last name string, phone string, postcode string, reference string, state string, metadata json, }, users ({ email string, first name string, initial password string, is active boolean, is initial password boolean, last name string, license id number, max activations number, order id number, order store id string, phone number string, total activations number, })\[] } json schema errors if an error occurs, the response will have an http status code of 400 or higher, and the response body will contain an error description in the following format { status number, code string, message string } json schema { "$schema" "https //json schema org/draft/2020 12/schema", "type" "object", "properties" { "status" { "type" "number" }, "code" { "type" "string" }, "message" { "type" "string" } }, "required" \[ "status", "code", "message" ], "additionalproperties" false } list of exceptions