Permissions API

Get permission

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

🔑 Access with

Advanced access token

OAuth 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.

Response

The permission object.

resourcestring required

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

idstring required

The identifier uniquely referring to this permission. Example: payments.read.

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

{
  "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

No recorded changes to this operation across all 1 revision of this API.