MOmollie
Permissions API

Get permission

Changed on

Retrieve a single permission by its ID, and see if the permission is granted to the current access token.

get/v2/permissions/{permissionId}

Request

  • Base URL
    https://api.mollie.com
  • URL
    https://api.mollie.com/v2/permissions/{permissionId}
  • Auth
    • HTTP bearer
    • or OAuth 2
      Authorization code: https://my.mollie.com/oauth2/authorize
      Token URL: https://api.mollie.com/oauth2/tokens

Query parameters

testmodeboolean

You can enable test mode by setting the testmode query parameter to true.

Test entities cannot be retrieved when the endpoint is set to live mode, and vice versa.

Headers

idempotency-keystring
Example:123e4567-e89b-12d3-a456-426

A unique key to ensure idempotent requests. This key should be a UUID v4 string.

Response

The permission object.

resourcestring required

Indicates the response contains a permission object. Will always contain the string permission for this endpoint.

idstring required
descriptionstring required

A short description of what kind of access the permission enables.

grantedboolean required

Whether this permission is granted to the app by the organization.

Example response

{
  "resource": "permission",
  "id": "payments.read",
  "description": "View your payments",
  "granted": true,
  "_links": {
    "self": {
      "href": "https://...",
      "type": "application/hal+json"
    },
    "documentation": {
      "href": "https://...",
      "type": "application/hal+json"
    }
  }
}

Changes

  • 4cedd56d8fd9Revision changes
    • info

      the response property / became required for the status

    • info

      the response property / became required for the status

  • 7cab62b21830Revision changes
    • info

      added the non-success response with the status