Get My Organization Permissions

GET

/api/v2/organizations/{organization_id}/permissions/me

Describes the role the authenticated user holds on an organization. Useful when the caller only needs to check their own role in the organization.

Path Parameters:

organization_id: Identifies the organization to check.

Request Headers:

X-Authorization-Consistency-Token (optional): Pass the token from a previous permission change so this read reflects it.

Returns:

The user's details, the organization, and relations: ["admin"], ["staff"] or ["member"], or [] when the user has no role on the organization.

Current Version:

2.0.0

Request

Path Params

Header Params

Responses

🟢200

application/json

Successfully retrieved your permissions on organization

Bodyapplication/json

🟠400

🟠401

🟠404

🔴500

🔴503

Request Example

Shell

JavaScript

Java

Swift

curl --location --globoff 'https:///api/v2/organizations//permissions/me' \
--header 'Ocp-Apim-Subscription-Key: ' \
--header 'Authorization: Bearer '

Response Example

200 - Example 1

{
    "success": true,
    "message": "string",
    "data": {
        "user_id": 0,
        "first_name": "string",
        "last_name": "string",
        "email": "[email protected]",
        "organization_id": 0,
        "organization_name": "string",
        "relations": [
            "string"
        ]
    }
}

Get user permissions on a specific organization

Get all Configurations