Skip to main content
GET
/
licenses
{
  "items": [
    {
      "licenseId": "<string>",
      "status": "PENDING",
      "type": "<string>",
      "customerId": "<string>",
      "productOfferingId": "<string>",
      "assignedTo": {
        "type": "SUBSCRIPTION",
        "subscriptionId": "<string>"
      },
      "activatedAt": "2023-11-07T05:31:56Z",
      "cancelledAt": "2023-11-07T05:31:56Z",
      "pausedAt": "2023-11-07T05:31:56Z",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "pagination": {
    "total": 123,
    "limit": 123,
    "offset": 123,
    "sort": {
      "key": "<string>",
      "direction": "ASC"
    }
  }
}

Authorizations

​
X-API-Key
string
header
required

An API key that grants access to the Connect API. You can create and manage API keys in the portal.

Query Parameters

​
customerId
string[]

The unique identifier of the customer to filter by.

​
status
enum<string>[]

The status of the license to filter by.

​
type
string[]

The type of license to filter by.

The type of license, categorizing the software product or service into various telecommunications license types.

​
limit
integer
default:100

The maximum number of items to return.

Required range: 1 <= x <= 1000
​
offset
integer
default:0

The number of items to skip before starting to collect the result set.

Required range: x >= 0

Response

A list of licenses.

​
items
object[]
​
pagination
object
⌘I