---
title: "Get reports"
method: GET
path: "/reports"
tags: ["reports"]
---

# Get reports

`GET /reports`

## Request

- Base URL: `https://api.smartrecruiters.com/reporting-api/v201804`
- URL: `https://api.smartrecruiters.com/reporting-api/v201804/reports`
- 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 fetch a list of reports. Reports are sorted by modification date (newer reports first).
### Paging
Whenever there's more data to be returned, the `nextPage` property will contain an opaque identifier of the next page. The value can be then passed as a page query parameter in a subsequent request. Another option is to use the response's `Link` HTTP header, which contains a web link to the following page, example:
```
<https://api.smartrecruiters.com/reporting-api/v201804/reports?page=MjAyMy0wMy0wOFQxMTozODo1Ni4wNzQ3MzVaOzIzNTJlNzRhLTdjNGQtNDcwNy04NDQ4LWZiMmE5MDIxMDBiNg%3D%3D>; rel="link"
```

## Query parameters

- `page` string
- `limit` integer

## Response `200`

Successful response.

- ApiReportsResponse
  - `nextPage` string
  - `content` 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 page parameter or limit parameter is invalid.
- `401`: Returned when a request was not authenticated.
- `403`: Returned when a caller is not authorized to perform the request.

---

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