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.verustrust-licensing.com/v1/customers

Parameters(Query) ​

typescript
pageSize?: integer
typescript
pageNumber?: integer
typescript
search: {
}
typescript
sort_by?: string[]

Responses ​

  • 200 Success

application/json

typescript
{
  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.verustrust-licensing.com/v1/customers

RequestBody ​

  • application/json
typescript
{
  name: string
  description?: string
  externalId?: string
}

Responses ​

  • 201 Returns created customer.

application/json

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

Get a customer ​

Endpoint: GET https://api.verustrust-licensing.com/v1/customers/customer/{id}

Responses ​

  • 200 Success

Update a customer ​

Endpoint: PUT https://api.verustrust-licensing.com/v1/customers/customer/{id}

RequestBody ​

  • application/json
typescript
{
  name?: string
  description?: string
  externalId?: string
}

Responses ​

  • 204 Customer was updated successfully