Skip to main content
GET
List All Premiums
Each premium comes back with its price, fair market value, inventory, and whether it is active.
Use filter for a free-text search and sortBy=fmv, id, or status with descending to order the results.

Authorizations

Authorization
string
header
required

JWT Authorization header using the Bearer scheme. Example: "Authorization: Bearer {token}"

Query Parameters

Filter
string

A free-text search term. Only premiums whose name, short name, or code match the term are returned.

Skip
integer<int32>

The number of records to skip before the first record returned. Use it with take to page through the results.

Take
integer<int32>

The maximum number of records to return in this page of results.

SortBy
enum<string>

Field to sort by (case-insensitive). Valid options: fmv, id, status

Available options:
fmv,
id,
status
Descending
boolean

The direction to sort the results. Set to true to sort in descending order.

IncludeDetails
boolean

When true, includes the related records for each item in the response. Not every list has extra records to return, and it can slow down large result sets.

Response

OK

A page of premiums with the total number that match the request.

items
object[]

The premiums in this page of results.

total
integer<int32>

The total number of premiums that match the request. Use it with skip and take to page through the full set.

Last modified on July 28, 2026