Medipim BE - API V4

Developer documentation

POST /v4/organizations/check/subscription

(Last updated: 27/02/2024)

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

This endpoint allows for checking (active) Medipim subscriptions for an organization.

Request

Method

POST

URL

https://api.medipim.be/v4/organizations/check/subscription

Headers

Body

  • filter: same filters as the query endpoint. (required)

Response

Body

  • organization: Medipim ID of the organization (integer)
  • name: Name of the organization (string)
  • activeSubscriptions[]: List of active subscriptions for organization
    • type: Subscription type id (string)
    • name.{...}: Name of the subscription type (string, localized)
    • start: When the subscription starts (unix timestamp)
    • end: When the subscription ends (unix timestamp)
  • apiKeys: List of API keys associated with the organization users
    • id: API key ID (integer)
    • user: Medipim ID of associated user (integer)
    • name: Text describing what the API key should be used for (string)
    • secret: Text hash that is used to indentify the API key (string)
    • isEnabled: Status of the API key (boolean)