Skip to main content
GET
/
api
/
v1
/
product_families
List product families
curl --request GET \
  --url https://api.example.com/api/v1/product_families \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "<string>",
      "name": "<string>"
    }
  ],
  "pagination_meta": {
    "page": 1,
    "per_page": 1,
    "total_items": 1,
    "total_pages": 1
  }
}

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
order_by
string

Sort order. Format: column.direction. Allowed columns: name, created_at. Direction: asc or desc. Default: created_at.desc.

​
page
integer<int32>

Page number (0-indexed)

Required range: x >= 0
​
per_page
integer<int32>

Number of items per page

Required range: 1 <= x <= 100
​
search
string

Response

List of product families

​
data
object[]
required
​
pagination_meta
object
required