# List categories

> Retrieve a paginated list of categories.
{/* generated:versioned-pages - edit _pm-authored, not this file */}

`GET /api/categories`

Retrieves the collection of Category resources.

Returns a paginated collection of categories in the current organization. Each carries its `parent` and `childrens`, so you can reconstruct the tree. Set `Flowkiwi-Locale` to read the translatable `name` in a given locale.

## Headers

| Name              | Type     | Required | Description                                                                                                      |
| ----------------- | -------- | -------- | ---------------------------------------------------------------------------------------------------------------- |
| `Flowkiwi-Locale` | `string` | -        | Specifies the locale for properties that support localization. If not provided, the default locale will be used. |

## Query parameters

| Name               | Type       | Required | Description                                                                                                                                                                                                                                                                                                                      |
| ------------------ | ---------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `expand`           | `string`   | -        | Comma-separated list of relations to embed as full objects instead of IRI strings. Supported values: `parent` (embeds the direct parent, max 1 level - grand-parents stay as IRIs), `children` (embeds direct children, max 1 level - grand-children stay as IRIs). Tokens are independent; unknown values are silently ignored. |
| `page`             | `integer`  | -        | The collection page number                                                                                                                                                                                                                                                                                                       |
| `itemsPerPage`     | `integer`  | -        | The number of items per page                                                                                                                                                                                                                                                                                                     |
| `properties[]`     | `string[]` | -        | Allows you to reduce the response to contain only the properties you need. If your desired property is nested, you can address it using nested arrays. Example: properties[]={propertyName}&properties[]={anotherPropertyName}&properties[{nestedPropertyParent}][]={nestedProperty}                                             |
| `id[]`             | `string[]` | -        | Only the items with one of these ids, each a UUID or the item IRI.                                                                                                                                                                                                                                                               |
| `status`           | `string`   | -        | Category status                                                                                                                                                                                                                                                                                                                  |
| `status[]`         | `string[]` | -        | Category status                                                                                                                                                                                                                                                                                                                  |
| `name`             | `string`   | -        | Filter on the translated "name" field (case-insensitive partial match, uses the Flowkiwi-Locale header).                                                                                                                                                                                                                         |
| `order[createdAt]` | `string`   | -        | Category order[createdAt]                                                                                                                                                                                                                                                                                                        |
| `order[updatedAt]` | `string`   | -        | Category order[updatedAt]                                                                                                                                                                                                                                                                                                        |

## Response

**200** - Category collection

| Property     | Type         | Required | Description |
| ------------ | ------------ | -------- | ----------- |
| `search`     | `object`     | -        |             |
| `totalItems` | `integer`    | -        |             |
| `view`       | `object`     | -        |             |
| `member`     | `Category[]` | Yes      |             |

## Errors

**403** - Access denied. The caller is missing one or more permissions required for this operation.

| Property             | Type               | Required | Description                                                                                                            |
| -------------------- | ------------------ | -------- | ---------------------------------------------------------------------------------------------------------------------- |
| `@context`           | `string \| object` | -        |                                                                                                                        |
| `@id`                | `string`           | Yes      |                                                                                                                        |
| `@type`              | `string`           | Yes      |                                                                                                                        |
| `detail`             | `string`           | -        |                                                                                                                        |
| `missingPermissions` | `string[]`         | -        | Permissions that the caller is missing for this operation. Present only when the 403 is caused by a denied permission. |
| `status`             | `integer`          | -        |                                                                                                                        |
| `title`              | `string`           | -        |                                                                                                                        |
| `type`               | `string`           | -        |                                                                                                                        |

## Examples

### Example request

```bash
curl -X GET 'https://<tenant>.product-management.flowkiwi.net/api/categories' \
  -H 'Authorization: Bearer {access_token}' \
  -H 'Flowkiwi-Api-Version: unstable' \
  -H 'Accept: application/ld+json'
```

### Example response

```json
{
  "@context": "/api/contexts/Category",
  "@id": "/api/categories",
  "@type": "Collection",
  "member": [
    {
      "@context": "/api/contexts/Category",
      "@id": "/api/categories/019afd01-1a2b-7c3d-8e4f-0a1b2c3d4e5f",
      "@type": "Category",
      "attributes": [],
      "children": [
        "/api/categories/019afd02-2b3c-7d4e-9f50-1a2b3c4d5e6f"
      ],
      "createdAt": "2026-01-15T09:30:00+00:00",
      "id": "019afd01-1a2b-7c3d-8e4f-0a1b2c3d4e5f",
      "name": "Apparel",
      "parent": null,
      "products": [],
      "status": "/api/statuses/ACTIVE",
      "updatedAt": "2026-02-03T14:45:12+00:00"
    },
    {
      "@context": "/api/contexts/Category",
      "@id": "/api/categories/019afd02-2b3c-7d4e-9f50-1a2b3c4d5e6f",
      "@type": "Category",
      "attributes": [
        "/api/attribute_definitions/019afd10-3c4d-7e5f-8a60-2b3c4d5e6f70",
        "/api/attribute_definitions/019afd11-4d5e-7f60-9b71-3c4d5e6f7081"
      ],
      "children": [],
      "createdAt": "2026-01-15T09:30:00+00:00",
      "id": "019afd02-2b3c-7d4e-9f50-1a2b3c4d5e6f",
      "name": "Shoes",
      "parent": "/api/categories/019afd01-1a2b-7c3d-8e4f-0a1b2c3d4e5f",
      "products": [
        "/api/products/019af93e-420e-79f8-800b-6680f03dce20"
      ],
      "status": "/api/statuses/ACTIVE",
      "updatedAt": "2026-02-03T14:45:12+00:00"
    }
  ],
  "totalItems": 2
}
```