Medipim BE - API V4

Developer documentation

POST /v4/subscription-types/query

(Last updated: 20/12/2024)

Access to this feature is restricted and depends on your subscription type.

Request

Method

POST

URL

https://api.medipim.be/v4/subscription-types/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 subscription by Medipim ID. Integer {"id": 1}
{"code": ...} Matches subscription by code. String {"code": "trial"}
{"and": [...]} Matches subscriptions that match all of the given filters. A list of filters. {"and": [{"id": 1}, {"code": "trial"}]}
{"or": [...]} Matches subscriptions that match any of the given filters. A list of filters. {"or": [{"id": 1}, {"id": 2}]}
{"not": ...} Matches subscriptions that do not match the given filter. A filter. {"not": {"code": "trial"}}
Sorting Description Parameters Examples
{"id": ...} Sort by Medipim ID "ASC" or "DESC" {"id": "ASC"} or {"id": "DESC"}

Response

Body

  • meta:
    • total: total number of subscriptions (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 subscription (integer, unique)
    • name.{...}: Name of the subscription (string, localized)
    • code: Code of the subscription (string)

Notice

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

Examples