Medipim BE - API V4

Developer documentation

/v4/brands/query

(Last updated: 16/05/2023)

Request

Method

POST

URL

https://api.medipim.be/v4/brands/query

Headers

Body

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

Notice

The meta page section will only be returned if you added a page in the request body.

Examples