---
title: "Retrieve a report"
method: GET
path: "/reports/{report}"
tags: ["Reports"]
---

# Retrieve a report

`GET /reports/{report}`

This endpoint allows you to retrieve the data associated with a specific report. Use the ULID provided when the report was originally generated to make the request.

To download the report in CSV format, include the `Accept` header with the value `text/csv` in your request. Alternatively, the rendered file can be retrieved from `GET /reports/{id}/download` using the `format` and `sheet` supplied at creation.

## Path parameters

- `report` string, required

## Query parameters

- `sheet` string

## Response `200`

OK

- object
  - `id` string — The unique identifier of the object in Nmbr.
  - `object` string — The type of the object in Nmbr (`"report"`).
  - `data` Report
    - `type` 'cra-remittance' | 'ei-cpp-balance' | 'ei-qpp-qpip-balance' | 'employer-health-tax' | 'journal-entry' | 'journal-entry-line-item' | 'liability' | 'payroll-register' | 'rl1-preview' | 'rq-remittance' | 't4-preview' | 'vacation-accrual' | 'workers-compensation' | 'year-end-forms' | 'year-to-date'
    - `business_entity` unknown
    - `pay_schedule` unknown
    - `payroll` object
      - `id` string — The unique identifier of the object in Nmbr.
      - `object` string — The type of the object in Nmbr (`"payroll"`).
    - `filters` object, nullable
    - `has_results` boolean
    - `format` 'csv' | 'pdf' | 'xlsx', nullable — The output format set at creation for `/download`. One of `csv` or `xlsx`. `null` when no format was specified — required to use `/download`.
    - `sheet` string, nullable — The sheet selected at creation for multi-sheet reports (e.g. `summary` or `detail` for Payroll Register). `null` when the report has a single sheet or no sheet was specified.
    - `created_at` string, dateTime — The date and time the object was created in Nmbr.
    - `updated_at` string, dateTime — The date and time the object was last updated in Nmbr.

---

[API](https://skmtc.net/nmbr/apis/nmbr-api.md) · [All operations](https://skmtc.net/nmbr/apis/nmbr-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/nmbr/nmbr-api/versions/a0c7a815860f/schema)