List Licenses

User Guide > Resources > List Licenses

This request returns a list of the current active license objects.

Resource

GET /licenses[?parameters]

Parameters

Name Type Description

name

String

Select objects that match this string.

limit

Integer

The maximum number of objects to return. Default: 15.

order

[ascending|decending]

Sort results in decending or ascending order. Default: ascending.

before

[id]

Paging: return results before the specified ID.

after

[id]

Paging: return results after the specified ID.

Payload

None

Response

List Response < Licenses >

Context

Authorization

Administrator

Errors

Common Errors

Example

Request
GET https://xelion.nl/api/v1/master/licenses
Response
{
    "data": [
         {
            "object": {
                "licenseName": "license.sms",
                "active": true,
                "licenseType": "global",
                "perUser": false,
                "licenseCount": {
                    "maxLicenses": 1,
                    "usedLicenses": 1,
                    "oid": "1229729",
                    "objectType": "X1LicenseCount"
                },
                "commonName": "license.sms",
                "oid": "1229726",
                "objectType": "X1License"
            },
            "links": [
                {
                    "rel": "self",
                    "href": "https://xelion.nl/api/v1/masterr/licenses/1229726",
                    "method": "GET"
                }
            ]
        },
        {
            "object": {
                "licenseName": "license.user",
                "active": true,
                "licenseType": "perUser",
                "perUser": false,
                "licenseCount": {
                    "maxLicenses": 20,
                    "usedLicenses": 0,
                    "oid": "1650888",
                    "objectType": "X1LicenseCount"
                },
                "commonName": "license.user",
                "oid": "1650887",
                "objectType": "X1License"
            },
            "links": [
                {
                    "rel": "self",
                    "href": "https://xelion.nl/api/v1/master/licenses/1650887",
                    "method": "GET"
                }
            ]
        },
        {
            "object": {
                "licenseName": "license.exchange",
                "active": true,
                "licenseType": "global",
                "perUser": false,
                "licenseCount": {
                    "maxLicenses": 1,
                    "usedLicenses": 1,
                    "oid": "1650894",
                    "objectType": "X1LicenseCount"
                },
                "commonName": "license.exchange",
                "oid": "1650893",
                "objectType": "X1License"
            },
            "links": [
                {
                    "rel": "self",
                    "href": "https://xelion.nl/api/v1/master/licenses/1650893",
                    "method": "GET"
                }
            ]
        },
    ],
    "meta": {
        "links": [
            {
                "rel": "refresh",
                "href": "https://xelion.nl/api/v1/master/licenses",
                "method": "GET"
            },
            {
                "rel": "next",
                "href": "https://xelion.nl/api/v1/master/licenses?after=1650911",
                "method": "GET"
            },
            {
                "rel": "previous",
                "href": "https://xelion.nl/api/v1/master/licenses?before=1229713",
                "method": "GET"
            }
        ],
        "paging": {
            "previousId": "1229713",
            "nextId": "1650911"
        }
    }
}