Medipim BE - API V4

Developer documentation

/v4/public-categories/query

(Last updated: 23/11/2022)

Request

Method

POST

URL

https://api.medipim.be/v4/public-categories/query

Headers

Body

Filter Description Parameters Examples
{"id": ...} Matches public category by Medipim ID. Integer {"id": 1}
{"parent": ...} Matches public category by their parent category ID. Integer {"parent": 1}
{"search": ...} Matches public category by searching their name. String {"search": {"query": "huid", "locale": "nl"}}
{"and": [...]} Matches public categories that match all of the given filters. A list of filters. {"and": [{"id": 10}, {"parent": 1}]}
{"or": [...]} Matches public categories that match any of the given filters. A list of filters. {"or": [{"id": 1}, {"parent": 2}]}
{"not": ...} Matches public categories that do not match the given filter. A filter. {"not": {"parent": "1"}}

Response

Body

Notice

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

Examples