GET
/
v1
/
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": {
        "fr": {
          "name": "<string>",
          "public_description": "<string>"
        },
        "en": {
          "name": "<string>",
          "public_description": "<string>"
        },
        "de": {
          "name": "<string>",
          "public_description": "<string>"
        },
        "it": {
          "name": "<string>",
          "public_description": "<string>"
        },
        "nl": {
          "name": "<string>",
          "public_description": "<string>"
        },
        "es": {
          "name": "<string>",
          "public_description": "<string>"
        },
        "pt": {
          "name": "<string>",
          "public_description": "<string>"
        },
        "pl": {
          "name": "<string>",
          "public_description": "<string>"
        }
      },
      "properties": {},
      "custom_properties": {},
      "accounting": {},
      "type": "flat_fee",
      "is_available_on_demand": true,
      "is_available_on_subscription": true
    }
  ]
}

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
string
status__not
string
status__isNull
string
status__isNotNull
string
status__equals
string
status__contains
string
status__startsWith
string
status__endWith
string
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

The response is of type object.