API referenceProducts
List products
Needs a token with the read:products scope (or write:products). Authentication
Try in Playground sends a real request to app.helvetly.com with a token you paste. It stays in this browser tab only (session storage) and goes to no one else.
GET
Products and services of the catalogue, paged.
bearerAuthheader
AuthorizationBearer <token>A personal API token, hvt_…, with scopes such as read:* or write:invoices
page?integerPage number, from 1.
Range
1 <= valueDefault
1page_size?integerItems per page.
Range
1 <= value <= 200Default
50search?stringMatches name, SKU and description.
type?stringProducts or services.
Value in
"product""service"status?stringActive or archived.
Default
"active"Value in
"active""archived"currency?stringComma-separated ISO codes.
sort?stringOne of name, sku, unit_price, created_at, updated_at; prefix - for descending. Default name.
OK
application/json- response
data*array<>meta*Paging of a list: page/page_size in, totals out.
curl -X GET 'https://app.helvetly.com/api/v1/products'Example Response
{ "data": [ { "id": "string", "type": "product", "name": "string", "description": "string", "sku": "string", "gtin": "string", "unit": "string", "price_basis": "string", "unit_price": "1234.50", "unit_price_net": "1234.50", "unit_price_gross": "1234.50", "currency": "string", "vat_category": "string", "vat_rate": "string", "is_archived": true, "archived_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z" } ], "meta": { "page": 0, "page_size": 0, "total": 0, "total_pages": 0 }}