MAmaqqie
Entitlements

Get registrable entitlements for a placement

Changed on

Returns the list of entitlements that the company can register for a given placement.

get/public/entitlement/v1/get-registrable-entitlements-for-placement

Request

  • Base URL
    https://api.maqqie.app (the document declares no server; this is the origin it was published from)
  • Auth
    OAuth 2
    Client credentials
    Token URLhttps://maqqie.app/auth/realms/maqqie/protocol/openid-connect/token

Query parameters

placementIdstring uuid required

Identifier of the placement.

projectIdstring uuid

Optional identifier of the project to filter entitlements by.

Response

Successfully retrieved registrable entitlements for the placement.

Example response

{
  "entitlements": [
    {
      "effectiveFrom": "2025-01-01",
      "effectiveUntilInclusive": "2025-12-31"
    }
  ]
}

Changes

  • f9510f3f4b22Revision changes
    • breaking

      the response's body type changed from no type to object for status

    • breaking

      the response's body type changed from no type to object for status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

  • 3352b56bb8feRevision changes
    • breaking

      the response's body type changed from object to no type for status

    • breaking

      the response's body type changed from object to no type for status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status