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)

pageSize?: integer

pageNumber?: integer

search: {
}

sort_by?: string[]

Responses

• 200 Success

application/json

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

Create a customer

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

RequestBody

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

Responses

• 201 Returns created customer.

application/json

{
  id: string
  name: string
  description: string
  externalId: string
  licenseCount: integer
}

Get a customer

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

Responses

• 200 Success

Update a customer

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

RequestBody

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

Responses

• 204 Customer was updated successfully