/v4/active-ingredients/query
(Last updated: 03/10/2023)
Request
Method
POST
URL
https://api.medipim.fr/v4/active-ingredients/query
Headers
Body
filter: one of the filters below; filters can be combined usingand,or¬. (optional)page(optional; if none is provided all results are returned)no: page number (zero-based)size: one of 10, 50, 100 or 250 (defaults to 100)
| Filter | Description | Parameters | Examples |
|---|---|---|---|
{"id": ...} |
Matches active ingredient by Medipim ID. | One or more IDs | {"id": 1} or {"id": [1, 2]} |
{"search": ...} |
Matches public category by searching their name. | String | {"search": {"query": "chloride", "locale": "fr"}} |
{"and": [...]} |
Matches active ingredients that match all of the given filters. | A list of filters. | {"and": [{"id": 10}, {"search": {"query": "chloride", "locale": "fr"}]} |
{"or": [...]} |
Matches active ingredients that match any of the given filters. | A list of filters. | {"or": [{"id": 1}, {"search": {"query": "chloride", "locale": "fr"}]} |
{"not": ...} |
Matches active ingredients that do not match the given filter. | A filter. | {"not": {"id": 1}} |
Response
Body
metatotal: total number of active ingredients (integer)pageno: page number (zero-based) (integer)offset: offset of the first item in the entire resultset (integer)size: size of the page (integer)
results[]:id: Medipim ID of the active ingredient (integer)name.{fr|en|...}: Name of the active ingredient (string, localized)meta:createdAt: When the active ingredient was created on Medipim (unix timestamp)updatedAt: when the active ingredient information was last updated (unix timestamp)
Notice
The meta page section will only be returned if you added a page in the request body.