---
title: "List projects"
method: GET
path: "/api/v1/projects"
tags: ["Project"]
---

# List projects

`GET /api/v1/projects`

Returns a collection of projects

## 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` 'search' | 'id' | 'name' | 'keyName' | 'description' | 'currency' | 'normalTaxRate' | 'reducedTaxRate' | 'storageProcess' | 'pickingProcess'
  - `op` 'equals' | 'notEquals' | 'in' | 'notIn' | 'exactlyIn' | 'allIn' | 'allNotIn' | 'contains' | 'notContains' | 'startsWith' | 'endsWith' | 'greaterThan' | 'lessThan' | 'is' | 'lessThanOrEquals' | 'greaterThanOrEquals'
  - `value` union
    - string — Used for the operations 'equals', 'notEquals', 'contains', 'notContains', 'startsWith', 'endsWith' and 'is'.
    - string[] — Used for the operations 'in', 'notIn', 'exactlyIn', 'allIn' and 'allNotIn'.
- `order` object[]
  - `field` 'id' | 'name' | 'keyName' | 'description' | 'currency' | 'normalTaxRate' | 'reducedTaxRate' | 'storageProcess' | 'pickingProcess'
  - `dir` 'asc' | 'desc'

## Response `200`

Operation completed successfully.

- object
  - `data` object[]
    - `id` string — Resource identifier.
    - `name` string
    - `keyName` string
    - `description` string
    - `currency` string
    - `normalTaxRate` number, float
    - `reducedTaxRate` number, float
    - `storageProcess` 'none' | 'order' | 'orderPointOfSale'
    - `pickingProcess` 'invoiceMail' | 'shipmentNote' | 'shipmentNoteScan' | 'shipmentNoteWarehouse' | 'shipmentNoteWarehouseScan' | 'twoLevel'
    - `defaultCustomerPaymentMethod` object, nullable — Default payment method used for customers in this project
      - `id` string — Resource identifier.
      - `type` string — Type of the payment method
      - `designation` string — Name of the payment method
    - `defaultSupplierPaymentMethod` object, nullable — Default payment method used for suppliers in this project
      - `id` string — Resource identifier.
      - `type` string — Type of the payment method
      - `designation` string — Name of the payment method
    - `defaultShippingMethod` object, nullable — Default shipping method used for this project
      - `id` string — Resource identifier.
      - `type` string — Type of the shipping method
      - `designation` string — Name of the shipping method
    - `freeFields` object[], nullable
      - `id` string, required
      - `value` string, required
  - `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

- `403` — Unable to authorize the client
- `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)