Product Families

List product families

get/api/v1/product_families

Query parameters

order_bystring

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

pageinteger

Page number (0-indexed)

per_pageinteger

Number of items per page

searchstring

Response

List of product families

Example response

{
  "data": [
    {
      "id": "pf_7n42DGM5Tflk9n8mt7Fhc7"
    }
  ]
}

Changes

Changed in 10 of the 54 revisions of this API.5618

    • added the new optional query request parameter order_by

      new-optional-request-parameter

    • added the non-success response with the status

      response-non-success-status-added

    • api tag Product Families added

      api-tag-added

    • api tag Product Family removed

      api-tag-removed

    • api tag Product Family added

      api-tag-added

    • api tag product_family removed

      api-tag-removed

    This revision also has 9 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • added the new optional query request parameter search

      new-optional-request-parameter

    • deleted the query request parameter search

      request-parameter-removed

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • v176f228b9e0eb22See the full diff
    • deleted the query request parameter limit

      request-parameter-removed

    • deleted the query request parameter offset

      request-parameter-removed

    • added the new optional query request parameter page

      new-optional-request-parameter

    • added the new optional query request parameter per_page

      new-optional-request-parameter

  • v1167a049d244e11See the full diff
    • removed the required property from the response with the status

      response-required-property-removed

    • added the required property to the response with the status

      response-required-property-added

    This revision also has 3 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • the endpoint scheme security bearer_auth was added to the API

      api-security-added

    • the endpoint scheme security api-key was removed from the API

      api-security-removed

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • v1dece17f86f99436See the full diff
    • added the new required query request parameter limit

      new-required-request-parameter

    • added the new required query request parameter offset

      new-required-request-parameter

    • the query request parameter search became required

      request-parameter-became-required

    • removed the required property from the response with the status

      response-required-property-removed

    • deleted the query request parameter order_by

      request-parameter-removed

    • deleted the query request parameter page

      request-parameter-removed

    • deleted the query request parameter per_page

      request-parameter-removed

    • the endpoint scheme security api-key was added to the API

      api-security-added

    • the endpoint scheme security bearer_auth was removed from the API

      api-security-removed

    • api tag product_family added

      api-tag-added

    • api tag Product Families removed

      api-tag-removed

    • removed the non-success response with the status

      response-non-success-status-removed

    • added the required property to the response with the status

      response-required-property-added

    This revision also has 274 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog