---
title: "Get terminal report settings"
method: GET
path: "/rest/v2/settings/terminal/report"
tags: ["Report Settings"]
---

# Get terminal report settings

`GET /rest/v2/settings/terminal/report`

## Request

- The document declares no server URL.
- Auth: none declared. Required headers: `api-key`
- TypeScript: <https://skmtc.dev/xplorpay/apis/external-us-onboarding-workflow/docs/rest/v2/settings/terminal/report/get.ts> (a function with typed inputs; its response is checked against the schema)

Retrieve the report settings for the terminal's last closed batch.

## Query parameters

- `type` 'LAST_CLOSED_BATCH'

## Headers

- `api-key` string, required

## Response `200`

ok

- ReportSettingsPayload: payload
  - `report-settings` ReportSettings: report settings
    - `report-time` string, required: Time of day when the report should be generated and sent in the HH:mm:ss format
    - `enabled` true | false, required: Indicates whether the report setting is active.
    - `type` 'LAST_CLOSED_BATCH' | 'LAST_CLOSED_BATCH', required: Type of report to be generated.
    - `emails` Emails: Contains a list of email addresses to receive the report.
      - `email` Address[]: Array of email objects.
        - `address` string, required: Email address to which the report will be sent.
  - `payloadType` string: Indicates the type of payload returned in the response.

## Other responses

- `400`: Bad Request
- `401`: Unauthorized
- `500`: Server error

---

[API](https://skmtc.dev/xplorpay/apis/external-us-onboarding-workflow.md) - [All operations](https://skmtc.dev/xplorpay/apis/external-us-onboarding-workflow/llms.txt) - [OpenAPI document](https://skmtc.dev/xplorpay/apis/external-us-onboarding-workflow/revisions/f37077c24b66?raw)