added more API documentation

This commit is contained in:
2026-06-09 00:11:47 +02:00
parent 697f0cc1f9
commit a89d467930
8 changed files with 360 additions and 6 deletions

View File

@@ -0,0 +1,45 @@
# GET Permissions
This call gets all the permissions data.
#### Location
```
/api/v1/portal-management/permissions/
```
#### Permissions required
`admin-access-control-permissions` RO.
#### Body parameters
None.
### Example Body (json)
None.
### Example Request
```php
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => $baseUrl . '/api/v1/portal-management/permissions/',
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . $token,
'Content-Type: application/json'
]
));
$response = curl_exec($curl);
curl_close($curl);
echo $response;
```
### Example Response
```json
```
#### Known errors or issues.
None are known at the time
If you do encounter issues and get an http code in return, check the response codes on this page.