Appearance

Customers ​

Customers let you keep track of who owns which License.

A Customer's externalId field is meant to be used to store a potential ID from any external management systems.

Get all customers ​

Endpoint: GET https://api.software-licensing.io/v1/customers

Parameters(Query) ​

ts
pageSize?: integer
ts
pageNumber?: integer

Responses ​

  • 200 Success

application/json

ts
{
  data: {
    id: string
    name: string
    description: string
    externalId: string
  }[]
  pagination: {
    itemCount?: integer
    totalPages?: integer
    currentPage?: integer
    nextPage?: integer
    previousPage?: integer
  }
}

Create an customer ​

Endpoint: POST https://api.software-licensing.io/v1/customers

RequestBody ​

ts
{
  name: string
  description?: string
  externalId?: string
}

Responses ​

  • 201 Returns created customer.

application/json

ts
{
  id: string;
  name: string;
  description: string;
  externalId: string;
}

Get an customer ​

Endpoint: GET https://api.software-licensing.io/v1/customers/customer/{id}

Responses ​

  • 200 Success

Update an customer ​

Endpoint: PUT https://api.software-licensing.io/v1/customers/customer/{id}

RequestBody ​

ts
{
  name?: string
  description?: string
  externalId?: string
}

Responses ​

  • 204 Customer was updated successfully