Returns an array of ApiDeviceContract. This method returns all contracts that are active within the specified date range, filtered based on other parameters.
Parameters
apiKey
The active API Key.
commentsFilter
Filter array by comment.
devicePlanId
ID of the ApiDevicePlan to filter. -1 = show all device plans, 0 = show unassigned.
forAccount
Account number (see ApiUser.Accounts) for which to retrieve the device contracts.
fromDate
Start of the date range (value in UTC). Required unless using order date range.
groupIdFilter
Filter array by groupId.
imeis
String array of device IMEI numbers to filter.
includeConnectInfo
Includes device connection info.
nextId
If specified, limits the result set to 1000 records and returns device contracts that have IDs greater than this value. To obtain the first limited result set, pass 0 as this value.
optionalParam
Pass Device Contract GraphQL Schema to determine what property will be returned
ordersAddedFrom
Start of the date range to limit results based on order date (value in UTC). Usage requires purchase order filter.
ordersAddedTo
End of the date range to limit results based on order date (value in UTC). Usage requires purchase order filter.
paginationContext
purchaseOrderFilter
Filter for a specified purchase order number. Required when using order date range.
serialNos
String array of device serial numbers to filter.
sessionId
The active session ID.
showNoDatabaseOnly
Filters for devices that are not registered in a MyGeotab database.
showShelfStockOnly
Filters for devices that have never activated.
toDate
End of the date range (value in UTC). Required unless using order date range.
userCompanyId
ID of the ApiUserCompany to filter. -1 = show all companies, 0 = show unassigned.