GET
/
catalogue
/
products
curl -X GET \
 /catalogue/products \
 --header "Authorization: Bearer <token>"
{
  "data": [
    {
      "id": "ad8f1c2c-3b1c-4b0a-8b0a-0b0b0b0b0b0b",
      "productFamilies": [
        {
          "id": "ad8b3b9e-5b0a-4e1a-8b0a-4e1a8b0a4e1a",
          "name": "Team Packages"
        }
      ],
      "name": "Basic",
      "description": "For small teams.",
      "internalName": "Basic (Weekly)",
      "number": "M-1234",
      "type": "product",
      "measurement": {
        "id": "ad8f1c2c-3b1c-4b0a-8b0a-0b0b0b0b0b0b",
        "unit": {
          "id": {},
          "name": "Stück"
        },
        "code": "users",
        "description": "The number of users.",
        "aggregationType": "<any>",
        "fairBilling": true,
        "type": "<any>"
      },
      "invoiceVisibility": "always",
      "costCentre": {
        "id": "ad8f1c9c-4f0a-4e1a-8b1a-9c4d9c4d9c4d",
        "name": "Cost Centre",
        "code": "CC",
        "type": "KOST1",
        "createdAt": "2021-01-01T00:00:00+00:00",
        "updatedAt": "2021-01-01T00:00:00+00:00"
      },
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "taxGroup": {
        "id": "00000000-0000-0000-0000-000000000000",
        "internalDescription": "19%",
        "reverseChargeType": "REVERSE_CHARGE",
        "type": "standard"
      },
      "isArchived": true,
      "customFields": {
        "field1": "value1",
        "field2": "value2"
      }
    }
  ],
  "meta": {
    "pagination": {
      "totalItems": 123,
      "itemsPerPage": 123,
      "currentPage": 123,
      "lastPage": 123,
      "pageTotalItems": 123
    }
  }
}

Authorizations

​
Authorization
string
header
required

Value for the Authorization header parameter.

Query Parameters

​
locale
string

Defines the locale to use for translations. Defaults to tenant locale.

​
showArchived
boolean
default:false

Defines if archived products should be included in the result.

​
page
integer
default:1

The collection page number

​
limit
integer
default:30

The number of items per page

Required range: 0 <= x <= 100
​
groups[]
enum<string>[]
​
type
string
​
type[]
string[]
​
productFamilies
string
​
productFamilies[]
string[]
​
number
string
​
number[]
string[]

Response

200
application/json

Product collection

The response is of type object.