v1
latestOpenAPI 3.0.02026-07-263403911.5 MBPackages
Search packages
Search for one or more packages.
get/v1/Packages
Query parameters
search.package_idinteger[]
Query by package identifier.
search.descriptionstring[]
Query by the package description.
search.provider_idinteger[]
Query by the provider identifier.
search.class'Business' | 'Residential'
Query by the customer class restriction (Business, Residential).
search.activeboolean
Query by active status (true or false).
search.created_date_startstring date-time
Format - date-time (as date-time in RFC3339). Query by created date.
search.created_date_endstring date-time
Format - date-time (as date-time in RFC3339). Query by created date.
search.statestring[]
Query by state restriction.
search.currency_codestring[]
Query by three-letter currency code.
search.page_sizeinteger
Format - int32. Defines how many items to return at a time.
search.pageinteger
Format - int32. Specifies which page to display (i.e. 3rd page of 50 items out of 1000 items)
search.sortstring
Specifies the model member you wish to sort by. Defaults to Ascending order, add a "-" sign to the beginning to indicate Descending order.
Response
OK