/v4/brands/query
(Last updated: 22/11/2023)
Request
Method
POST
URL
https://api.medipim.be/v4/brands/query
Headers
Body
filter: one of the filters below; filters can be combined usingand,or¬. (optional)sorting: one of the sortings below. (optional; default is{"id": "ASC"})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 |
|---|---|---|---|
{"search": ...} |
Matches brands by a specific search query. | {"search": "somesearchterm"} |
|
{"id": ...} |
Matches brands by Medipim ID. | One or more IDs | {"id": 1} or {"id": [1, 2]} |
{"and": [...]} |
Matches brands that match all of the given filters. | A list of filters. | {"and": [{"id": [1, 2, ...]}, {"search": "test"}]} |
{"or": [...]} |
Matches brands that match any of the given filters. | A list of filters. | {"or": [{"id": [1, 2, ...]}, {"search": "test"}]} |
{"not": ...} |
Matches brands that do not match the given filter. | A filter. | {"not": {"id": 1}} |
| Sorting | Description | Parameters | Examples |
|---|---|---|---|
{"id": ...} |
Sort by Medipim ID | "ASC" or "DESC" |
{"id": "ASC"} or {"id": "DESC"} |
{"name": ...} |
Sort by Name | "ASC" or "DESC" |
{"name": "ASC"} or {"name": "DESC"} |
Response
Body
metatotal: total number of brands (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[]: a list of all brandsid: Medipim ID of the brand (integer)name: Name of the brand (string)meta:createdAt: When the brand was created on Medipim (unix timestamp)updatedAt: when the brand information was last updated (unix timestamp)
Notice
The meta page section will only be returned if you added a page in the request body.