# Get client portal settings — API reference

> Returns a Client's portal preset, incident visibility, report visibility and export setting.

Source: https://upfour.io/docs/api/clients/get-client-portal-settings

[Developers](https://upfour.io/docs/api.md)/[Clients (agency mode)](https://upfour.io/docs/api/clients.md)

Returns a Client's portal preset, incident visibility, report visibility and export setting.

GET https://app.upfour.io/v1/clients/{clientID}/portal-settings

scope client.read stable returns 200

## Parameters

| Field | Type | Description |
| --- | --- | --- |
| `clientID` required | uuid | path parameter |

## Returns

A successful request returns `200` with application/json.

Response fields 1 top-level fields

| Field | Type | Description |
| --- | --- | --- |
| `data` | ClientPortalSettingsResponse | |
| ClientPortalSettingsResponse · 10 fields FieldTypeDescription `allow_report_export` boolean `client_id` uuid Taken from the path on update. `preset` string one of`compact` `transparent` `custom` compact and transparent set all switches themselves and ignore the ones sent; custom takes them as sent. Empty means compact. `show_incidents` boolean `show_report_downtime` boolean `show_report_incidents` boolean `show_report_response_time` boolean `show_report_sla` boolean `show_reports` boolean The report views. With preset custom and this off, the report switches below are stored off. `updated_at` string (date-time) Ignored on update. | | |

## Errors

Only the errors this operation can return. Every error uses the [same envelope](https://upfour.io/docs/api/responses.md).

| Status | Code | Meaning |
| --- | --- | --- |
| 400 | [bad_request](https://upfour.io/docs/api/errors#code-bad_request) | The request is malformed or fails validation. |
| 404 | [not_found](https://upfour.io/docs/api/errors#code-not_found) | The requested resource does not exist or is outside the caller's scope. |

Every call can also return `unauthorized` (401), `rate_limit_exceeded` (429) or `internal_error` (500 / 502). See [Responses and errors](https://upfour.io/docs/api/responses.md).

[PreviousImport a client logo](https://upfour.io/docs/api/clients/import-a-client-logo.md) [NextUpdate client portal settings](https://upfour.io/docs/api/clients/update-client-portal-settings.md)

## Request

### cURL

```bash
curl -s "https://app.upfour.io/v1/clients/00000000-0000-4000-8000-000000000001/portal-settings" \
  -H "Authorization: Bearer $UP4_API_KEY"
```

### JavaScript

```javascript
const res = await fetch("https://app.upfour.io/v1/clients/00000000-0000-4000-8000-000000000001/portal-settings", {
  headers: {
    Authorization: `Bearer ${process.env.UP4_API_KEY}`,
  },
});
console.log(res.status, await res.json());
```

### Python

```python
import os
import requests

res = requests.get(
    "https://app.upfour.io/v1/clients/00000000-0000-4000-8000-000000000001/portal-settings",
    headers={"Authorization": f"Bearer {os.environ['UP4_API_KEY']}"},
)
print(res.status_code, res.json())
```

### Go

```go
package main

import (
	"fmt"
	"io"
	"net/http"
	"os"
)

func main() {
	req, _ := http.NewRequest("GET", "https://app.upfour.io/v1/clients/00000000-0000-4000-8000-000000000001/portal-settings", nil)
	req.Header.Set("Authorization", "Bearer "+os.Getenv("UP4_API_KEY"))
	res, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer res.Body.Close()
	out, _ := io.ReadAll(res.Body)
	fmt.Println(res.StatusCode, string(out))
}
```

### PHP

```php
<?php
$ch = curl_init("https://app.upfour.io/v1/clients/00000000-0000-4000-8000-000000000001/portal-settings");
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        "Authorization: Bearer " . getenv("UP4_API_KEY"),
    ],
]);
$response = curl_exec($ch);
echo curl_getinfo($ch, CURLINFO_RESPONSE_CODE), " ", $response, "\n";
curl_close($ch);
```

## Response

### 200

```json
{
  "data": {
    "allow_report_export": false,
    "client_id": "00000000-0000-4000-8000-000000000001",
    "preset": "compact",
    "show_incidents": false,
    "show_report_downtime": false,
    "show_report_incidents": false,
    "show_report_response_time": true,
    "show_report_sla": true,
    "show_reports": true,
    "updated_at": "1734-07-18T09:15:00Z"
  }
}
```

### 400

```json
{
  "error": {
    "code": "bad_request",
    "message": "The request is malformed or fails validation.",
    "request_id": "req_…"
  }
}
```

### 404

```json
{
  "error": {
    "code": "not_found",
    "message": "The requested resource does not exist or is outside the caller's scope.",
    "request_id": "req_…"
  }
}
```