Get folder permissions
curl --request GET \
--url https://{instance}.omniapp.co/api/v1/folders/{folderId}/permissions \
--header 'Authorization: Bearer <token>'import requests
url = "https://{instance}.omniapp.co/api/v1/folders/{folderId}/permissions"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://{instance}.omniapp.co/api/v1/folders/{folderId}/permissions', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{instance}.omniapp.co/api/v1/folders/{folderId}/permissions",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://{instance}.omniapp.co/api/v1/folders/{folderId}/permissions"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://{instance}.omniapp.co/api/v1/folders/{folderId}/permissions")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://{instance}.omniapp.co/api/v1/folders/{folderId}/permissions")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"permits": [
{
"id": "b2c3d4e5-f6a7-8901-bcde-f23456789012",
"userId": "b2c3d4e5-f6a7-8901-bcde-f23456789012",
"name": "Jane Smith",
"description": "jane@example.com",
"type": "user",
"direct": {
"accessBoost": false,
"isOwner": true,
"role": "OWNER"
}
},
{
"id": "c3d4e5f6-a7b8-9012-cdef-345678901234",
"name": "Jane Smith",
"description": "Organization - via Folder",
"type": "user",
"direct": {
"accessBoost": false,
"isOwner": false,
"role": "VIEWER"
}
},
{
"id": "mEhXj6ZI",
"userGroupId": "mEhXj6ZI",
"name": "Data Analysts",
"type": "userGroup",
"direct": {
"accessBoost": false,
"isOwner": false,
"role": "EDITOR"
}
}
]
}{
"error": "<response_code>",
"message": "<error_reason>"
}{
"error": "<response_code>",
"message": "<error_reason>"
}{
"error": "<response_code>",
"message": "<error_reason>"
}{
"error": "<response_code>",
"message": "<error_reason>"
}Permissions
Get folder permissions
Retrieve the permissions on a folder.
GET
/
v1
/
folders
/
{folderId}
/
permissions
Get folder permissions
curl --request GET \
--url https://{instance}.omniapp.co/api/v1/folders/{folderId}/permissions \
--header 'Authorization: Bearer <token>'import requests
url = "https://{instance}.omniapp.co/api/v1/folders/{folderId}/permissions"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://{instance}.omniapp.co/api/v1/folders/{folderId}/permissions', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{instance}.omniapp.co/api/v1/folders/{folderId}/permissions",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://{instance}.omniapp.co/api/v1/folders/{folderId}/permissions"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://{instance}.omniapp.co/api/v1/folders/{folderId}/permissions")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://{instance}.omniapp.co/api/v1/folders/{folderId}/permissions")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"permits": [
{
"id": "b2c3d4e5-f6a7-8901-bcde-f23456789012",
"userId": "b2c3d4e5-f6a7-8901-bcde-f23456789012",
"name": "Jane Smith",
"description": "jane@example.com",
"type": "user",
"direct": {
"accessBoost": false,
"isOwner": true,
"role": "OWNER"
}
},
{
"id": "c3d4e5f6-a7b8-9012-cdef-345678901234",
"name": "Jane Smith",
"description": "Organization - via Folder",
"type": "user",
"direct": {
"accessBoost": false,
"isOwner": false,
"role": "VIEWER"
}
},
{
"id": "mEhXj6ZI",
"userGroupId": "mEhXj6ZI",
"name": "Data Analysts",
"type": "userGroup",
"direct": {
"accessBoost": false,
"isOwner": false,
"role": "EDITOR"
}
}
]
}{
"error": "<response_code>",
"message": "<error_reason>"
}{
"error": "<response_code>",
"message": "<error_reason>"
}{
"error": "<response_code>",
"message": "<error_reason>"
}{
"error": "<response_code>",
"message": "<error_reason>"
}Authorizations
Can be either an Organization API Key or Personal Access Token (PAT).
Include in the Authorization header as: Bearer YOUR_TOKEN
Path Parameters
The UUID of the folder. Use the List folders endpoint to retrieve folder IDs.
Query Parameters
The ID of the user to return folder permissions for. When omitted, the response lists all user and user group permissions on the folder. Use the List users or List embed users endpoints to retrieve user IDs.
Was this page helpful?

