---
title: "Search reports"
method: GET
path: "/v1/Reports"
tags: ["Reports"]
---

# Search reports

`GET /v1/Reports`

Search for one or more reports.

## Query parameters

- `search.report_id` integer[]
- `search.report_category_id` integer[]
- `search.description` string[]
- `search.created_by` integer[]
- `search.page_size` integer
- `search.page` integer
- `search.sort` string

## Response `200`

OK

- RevWebAPIModelsGetOrSearchOfRevAppSearchModelsResponseOfRevAppModelsReportsReport
  - `ok` boolean
  - `has_more` boolean — Helper for pagination. Indicates there are more records returned.
  - `record_count` integer — Total number of records found by the search.
  - `records` RevAppModelsReportsReport[] — List of records returned.
    - `report_id` integer — Primary identifier for this report.
    - `report_category_id` integer, required — Foreign identifier indicating the category this belongs to.
    - `description` string, required — Short description of the report (i.e. the name).
    - `created_by` integer — Foreign identifier of user who created this.
    - `shared` boolean — Indicates report can be viewed by any user with access to the category of report.
    - `long_description` string — Detailed description of the report.
    - `type` 'CLASSIC' | 'SQL' | 'STANDARD' — Indicates how the report query is stored in Rev.io.
    - `prompts` RevAppModelsReportsReportPrompt[] — List of prompts requesting input from executing user.
      - `prompt_id` integer — Primary identifier for this prompt.
      - `column` string — Name of the SQL table column to query.
      - `value` string — Value you want to compare with column.
      - `operator` string — Relationship between column and value that qualifies as a match.

## Other responses

- `500` — InternalServerError

---

[API](https://skmtc.net/rev-io/apis/rev-io-api.md) · [All operations](https://skmtc.net/rev-io/apis/rev-io-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/rev-io/rev-io-api/revisions/135571434f6c/schema)