# Get a list of available usage products

Endpoint: GET /usage-products
Version: 2.13
Security: bearerAuth

## Query parameters:

  - `page` (integer, required)
    Page of results to show
    Example: 1

  - `pageSize` (integer, required)
    Results to return per page
    Example: 100

  - `sort` (string)
    Comma-delimited list of the fields to sort by - defaults to ascending order, suffix :desc to change
    Example: "id,name | name:desc"

  - `fields` (string)
    Comma-delimited list of the field(s) to return if only a subset is required
    Example: "id,name"

  - `name` (string)
    Filter by product name
    Example: "xyz | in:x,y | like:xyz"

  - `usageProductCategoryId` (string)
    Filter by usage product category
    Example: "0"

  - `availableFrom` (string)
    Filter by available from date
    Example: "yyyy-MM-dd | lt:yyyy-MM-dd | gt:yyyy-MM-dd | gtn:yyyy-MM-dd"

  - `availableTo` (string)
    Filter by available to date
    Example: "yyyy-MM-dd | lt:yyyy-MM-dd | gt:yyyy-MM-dd | gtn:yyyy-MM-dd"

  - `nominalCode` (string)
    Filter by nominal code
    Example: "xyz | in:x,y | like:xyz"

## Response 200 fields (application/json):

  - `id` (integer)
    Usage product identifier
    Example: 1

  - `name` (string, required)
    Usage product name

  - `nominalCode` (string)
    Nominal code
    Example: "SALES-01QTR2"

  - `usageProductCategoryId` (integer, required)
    Usage product category identifier
    Example: 1

  - `direction` (string, required)
    Usage product direction
    Enum: "INBOUND", "OUTBOUND"

  - `performLocalAndNationalCheck` (boolean)
    Perform local and national check

  - `availableFrom` (string, required)
    Product is available from

  - `availableTo` (string)
    Product is available to

  - `productReferenceCanBeRange` (boolean)
    Product reference can be range

  - `serviceIdRequired` (boolean)
    Service id is required on rental product inventories

  - `customFields` (array)

  - `customFields.id` (integer)
    Custom field identifier
    Example: 1

  - `customFields.label` (string, required)
    Custom field label

  - `customFields.value` (string, required)
    Custom field value

  - `productReferenceFormat` (string, required)
    Regular expression used to validate product references on usage product inventories
    Example: "[0-9]{3,11}"

  - `serviceIdFormat` (string)
    Regular expression used to validate service ids on usage product inventories
    Example: "[a-zA-Z0-9\\-]{3,100}"


## Response 400 fields

## Response 401 fields

## Response 403 fields