Permissions API

Get permission

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

get/v2/permissions/{permissionId}

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.

Changes

Changed in 3 of the 92 revisions of this API.5

    • ○

      the response property / became required for the status

      response-property-became-required

    • ○

      the response property / became required for the status

      response-property-became-required

    • ○

      added the non-success response with the status

      response-non-success-status-added

    • ○

      the endpoint scheme security advancedAccessToken was added to the API

      api-security-added

    • ○

      the endpoint scheme security organizationAccessToken was removed from the API

      api-security-removed

    This revision also has 4 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Of the 92 revisions, 9 have no diff computed.