Medipim BE - API V4

Developer documentation

POST /v4/public-categories/query

(Last updated: 20/12/2024)

Request

Method

POST

URL

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

Headers

Body

  • filter: one of the filters below; filters can be combined using and, or & not. (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 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": "skin", "locale": "en"}}
{"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

  • meta:
    • total: total number of public categories (integer)
    • page:
      • no: 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 public category (integer, unique)
    • name.{...}: Name of the public category (string, localized)
    • parent: Id of the parent category (integer)
    • order: Sort order of the public category (integer)
    • meta:
      • createdAt: When the public category was created on Medipim (unix timestamp)
      • updatedAt: when the public category information was last updated (unix timestamp)

Notice

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

Examples