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,64 @@
# GET Modules
This call gets all the Sentri modules information.
#### Location
```
/api/v1/portal-management/modules/
```
#### Permissions required
`admin-modules` 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/modules/',
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
[
{
"module_uuid":"0f044275-1744-444c-9627-736310d7997e",
"module_name":"Portal Management",
"module_slugify":"portal-management",
"module_enabled":1,
"module_description":null,
"module_create_timestamp":1762695975,
"module_modified_timestamp":null
},
{
"module_uuid":"247aa89e-2ffa-4cba-8672-3fef451255b7",
"module_name":"Customers",
"module_slugify":"customers",
"module_enabled":1,
"module_description":null,
"module_create_timestamp":1762696058,
"module_modified_timestamp":null
}
]
```
#### 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.