---
title: "Get headers and footers for PDF report exports"
method: GET
path: "/gdc/app/projects/{project_id}/export/pdfSettings"
tags: ["PDF-export-settings"]
---

# Get headers and footers for PDF report exports

`GET /gdc/app/projects/{project_id}/export/pdfSettings`

## Request

- Base URL: `https://secure.gooddata.com`
- URL: `https://secure.gooddata.com/gdc/app/projects/{project_id}/export/pdfSettings`
- Auth: none declared

Get headers and footers for PDF report exports in your project to review them and check whether they have been customized.

By default, a non-customized PDF file for an exported report or dashboard contains the following standard headers and footers:

```
* Header
  * Left: report/dashboard name
  * Right: date of export
* Footer
  * Right: page number/pages in total
```

If headers and footers for PDF report exports in your project have been customized, the response contains parameters that describes the following properties of PDF report exports:

* Dashboard
  * All pages
    * Footer (left and right)
    * Header (left, right and center)
  * First page (overriding the settings from all pages)
    * Header (left and right)

* Reports
  * All pages
    * Footer (left, right and center)
    * Header (left, right and center)
  * First page (overriding the settings from all pages)
    * Header (left, right and center)

Header and footer values can contain text strings, predefined macros, or both. For example:

```
"header": {
  "center": "Copyright 2007 - 2018",
  "left": "%DASHBOARD_NAME",
  "right": "Project %PROJECT_NAME"
}
```

For information on available macros, see [Configure Custom Headers and Footers for PDF Report Exports](https://help.gooddata.com/display/doc/Configure+Custom+Headers+and+Footers+for+PDF+Report+Exports).

## Path parameters

- `project_id` string, required

## Response `200`

Headers and footers for PDF report exports in your project have been customized.

- PdfExportSettings
  - `pdfexportsettings` object, required
    - `dashboard` object: common settings for all PDF report exports
      - `allpages` object, required: settings applied for all pages of generated PDF
        - `footer` object: in all contents is valid to use predefined macros
          - `center` string: content of center box (centred)
          - `left` string: content of left box (aligned left)
          - `right` string: content of right box (aligned right)
        - `header` object: in all contents is valid to use predefined macros
          - `center` string: content of center box (centred)
          - `left` string: content of left box (aligned left)
          - `right` string: content of right box (aligned right)
      - `firstpageoverride` object: settings applied for first page of generated PDF only, overrides allPages settings for first page
        - `footer` object: in all contents is valid to use predefined macros
          - `center` string: content of center box (centred)
          - `left` string: content of left box (aligned left)
          - `right` string: content of right box (aligned right)
        - `header` object: in all contents is valid to use predefined macros
          - `center` string: content of center box (centred)
          - `left` string: content of left box (aligned left)
          - `right` string: content of right box (aligned right)
    - `report` object: common settings for all PDF report exports, NOT USED NOW !
      - `allpages` object, required: settings applied for all pages of generated PDF
        - `footer` object: in all contents is valid to use predefined macros
          - `center` string: content of center box (centred)
          - `left` string: content of left box (aligned left)
          - `right` string: content of right box (aligned right)
        - `header` object: in all contents is valid to use predefined macros
          - `center` string: content of center box (centred)
          - `left` string: content of left box (aligned left)
          - `right` string: content of right box (aligned right)
      - `firstpageoverride` object: settings applied for first page of generated PDF only, overrides allPages settings for first page
        - `footer` object: in all contents is valid to use predefined macros
          - `center` string: content of center box (centred)
          - `left` string: content of left box (aligned left)
          - `right` string: content of right box (aligned right)
        - `header` object: in all contents is valid to use predefined macros
          - `center` string: content of center box (centred)
          - `left` string: content of left box (aligned left)
          - `right` string: content of right box (aligned right)

---

[API](https://skmtc.dev/gooddata/apis/gooddata-api-documentation.md) - [All operations](https://skmtc.dev/gooddata/apis/gooddata-api-documentation/llms.txt) - [OpenAPI document](https://skmtc.dev/gooddata/apis/gooddata-api-documentation/revisions/e5dc0ee6ab00?raw)