---
title: "List warehouses"
method: GET
path: "/api/v1/warehouses"
tags: ["Warehouse"]
---

# List warehouses

`GET /api/v1/warehouses`

This endpoint is only available as beta version and will introduce breaking changes without further notice or versioning. Returns a list of active warehouses.

## Query parameters

- `page` object
  - `number` string, required — Page number should be an integer greater than or equal to 1
  - `size` string, required — Page size should usually be an integer between 10 and 50.
- `filter` object[]
  - `key` 'designation' | 'id'
  - `op` 'greaterThan' | 'lessThan' | 'equals' | 'notEquals' | 'in' | 'notIn'
  - `value` union
    - string
    - string[] — Used for the operations 'in', 'notIn', 'exactlyIn', 'allIn' and 'allNotIn'.

## Response `200`

Operation completed successfully.

- object
  - `data` object[] — Representation of a list of Warehouses
    - `id` string — Resource identifier.
    - `project` object, nullable — Information for the project used by a Warehouse
      - `id` string, required — Id of project
    - `designation` string — Name of the warehouse
  - `extra` object
    - `totalCount` integer, required — the total count of all items
    - `page` object, required — The pagination object containing the current page number and size
      - `number` integer, required — The current page number
      - `size` integer, required — The size of the pages

## Other responses

- `400` — IETF RFC 9457 Problem API compliant response
- `401` — Unable to authenticate the client
- `403` — Unable to authorize the client
- `404` — Resource was not found or not enough access privileges
- `406` — Requested resource representation does not exist.
- `429` — Too many API calls made.

---

[API](https://skmtc.net/xentral/apis/xentral-api.md) · [All operations](https://skmtc.net/xentral/apis/xentral-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/xentral/xentral-api/revisions/8a27ba392442/schema)