Get a list of available custom fields

get/product-custom-fields

Get a list of available custom fields for usage, rental products and rental product inventories.

SecuritybearerAuth
Request
query Parameters
page
required
integer <int32> (PageParam) >= 1

Page of results to show

Example: page=1
pageSize
required
integer <int32> (ResultsPerPageParam) [ 1 .. 1000 ]

Results to return per page

Example: pageSize=100
sort
string (SortParam)

Comma-delimited list of the fields to sort by - defaults to ascending order, suffix :desc to change

Example: sort=id,name | name:desc
fields
string (FieldsParam)

Comma-delimited list of the field(s) to return if only a subset is required

Example: fields=id,name
label
string (StringFilterParam)

Filter by label

Example: label=xyz | in:x,y | like:xyz
productCategoryId
string (IdFilterParam)

Filter by product category id

Example: productCategoryId=0
entityLevel
string (CustomFieldEntityLevel)

Filter by this entity level only

Enum: "USAGE_PRODUCT" "RENTAL_PRODUCT" "RENTAL_PRODUCT_INVENTORY"
Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

Response samples
application/json
[
  • {
    • "id": 1,
    • "label": "string",
    • "productCategoryIds": [
      • 0
      ],
    • "entityLevel": "USAGE_PRODUCT"
    }
]