# List categories

> Retrieve a paginated list of categories.

`GET /rest/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 `X-Flowkiwi-Locale` to read the translatable `name` in a given locale.

## Headers

| Name                         | Type      | Required | Description                                                                                                                                       |
| ---------------------------- | --------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------- |
| `X-Flowkiwi-Organization-Id` | `string`  | Yes      | The organization the request acts as. Determines the identity, permissions and ownership applied when reading or modifying data on the instance.  |
| `X-Flowkiwi-Locale`          | `string`  | -        | Specifies the locale for properties that support localization. If not provided, the default locale will be used.                                  |
| `X-Flowkiwi-Locale-Fallback` | `boolean` | -        | Enables the use of a fallback locale. If a property lacks a translation for the requested locale, the value from 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                                                                                                                                                                                                                                                                                                     |
| `status`           | `string`   | -        |                                                                                                                                                                                                                                                                                                                                  |
| `status[]`         | `string[]` | -        |                                                                                                                                                                                                                                                                                                                                  |
| `order[createdAt]` | `string`   | -        |                                                                                                                                                                                                                                                                                                                                  |
| `order[updatedAt]` | `string`   | -        |                                                                                                                                                                                                                                                                                                                                  |

## Response

**200** - Category collection

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

## Errors

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

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

## Examples

### Example request

```bash
curl -X GET 'https://<tenant>.product-management.flowkiwi.net/rest/api/categories' \
  -H 'Authorization: Bearer {token}' \
  -H 'X-Flowkiwi-Organization-Id: <org_id>' \
  -H 'Accept: application/ld+json'
```

### Example response

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