# Get report branding — API reference

> Returns report name, footer, website, primary color, logo data and custom-domain settings.

Source: https://upfour.io/docs/api/organization/get-report-branding

[Developers](https://upfour.io/docs/api.md)/[Organization](https://upfour.io/docs/api/organization.md)

Returns report name, footer, website, primary color, logo data and custom-domain settings.

GET https://app.upfour.io/v1/organization/report-branding

scope organization.read stable returns 200

## Returns

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

Response fields 1 top-level fields

| Field | Type | Description |
| --- | --- | --- |
| `data` | ReportBrandingSettingsResponse | |
| ReportBrandingSettingsResponse · 9 fields FieldTypeDescription `domain_page_id` uuid  · nullable A status page of the Company with a custom domain; reports are then shared on that domain. null uses up4's own address. `footer_text` string Up to 240 characters. `logo_data_url` string The logo as a data:image/png;base64 or data:image/jpeg;base64 URL, at most 1 MB. Empty together with logo_url removes the logo. `logo_url` string An http(s) address of a PNG or JPEG. up4 fetches it and stores a copy; when it is set, logo_data_url is derived from it. `name` string The agency name on reports. Empty uses the Company name. `primary_color` string #RRGGBB; defaults to #294E9E. `website_url` string An http(s) address without credentials. `domain` string Read-only: the custom domain of domain_page_id. `domain_status` string one of`none` `pending_dns` `queued` `provisioning` `active` `failed` `disabled` `conflict_requires_review` `unavailable` Read-only: the state of that domain; shared links only work on it while it is active. | | |

## 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. |
| 400 | [file_empty](https://upfour.io/docs/api/errors#code-file_empty) | The uploaded file is empty. **When:** Uploading a logo or image with no content. **Fix:** Upload a file that has content. |
| 413 | [file_too_large](https://upfour.io/docs/api/errors#code-file_too_large) | The uploaded file is over the size limit. **When:** Uploading a logo or image larger than details.max_bytes. **Fix:** Reduce the file size and upload again. |
| 400 | [file_type_unsupported](https://upfour.io/docs/api/errors#code-file_type_unsupported) | The file's type is not accepted for this upload. **When:** Uploading a file whose type is not one of the formats the operation accepts; details.formats lists them. **Fix:** Upload a file in one of details.formats. |
| 400 | [image_dimensions_too_large](https://upfour.io/docs/api/errors#code-image_dimensions_too_large) | The image has more pixels than allowed. **When:** Uploading an image with more pixels than details.max_pixels. **Fix:** Scale the image down and upload it again. |
| 400 | [image_invalid](https://upfour.io/docs/api/errors#code-image_invalid) | The file is not a readable image. **When:** Uploading a file with an image type that cannot be decoded. **Fix:** Export the image again and upload the new file. |
| 400 | [logo_fetch_failed](https://upfour.io/docs/api/errors#code-logo_fetch_failed) | The logo could not be fetched from the address given. **When:** Importing a client logo from a URL that cannot be reached or that does not return an acceptable image. **Fix:** Check the URL, or upload the logo file instead. |
| 403 | [permission_denied](https://upfour.io/docs/api/errors#code-permission_denied) | The credentials do not permit this action. |
| 400 | [svg_unsafe](https://upfour.io/docs/api/errors#code-svg_unsafe) | The SVG contains content that is not allowed. **When:** Uploading an SVG that contains a script, a foreignObject, a javascript: URL, an event-handler attribute or an external href. **Fix:** Remove those parts from the SVG, or upload a PNG or JPEG. |
| 400 | [upload_invalid](https://upfour.io/docs/api/errors#code-upload_invalid) | The upload could not be read as a multipart form. **When:** A body that is not a valid multipart form, or whose file cannot be parsed. **Fix:** Send a well-formed multipart/form-data request. |
| 400 | [upload_no_file](https://upfour.io/docs/api/errors#code-upload_no_file) | The multipart request has no file part. **When:** An upload request without a file field. **Fix:** Send the file as multipart/form-data in the field the operation names. |

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).

[PreviousDelete a member](https://upfour.io/docs/api/organization/delete-a-member.md) [NextUpdate report branding](https://upfour.io/docs/api/organization/update-report-branding.md)

## Request

### cURL

```bash
curl -s "https://app.upfour.io/v1/organization/report-branding" \
  -H "Authorization: Bearer $UP4_API_KEY"
```

### JavaScript

```javascript
const res = await fetch("https://app.upfour.io/v1/organization/report-branding", {
  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/organization/report-branding",
    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/organization/report-branding", 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/organization/report-branding");
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": {
    "domain_page_id": null,
    "footer_text": "",
    "logo_data_url": "",
    "logo_url": "",
    "name": "Acme GmbH",
    "primary_color": "#294E9E",
    "website_url": ""
  }
}
```

### 400

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

### 403

```json
{
  "error": {
    "code": "permission_denied",
    "message": "The credentials do not permit this action.",
    "request_id": "req_…"
  }
}
```

### 413

```json
{
  "error": {
    "code": "file_too_large",
    "message": "The uploaded file is over the size limit.",
    "request_id": "req_…"
  }
}
```