---
title: "Get list of product models"
method: GET
path: "/api/rest/v1/product-models"
tags: ["Product model"]
---

# Get list of product models

`GET /api/rest/v1/product-models`

This endpoint allows you to get a list of product models. Product models are paginated. In the Enterprise Edition, since the 2.0, permissions based on your user groups are applied to the set of products you request.

## Query parameters

- `search` string
- `scope` string
- `locales` string
- `attributes` string
- `pagination_type` 'page' | 'search_after'
- `page` integer
- `search_after` string
- `limit` integer
- `with_count` boolean
- `with_quality_scores` boolean

## Response `200`

Return product models paginated

- object
  - `_links` object
    - `self` object
      - `href` string — URI of the current page of resources
    - `first` object
      - `href` string — URI of the first page of resources
    - `previous` object
      - `href` string — URI of the previous page of resources
    - `next` object
      - `href` string — URI of the next page of resources
  - `current_page` integer — Current page number
  - `_embedded` object
    - `items` object[]
      - `_links` object
        - `self` object
          - `href` string — URI of the resource
      - `code` string, required — Product model code
      - `family` string — <a href='api-reference-paas.html#Family'>Family</a> code from which the product inherits its attributes and attributes requirements (since the 3.2)
      - `family_variant` string, required — Family variant code from which the product model inherits its attributes and variant attributes
      - `parent` string — Code of the parent <a href='api-reference-paas.html#Productmodel'>product model</a>. This parent can be modified since the 2.3.
      - `categories` string[] — Codes of the <a href='api-reference-paas.html#Category'>categories</a> in which the product model is categorized
      - `values` object — Product model attributes values, see <a href='/concepts/products.html#focus-on-the-product-values'>Product values</a> section for more details
      - `associations` object — Several associations related to groups, product and/or other product models, grouped by association types
        - `associationTypeCode` object
          - `groups` string[] — Array of groups codes with which the product is in relation
          - `products` string[] — Array of product identifiers with which the product is in relation
          - `product_models` string[] — Array of product model codes with which the product is in relation (only available since the v2.1)
      - `quantified_associations` object — Several quantified associations related to products and/or product models, grouped by quantified association types (only available since the 5.0)
        - `quantifiedAssociationTypeCode` object
          - `products` object[] — Array of objects containing product identifiers and quantities with which the product model is in relation
            - `identifier` string
            - `quantity` integer
          - `product_models` object[] — Array of objects containing product model codes and quantities with which the product model is in relation
            - `code` string
            - `quantity` integer
      - `created` string, dateTime — Date of creation
      - `updated` string, dateTime — Date of the last update
      - `metadata` object — More information around the product model (only available since the v2.3 in the Enterprise Edition)
        - `workflow_status` 'read_only' | 'draft_in_progress' | 'proposal_waiting_for_approval' | 'working_copy' — Status of the product model regarding the user permissions
      - `quality_scores` object — Product model quality scores for each channel/locale combination (<strong>only available since the 7.0 version</strong> and when the "with_quality_scores" query parameter is set to "true")

## Other responses

- `401` — Authentication required
- `406` — Not Acceptable
- `422` — Unprocessable entity

---

[API](https://skmtc.net/akeneo/apis/akeneo-pim-rest-api.md) · [All operations](https://skmtc.net/akeneo/apis/akeneo-pim-rest-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/akeneo/akeneo-pim-rest-api/versions/d8bda9b93b59/schema)