---
title: "Get report"
method: GET
path: "/reports/{reportId}"
tags: ["reports"]
---

# Get report

`GET /reports/{reportId}`

## Request

- Base URL: `https://api.smartrecruiters.com/reporting-api/v201804`
- URL: `https://api.smartrecruiters.com/reporting-api/v201804/reports/{reportId}`
- Auth: one of:
  - OAuth 2
    - Authorization code: `https://www.smartrecruiters.com/identity/oauth/allow`
    - Client credentials
    - Token URL: `https://api.smartrecruiters.com/identity/oauth/token` scopes: `reporting_read`
  - API key in header `x-smarttoken`

Use this endpoint to get a specific report details.

## Path parameters

- `reportId` string, required

## Response `200`

Successful response.

- ApiReportResponse
  - `reportId` string
  - `name` string
  - `rowEntityTypeId` string
  - `rowEntityInstanceId` string
  - `columns` ApiColumnResponse[]
    - `entityTypeId` string
    - `entityInstanceId` string
    - `dataPointId` string
    - `dataPointInstanceId` string
    - `dataPointInstanceName` string
    - `dataPointName` string
    - `dataPointType` 'ID' | 'DATE' | 'NUMBER' | 'TEXT' | 'ENUM' | 'BOOLEAN' | 'DECIMAL'
  - `filters` ApiFilterResponse[]
    - `column` ApiColumnResponse
      - `entityTypeId` string
      - `entityInstanceId` string
      - `dataPointId` string
      - `dataPointInstanceId` string
      - `dataPointInstanceName` string
      - `dataPointName` string
      - `dataPointType` 'ID' | 'DATE' | 'NUMBER' | 'TEXT' | 'ENUM' | 'BOOLEAN' | 'DECIMAL'
    - `dateRange` ApiDateRange
      - `from` string, date-time
      - `to` string, date-time
    - `datePeriod` ApiDatePeriod
      - `period` integer, required
      - `unit` 'DAYS' | 'WEEKS' | 'MONTHS' | 'YEARS', required
      - `fullPeriod` boolean
    - `rowValues` ApiRowValues
      - `noneValue` boolean
      - `values` string[], required
    - `booleanValue` ApiBooleanValue
      - `value` boolean
  - `creationDate` string, date-time
  - `modificationDate` string, date-time
  - `creatorId` string
  - `modifierId` string
  - `grantees` string[]
  - `schedule` ApiSchedule
    - `frequency` 'ANNUALLY' | 'MONTHLY' | 'WEEKLY' | 'DAILY', required
    - `activityPeriod` ApiDateRange, required
      - `from` string, date-time
      - `to` string, date-time
    - `schedulingTime` ApiTimeRange
      - `from` ApiTime, required
        - `hour` integer
        - `minute` integer
      - `to` ApiTime, required
        - `hour` integer
        - `minute` integer
      - `zone` string
  - `reportTemplateId` string
  - `reportFormats` string[]
  - `accessGroupId` string
  - `systemRoleId` string

## Other responses

- `400`: Returned when the report ID is invalid.
- `401`: Returned when a request was not authenticated.
- `403`: Returned when a caller is not authorized to perform the request.
- `404`: Returned when there is no report with the given ID.

---

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