Browse the API30

products

get

/api/v1/products

Scope: products:read
Rate limit: 500 requests / min
Idempotency: read-only

Authentication

Send your key as Authorization: Bearer …. It must carry the scope products:read; a key without it receives 403 forbidden.

Request body

This operation takes no request body.

Response

200application/jsonSerializedProduct

slugstringrequired

namestringrequired

descriptionstring | nullrequirednullable

categorystring | nullrequirednullable

sub_categorystring | nullrequirednullable

required_fieldsstring[]required

Names only, required subset. Kept: it was the published shape.

optional_fieldsstring[]required

Names only, optional subset. Kept: it was the published shape.

application_data_fieldsSerializedProductField[]required

Every field, typed — what to put in application_data.

Errors

The statuses this operation can return, with the error.code values behind each. Every error body is the shared envelope described under Errors in Getting started.

401unauthorized

403forbidden

429rate_limit_exceeded

500internal_error

Request

curl -X GET "https://<your-host>/api/v1/products" \
  -H "Authorization: Bearer hlh_test_YOUR_API_KEY"

Response200application/json

{
  "slug": string,
  "name": string,
  "description": string | null,
  "category": string | null,
  "sub_category": string | null,
  "required_fields": [
    string
  ],
  "optional_fields": [
    string
  ],
  "application_data_fields": [
    {
      "name": string,
      "label": string,
      "type": string,
      "required": boolean,
      "options": object,
      "help": string | null,
      "section": string
    }
  ]
}

Shown as types, not sample values. A field typed number | null can be null; the response fields table gives the reason.