Products

As the name suggests, products are a core part of House Check. On this page, we'll dive into the different order endpoints you can use to manage products programmatically. We'll look at how to query products.

The product model

The product model contains all the information about your products.

Properties

  • Name
    name
    Type
    string
    Description

    Name of the product.

  • Name
    category
    Type
    string
    Description

    Category of the property.


GET/api/products

List all products

This endpoint allows you to retrieve a list of all your products.

Request

GET
/api/products
curl --location 'https://housecheck.be/api/products/' \
    --header 'Accept: application/json' \
    --header 'Authorization: Bearer {token}' \

Response 200

{
    "data": [
        {
            "id": 43,
            "name": "Asbestattest gemeenschappelijke delen",
            "category": "2.4"
        },
        {
            "id": 44,
            "name": "Asbestattest niet-residentieel (Eerste inventarisatie)",
            "category": "2.2"
        },
        {
            "id": 45,
            "name": "Asbestattest niet-residentieel (Periodiek)",
            "category": "2.2"
        },
        {
            "id": 46,
            "name": "Asbestattest residentieel",
            "category": "2.2"
        },
        ...
    ]
}