Skip to main content
GET
/
v1
/
products
List products
curl --request GET \
  --url https://api.hyperline.co/v1/products \
  --header 'Authorization: Bearer <token>'
{
  "meta": {
    "total": 1,
    "taken": 1,
    "skipped": 0
  },
  "data": [
    {
      "id": "itm_3kXODDF42QXtnL",
      "name": "Product name",
      "status": "active",
      "description": "Product internal description",
      "description_display_interval_dates": true,
      "public_description": "Product public description",
      "translations": {},
      "properties": null,
      "custom_properties": {},
      "accounting": {},
      "is_available_on_demand": true,
      "is_available_on_subscription": true
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.hyperline.co/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
take
number | null
default:50
Required range: 0 <= x <= 100
​
skip
number | null
default:0
Required range: x >= 0
​
id
string
​
id__not
string
​
id__isNull
string
​
id__isNotNull
string
​
id__equals
string
​
id__contains
string
​
id__startsWith
string
​
id__endWith
string
​
status
Available options:
all,
active,
archived
​
status__in
Available options:
all,
active,
archived
​
name
string
​
name__not
string
​
name__isNull
string
​
name__isNotNull
string
​
name__equals
string
​
name__contains
string
​
name__startsWith
string
​
name__endWith
string
​
description
string
​
description__not
string
​
description__isNull
string
​
description__isNotNull
string
​
description__equals
string
​
description__contains
string
​
description__startsWith
string
​
description__endWith
string
​
type
string
​
type__not
string
​
type__isNull
string
​
type__isNotNull
string
​
type__equals
string
​
type__contains
string
​
type__startsWith
string
​
type__endWith
string
​
price_book_id
string

Response

200 - application/json
​
meta
object
required
​
data
(Fee product · object | Seat product · object | Dynamic product · object | Credit product · object | Bundle product · object)[]
required

List of Product.