Skip to main content
GET
List all items

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

limit
integer<int32>

A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 50.

Required range: x <= 100
page
string

Cursor token to fetch next page of results.

sku
string

Filter items by Shopify variant SKU

serial
string

Filter items by serial

Filter items by titles, serials and SKU

visibility
enum<string>

Filter items by visibility status

Available options:
available,
unavailable,
sold,
retired
withActiveRental
boolean
default:false

When true, filter rentals by ones with active rentals

activeReturnOrderStatus
string

Filter by return order status. Can be a comma-separated list of statuses.

Example:

"requested,expected,received,in_progress,completed,cancelled"

published
object

Filter items by published date (ISO 8601), using gt, lt, gte, lte operators which may be combined. This is when utilization and ROI tracking starts.

customFields
object

Filter by custom field values, keyed by the definition's key, for definitions with "Filter in the table and the API" turned on. Each key takes an object of operators, which may be combined: eq, notEq, in, notIn (comma-separated values, or item keys for a Choice list), gt, gte, lt, lte, contains, blank, present, withinDays (a date within the next N days, or the last N when negative) and olderThanMonths (a date more than N months ago). Numbers, dates and booleans compare by type; money is in cents; Choice list values are item keys. Example: customFields[battery][in]=full,medium&customFields[serviced_on][olderThanMonths]=6. A definition that is unknown, archived or not enabled for filtering is refused with a 422.

Response

A paged array of items

data
object[]
nextPage
null | string