--- title: List all Products slug: list-all-products docTags: createdAt: 2026-04-21T15:22:49.957Z --- { "id": "Wccf0c4lZ9ggY9StjXJdS", "type": "api-oas-v2", "data": { "method": "GET", "url": "https://developer.digitail.io/api/v1/products", "servers": [ { "url": "https://developer.digitail.io/api/v1/products", "description": "Sandbox server (uses test data)" }, { "url": "https://vet.digitail.io/api/v1/products", "description": "Production server (uses live data)" } ], "name": "List all Products", "description": "

Permissions needed: NONE\nSearch for products in the clinic

", "contentType": "application/json", "request": { "pathParameters": [], "headerParameters": [ { "name": "accept", "type": "string", "kind": "optional", "description": "Generated from available response content types", "enum": [ "application/json" ], "default": "application/json" } ], "queryParameters": [ { "kind": "optional", "name": "filter[updated_from]", "type": "string", "description": "

Returns only the products updated after this datetime (exclusive). The value must be a UTC ISO 8601 timestamp with a Z suffix, for example 2020-08-16T08:56

.000000Z. Timezone offsets such as +02
are rejected. Use it together with filter[updated_to] to pull only the products changed since your last sync.

", "format": "date-time" }, { "kind": "optional", "name": "filter[updated_to]", "type": "string", "description": "

Returns only the products updated at or before this datetime (inclusive). The value must be a UTC ISO 8601 timestamp with a Z suffix, for example 2020-08-16T08:56

.000000Z. Timezone offsets such as +02
are rejected.

", "format": "date-time" }, { "kind": "optional", "name": "filter[search]", "type": "string", "description": "Searching by product name" }, { "kind": "optional", "name": "filter[service_package_id]", "type": "integer", "description": "" }, { "kind": "optional", "name": "filter[categories]", "type": "array", "description": "Categories Ids", "schema": [], "itemType": "integer", "customType": "integer[]" }, { "kind": "optional", "name": "filter[producer_ids]", "type": "array", "description": "", "schema": [], "itemType": "integer", "customType": "integer[]" }, { "kind": "optional", "name": "filter[aaha_codes]", "type": "array", "description": "", "schema": [], "itemType": "string", "customType": "string[]" }, { "kind": "optional", "name": "filter[status]", "type": "string", "description": "

Status: active, inactive

", "default": "active", "enum": [ "active", "inactive", "both" ] }, { "kind": "optional", "name": "filter[only_in_stock]", "type": "boolean", "description": "", "default": "false" }, { "kind": "optional", "name": "filter[mapped_to_external_products]", "type": "boolean", "description": "

Return only products that are mapped (true) or not mapped (false) to external products. If omitted, all products will be returned.

" }, { "kind": "optional", "name": "filter[external_product_provider]", "type": "string", "description": "

Should be used in conjuction with filter[mapped_to_external_products] to indicate to external products of which provider returned product should be or not be mapped to

", "enum": [ "cdmv", "midwest", "nsv" ] }, { "kind": "optional", "name": "filter[exclude_newly_auto_created]", "type": "boolean", "description": "" }, { "kind": "optional", "name": "filter[subset]", "type": "string", "description": "

Only products in specified category group (supports: 'vaccination')

" }, { "kind": "optional", "name": "filter[is_consumable]", "type": "boolean", "description": "" }, { "kind": "optional", "name": "filter[vat]", "type": "number", "description": "

VAT rate in percents (e.g. 23)

" }, { "kind": "optional", "name": "sort", "type": "array", "description": "

Order by field(s) (name,aaha_code,vat) Use a minus before for descending order. Default: name

", "schema": [], "itemType": "string", "customType": "string[]" }, { "kind": "optional", "name": "include", "type": "string", "description": "

Additional info to include: productCategory,stock,nirProducts,nirProducts.nirStocks,aahaCategory,producer,taskTemplates,externalProducts,taxRates

" } ], "bodyDataParameters": [], "formDataParameters": [], "oAuthParameters": [ { "id": "passport", "name": "passport", "kind": "optional", "type": "oauth2", "description": "Laravel passport oauth2 security.", "oauth2Flows": { "authorizationCode": { "authorizationUrl": "https://digitail.test/oauth/authorize", "tokenUrl": "https://digitail.test/oauth/token", "refreshUrl": "https://digitail.test/oauth/token" } } }, { "id": "Bearer", "name": "Bearer", "kind": "optional", "type": "http", "scheme": "bearer" } ], "cookieParameters": [] }, "responses": [ { "statusCode": "200", "description": "Successful operation", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "schema": [ { "name": "data", "kind": "optional", "type": "array", "description": "", "modelRef": "#/paths/~1api~1v1~1products/post/responses/201/content/application~1json/schema/properties/data", "customType": "data[]", "schema": [] }, { "name": "links", "kind": "optional", "type": "object", "description": "", "modelRef": "#/paths/~1api~1v1~1pets/get/responses/200/content/application~1json/schema/properties/links", "customType": "links", "schema": [] }, { "name": "meta", "kind": "optional", "type": "object", "description": "", "modelRef": "#/paths/~1api~1v1~1pets/get/responses/200/content/application~1json/schema/properties/meta", "customType": "meta", "schema": [] } ], "isExpanded": true } ] } ], "hasXCodeSamples": false, "examples": { "languages": [ { "id": "cklTkhBEcvlkSMPn7otXA", "language": "curl", "label": "cURL", "code": "curl --request GET \\\n --url 'https://developer.digitail.io/api/v1/products?filter[status]=active&filter[only_in_stock]=false' \\\n --header 'accept: application/json'" }, { "id": "jg3yeaZhT1GTt_6NvpZfw", "language": "javascript", "label": "javascript", "code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"application/json\");\nmyHeaders.append(\"content-type\", \"application/json\");\n\nvar requestOptions = {\n method: 'GET',\n headers: myHeaders,\n redirect: 'follow'\n};\n\nfetch(\"https://developer.digitail.io/api/v1/products?filter[status]=active&filter[only_in_stock]=false\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));" }, { "id": "kOci1kzv6UE-600usFLhL", "language": "ruby", "label": "Ruby", "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://developer.digitail.io/api/v1/products?filter[status]=active&filter[only_in_stock]=false\")\n\nhttps = Net::HTTP.new(url.host, url.port)\nhttps.use_ssl = true\n\nrequest = Net::HTTP::Get.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/json\"\n\nresponse = https.request(request)\nputs response.read_body\n" }, { "id": "G11qY5wpi8m_Z_gHAejXh", "language": "python", "label": "Python", "code": "import requests\nimport json\n\nurl = \"https://developer.digitail.io/api/v1/products?filter[status]=active&filter[only_in_stock]=false\"\n\npayload = {}\nheaders = {\n 'accept': 'application/json',\n 'content-type': 'application/json'\n}\n\nresponse = requests.request(\"GET\", url, headers=headers, data=payload)\n\nprint(response.text)\n" } ], "selectedLanguageId": "cklTkhBEcvlkSMPn7otXA" }, "results": { "languages": [ { "id": "NrdbK1mN9kC9cW-rz9Apc", "language": "200", "code": "// Successful operation\n{\n \"data\": [\n \"\"\n ],\n \"links\": {},\n \"meta\": {}\n}" } ], "selectedLanguageId": "NrdbK1mN9kC9cW-rz9Apc" } }, "children": [ { "text": "" } ] }