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
required
String
Product short code
customer
required
String
 Attach the assigned license user email (eq. [email protected])
Header Parameters
Date
required
String
In RFC7231 format (see "License API Authorization"), eg.: Thu, 17 Nov 2022 20:51:35 GMT
Authorization
required
String
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
type LicenseUsersForCustomerRequestParams = {
  product: string,
  customer: string,
}
type LicenseUsersForCustomerRequestParams = {
  product: string,
  customer: string,
}
﻿
Response Body
TypeScript
JSON
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,
  })[]
}
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,
  })[]
}
﻿
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
{
  status: number,
  code: string,
  message: string
}
{
  status: number,
  code: string,
  message: string
}
﻿
List of exceptions
unknown_product (400): Provided product was not found
missing_headers (400): Some headers are missing
product.authorization_method === 'user'
invalid_product_auth_method (400): Product authorization method is invalid: { params }.
﻿
Updated 17 Jan 2025
Did this page help you?
Get Installation File
Single Sign-On URL