> ## Documentation Index
> Fetch the complete documentation index at: https://redo-44af351d-docs-v3-graphql-api-reference.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.
# productFamilies
> List product families.
**Required scopes:**
[`products_read`](/docs/api-reference/v3/reference/scopes#scope-products_read)
## Arguments
Forward pagination cursor — returns items after it. Pass an `edges[].cursor` or
`pageInfo.endCursor` from a previous page.
Backward pagination cursor — returns items before it. Pass an `edges[].cursor`
or `pageInfo.startCursor` from a previous page.
Forward pagination: returns the first N items (max 100, default 25). Use with
`after`; mutually exclusive with `last`/`before`.
Backward pagination: returns the last N items (max 100, default 25). Use with
`before`; mutually exclusive with `first`/`after`.
ProductFamilySortKey}>
Which key to sort by (defaults to the first key, newest-first). Combine with
`reverse` to flip direction.
Reverses the sort direction selected by `orderBy` (or its default).
## Returns
ProductFamilyConnection!} required>
A paginated list of ProductFamily items.
[ProductFamilyEdge!]!} required>
The list of edges (each a node plus its pagination `cursor`).
Opaque cursor for this item; pass to `after`/`before` to page from here.
ProductFamily!} required>
The item at this edge.
Attribute}>
Look up a single attribute on this family by its name, if set.
**Requires:** [`products_read`](/docs/api-reference/v3/reference/scopes#scope-products_read)
**Arguments**
The machine name of the attribute to look up.
[Attribute!]!} required>
The merchant-defined attributes set on this family.
DateTime!} required>
When the record was created.
The product family's long-form description.
The id of this product family.
ProductFamilyImage}>
The first (default) image for this family, if any.
**Requires:** [`products_read`](/docs/api-reference/v3/reference/scopes#scope-products_read)
ProductFamilyImageConnection!} required>
A paginated list of the family's images.
**Requires:** [`products_read`](/docs/api-reference/v3/reference/scopes#scope-products_read)
**Arguments**
Forward pagination cursor — returns items after it. Pass an `edges[].cursor` or `pageInfo.endCursor` from a previous page.
Backward pagination cursor — returns items before it. Pass an `edges[].cursor` or `pageInfo.startCursor` from a previous page.
Forward pagination: returns the first N items (max 100, default 25). Use with `after`; mutually exclusive with `last`/`before`.
Backward pagination: returns the last N items (max 100, default 25). Use with `before`; mutually exclusive with `first`/`after`.
[ProductFamilyOption!]!} required>
The variant options (e.g. Size, Color) for this family.
ProductConnection!} required>
A paginated list of the products (variants) in this family.
**Requires:** [`products_read`](/docs/api-reference/v3/reference/scopes#scope-products_read)
**Arguments**
Forward pagination cursor — returns items after it. Pass an `edges[].cursor` or `pageInfo.endCursor` from a previous page.
Backward pagination cursor — returns items before it. Pass an `edges[].cursor` or `pageInfo.startCursor` from a previous page.
Forward pagination: returns the first N items (max 100, default 25). Use with `after`; mutually exclusive with `last`/`before`.
Backward pagination: returns the last N items (max 100, default 25). Use with `before`; mutually exclusive with `first`/`after`.
Free-form tags applied to the product family.
The product family's title.
DateTime!} required>
When the record was last updated.
The vendor or manufacturer of the product family.
[ProductFamily!]!} required>
The nodes in this page, without the edge/cursor wrapper — a convenience over `edges`.
Attribute}>
Look up a single attribute on this family by its name, if set.
**Requires:** [`products_read`](/docs/api-reference/v3/reference/scopes#scope-products_read)
**Arguments**
The machine name of the attribute to look up.
**Fields**
An optional description of what the attribute represents.
The human-readable label shown for the attribute.
The unique identifier of the attribute's definition.
The attribute's machine name, unique within the account.
AttributeType!} required>
The data type of the attribute's value.
JSON}>
The attribute's value, resolved to the typed JSON form for its `type` — read `type` to know the shape. E.g. SHORT\_TEXT → a string, WEIGHT → \{ value, unit }, MONEY → \{ amount, currency }. Null if unset. See AttributeType for each type's shape.
[Attribute!]!} required>
The merchant-defined attributes set on this family.
An optional description of what the attribute represents.
The human-readable label shown for the attribute.
The unique identifier of the attribute's definition.
The attribute's machine name, unique within the account.
AttributeType!} required>
The data type of the attribute's value.
JSON}>
The attribute's value, resolved to the typed JSON form for its `type` — read `type` to know the shape. E.g. SHORT\_TEXT → a string, WEIGHT → \{ value, unit }, MONEY → \{ amount, currency }. Null if unset. See AttributeType for each type's shape.
DateTime!} required>
When the record was created.
The product family's long-form description.
The id of this product family.
ProductFamilyImage}>
The first (default) image for this family, if any.
**Requires:** [`products_read`](/docs/api-reference/v3/reference/scopes#scope-products_read)
Alternative text describing the image.
Whether this is the default image.
The id of this image.
The image's ordering position.
The public URL of the image.
ProductFamilyImageConnection!} required>
A paginated list of the family's images.
**Requires:** [`products_read`](/docs/api-reference/v3/reference/scopes#scope-products_read)
**Arguments**
Forward pagination cursor — returns items after it. Pass an `edges[].cursor` or `pageInfo.endCursor` from a previous page.
Backward pagination cursor — returns items before it. Pass an `edges[].cursor` or `pageInfo.startCursor` from a previous page.
Forward pagination: returns the first N items (max 100, default 25). Use with `after`; mutually exclusive with `last`/`before`.
Backward pagination: returns the last N items (max 100, default 25). Use with `before`; mutually exclusive with `first`/`after`.
**Fields**
[ProductFamilyImageEdge!]!} required>
The list of edges (each a node plus its pagination `cursor`).
[ProductFamilyImage!]!} required>
The nodes in this page, without the edge/cursor wrapper — a convenience over `edges`.
PageInfo!} required>
Pagination metadata for the current page.
[ProductFamilyOption!]!} required>
The variant options (e.g. Size, Color) for this family.
The id of this option.
The option's name (e.g. Size).
The option's ordering position within the family.
The allowed values for this option (e.g. S, M, L).
ProductConnection!} required>
A paginated list of the products (variants) in this family.
**Requires:** [`products_read`](/docs/api-reference/v3/reference/scopes#scope-products_read)
**Arguments**
Forward pagination cursor — returns items after it. Pass an `edges[].cursor` or `pageInfo.endCursor` from a previous page.
Backward pagination cursor — returns items before it. Pass an `edges[].cursor` or `pageInfo.startCursor` from a previous page.
Forward pagination: returns the first N items (max 100, default 25). Use with `after`; mutually exclusive with `last`/`before`.
Backward pagination: returns the last N items (max 100, default 25). Use with `before`; mutually exclusive with `first`/`after`.
**Fields**
[ProductEdge!]!} required>
The list of edges (each a node plus its pagination `cursor`).
[Product!]!} required>
The nodes in this page, without the edge/cursor wrapper — a convenience over `edges`.
PageInfo!} required>
Pagination metadata for the current page.
Free-form tags applied to the product family.
The product family's title.
DateTime!} required>
When the record was last updated.
The vendor or manufacturer of the product family.
PageInfo!} required>
Pagination metadata for the current page.
Cursor of the last edge in this page; pass to `after` to page forward.
Whether more items exist after this page (drives forward pagination with `first`/`after`).
Whether more items exist before this page (drives backward pagination with `last`/`before`).
Cursor of the first edge in this page; pass to `before` to page backward.
## Example
```graphql theme={null}
query {
productFamilies(
after: "..."
before: "..."
first: 10
last: 10
orderBy: CREATED_AT
reverse: true
) {
nodes {
createdAt
description
id
tags
title
updatedAt
vendor
}
pageInfo {
hasNextPage
endCursor
}
}
}
```