58 lines
1.4 KiB
Markdown
58 lines
1.4 KiB
Markdown
# GET Modules
|
|
This call gets all the Sentri modules information.
|
|
|
|
#### Location
|
|
```
|
|
/api/v1/portal-management/modules/
|
|
```
|
|
|
|
#### Permissions required
|
|
`admin-modules` RO
|
|
|
|
#### Body parameters
|
|
| Parameter | Type | Required | Description |
|
|
| -------------------- | ------ | -------- | ----------- |
|
|
| builder[0][where][0] | string | no | |
|
|
| builder[0][where][1] | string | no | |
|
|
|
|
### Example Body (json)
|
|
None.
|
|
|
|
### Example Request
|
|
```php
|
|
|
|
$curl = curl_init();
|
|
curl_setopt_array($curl, array(
|
|
CURLOPT_URL => $baseUrl . '/api/v1/portal-management/modules/' . '?builder[0][where][0]=module_uuid&builder[0][where][1]=0f044275-1744-444c-9627-736310d7997e',
|
|
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
|
|
}
|
|
]
|
|
```
|
|
|
|
#### 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. |