v2

latestOpenAPI 3.0.32026-08-07222102695.9 KB

Product

List products

get/products

Query parameters

pageinteger

per_pageinteger

sortstring[]

Comma separated search fields. See: Ordering

[
  "created_at:desc"
]

order'asc' | 'desc'

q[]string[]

Filter result by one or more fields.

See Filtering Results

Available filters:

Value	Format
archived_at	date-time
created_at	date-time
id	int64
name	string
tax_id	int64
updated_at	date-time

Response

successful operation

total_entriesinteger

Example response

{
  "products": [
    {
      "links": {
        "self": "https://api.au1.cliniko.com/v1/products/1"
      },
      "product_supplier": {
        "links": {
          "self": "https://api.au1.cliniko.com/v1/product_suppliers/1"
        }
      },
      "stock_adjustments": {
        "links": {
          "self": "https://api.au1.cliniko.com/v1/stock_adjustments?q%5B%5D=product_id%3A%3D1"
        }
      },
      "tax": {
        "links": {
          "self": "https://api.au1.cliniko.com/v1/taxes/1"
        }
      }
    }
  ],
  "total_entries": 1,
  "links": {
    "self": "https://api.au1.cliniko.com/v1/products?page=2",
    "previous": "https://api.au1.cliniko.com/v1/products?page=1",
    "next": "https://api.au1.cliniko.com/v1/products?page=3"
  }
}