List Products

GET https://app.alaaqat.com/api/products

Lists your products, newest first. Your API key needs the product-index ability.

The list holds the products the team member who created the key can see in the app: all of them with View Products, or only the ones they or their teams own with View Team's Products or View User's Products.

Header

{
    "Accept": "application/json"
}

Query parameters

This endpoint accepts the Pagination parameters, with up to 250 products a page, and supports Complex Filtration.

Key Type Default Description
search string - Search by name.
complex_filters array [] Filter by property values. See Complex Filtration.
forAssociationType string - With forAssociationId, lists only the products linked to one record. See Associations.
forAssociationId string - The _id of the record whose linked products you want.

Response

200 OK, or 206 Partial Content when more pages follow. The products are under data, each with its property values under properties. See Pagination for links and meta.

{
    "data": [
        {
            "properties": {
                "_id": "6656b1c2d3e4f5a6b7c8d901",
                "name": "Ergonomic office chair",
                "sku": "CH-ERGO-01",
                "price": 120,
                "cost": 74.5,
                "status": "available",
                "description": "Adjustable height and lumbar support, black mesh back.",
                "owner": 12,
                "created_by": 12,
                "updated_at": "2026-10-20T09:30:00.000000Z",
                "created_at": "2026-10-20T09:30:00.000000Z"
            },
            "account_id": 1024
        },
        {
            "properties": {
                "_id": "6656b1c2d3e4f5a6b7c8d902",
                "name": "Standing desk",
                "sku": "DK-STAND-02",
                "price": 340,
                "cost": 210,
                "status": "available",
                "description": "Electric height adjustment, oak top.",
                "owner": 12,
                "created_by": 12,
                "updated_at": "2026-10-18T11:00:00.000000Z",
                "created_at": "2026-10-18T11:00:00.000000Z"
            },
            "account_id": 1024
        }
    ],
    "links": {
        "first": "https://app.alaaqat.com/api/products?page=1",
        "last": "https://app.alaaqat.com/api/products?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "links": [
            {
                "url": null,
                "label": "« Previous",
                "active": false
            },
            {
                "url": "https://app.alaaqat.com/api/products?page=1",
                "label": "1",
                "active": true
            },
            {
                "url": null,
                "label": "Next »",
                "active": false
            }
        ],
        "path": "https://app.alaaqat.com/api/products",
        "per_page": 15,
        "to": 2,
        "total": 2
    }
}