License API
List License Users for Customer

6min
Returns a list of all license users assigned to licenses belonging to the requested customer (only for user-based products)
GET
Request
Query Parameters
product
String
required
Product short code
customer
String
required
 Attach the assigned license user email (eq. [email protected])
Header Parameters
Date
String
required
In RFC7231 format (see "License API Authorization"), eg.: Thu, 17 Nov 2022 20:51:35 GMT
Authorization
String
required
See "License API Authorization" article
Curl
Node.js
JS
Python
Ruby
import requests

url = "/api/v4/customer_license_users?product=string&customer=string"

payload={}
headers = {
   'Accept': 'application/json',
   'Date': 'string',
   'Authorization': 'string'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)

import requests

url = "/api/v4/customer_license_users?product=string&customer=string"

payload={}
headers = {
   'Accept': 'application/json',
   'Date': 'string',
   'Authorization': 'string'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)
Responses
200
{
    "customer": {
        "email": "[email protected]",
        "first_name": "",
        "last_name": "",
        "company_name": "",
        "phone": "",
        "reference": "",
        "address": "",
        "postcode": "",
        "city": "",
        "country": "",
        "state": ""
    },
    "users": [
        {
            "email": "[email protected]",
            "is_active": true,
            "first_name": "",
            "last_name": "",
            "phone_number": "",
            "is_initial_password": true,
            "initial_password": "t218_uv@",
            "license_id": 34524352345,
            "order_store_id": "67e58562adfsfsdf1aff4b1f551d30326",
            "order_id": 45367563535423
        },
        {
            "email": "[email protected]",
            "is_active": true,
            "first_name": "0",
            "last_name": "0",
            "phone_number": "0",
            "is_initial_password": false,
            "initial_password": "",
            "license_id": 786856745645,
            "order_store_id": "gdfge34r4fqf44qqrf43f",
            "order_id": 653456345635
        }
    ]
}
{
    "customer": {
        "email": "test@example.com",
        "first_name": "",
        "last_name": "",
        "company_name": "",
        "phone": "",
        "reference": "",
        "address": "",
        "postcode": "",
        "city": "",
        "country": "",
        "state": ""
    },
    "users": [
        {
            "email": "test1@example.com",
            "is_active": true,
            "first_name": "",
            "last_name": "",
            "phone_number": "",
            "is_initial_password": true,
            "initial_password": "t218_uv@",
            "license_id": 34524352345,
            "order_store_id": "67e58562adfsfsdf1aff4b1f551d30326",
            "order_id": 45367563535423
        },
        {
            "email": "test2@example.com",
            "is_active": true,
            "first_name": "0",
            "last_name": "0",
            "phone_number": "0",
            "is_initial_password": false,
            "initial_password": "",
            "license_id": 786856745645,
            "order_store_id": "gdfge34r4fqf44qqrf43f",
            "order_id": 653456345635
        }
    ]
}
﻿
Schema
Request Query Parameters
TypeScript
JSON Schema

﻿
Response Body
TypeScript
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:
TypeScript
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
}
{
  "$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
unknown_product (400): Provided product was not found
missing_headers (400): Some headers are missing
invalid_product_auth_method (400): Product authorization method is invalid: { params }.
﻿
Updated 24 Jan 2025
Did this page help you?
Get Installation File
Single Sign-On URL