---
title: "Get list of families"
method: GET
path: "/api/rest/v1/families"
tags: ["Family"]
---

# Get list of families

`GET /api/rest/v1/families`

This endpoint allows you to get a list of families. Families are paginated and sorted by code.

## Query parameters

- `search` string
- `page` integer
- `limit` integer
- `with_count` boolean

## Response `200`

Return families 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 — Family code
      - `attribute_as_label` string, required — Attribute code used as label
      - `attribute_as_image` string — Attribute code used as the main picture in the user interface (only since v2.0)
      - `attributes` string[] — Attributes codes that compose the family
      - `attribute_requirements` object — Attributes codes of the family that are required for the completeness calculation for each channel
        - `channelCode` string[]
      - `labels` object — Family labels for each locale
        - `localeCode` string — Family label for the locale `localeCode`

## Other responses

- `401` — Authentication required
- `403` — Access forbidden
- `406` — Not Acceptable

---

[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/revisions/d8bda9b93b59/schema)