---
title: "Search files"
method: GET
path: "/v1/Files"
tags: ["Files"]
---

# Search files

`GET /v1/Files`

Search for one or more files.

## Query parameters

- `search.file_id` integer[]
- `search.request_id` integer[]
- `search.customer_id` integer[]
- `search.created_date_start` string, date-time
- `search.created_date_end` string, date-time
- `search.page_size` integer
- `search.page` integer
- `search.sort` string

## Response `200`

OK

- RevWebAPIModelsGetOrSearchOfRevAppSearchModelsResponseOfRevAppModelsFile
  - `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` RevAppModelsFile[] — List of records returned.
    - `file_id` integer — Primary identifier for this file.
    - `file_image` string, byte — Binary file data represented as a Base64-encoded string. NOTE: By default, this will be blank or null. You must indicate when to include it with an optional parameter when getting a single file.
    - `file_name` string — The name of the file, including extension.
    - `file_type` 'NOT_SPECIFIED' | 'AGENT_ATTACHMENT' | 'AGENT_BATCH' | 'AGENT_CUSTOMER_SUMMARY' | 'AGENT_RECEIPT' | 'AGENT_REPORT_COMMISSION_SUMMARY' | 'AGENT_STATEMENT' | 'AGENT_STATEMENT_PRINT_SUMMARY' | 'CASH_DRAWER_CLOSING_REPORT' | 'CDR_EXPORT' | 'COLLECTION_EMAIL' | 'COLLECTION_LETTER' | 'TAX_COMPARISON_BATCH' | 'CUSTOM_E911_BATCH' | 'CUSTOMER_ACCOUNT_ATTACHMENT' | 'CUSTOMER_STATEMENT' | 'CUSTOMER_EDI_BILL' | 'CUSTOMER_RECEIPT' | 'DATA_BACKUP' | 'DISCONNECT_NOTICE' | 'DOCUMENT' | 'EXTERNAL_ORDER' | 'FAX' | 'FILE_MANAGER' | 'INVENTORY_ATTACHMENT' | 'LIFELINE_OTHER' | 'LIFELINE_PROOF_DOCUMENTATION' | 'LIFELINE_SELF_CERTIFICATION' | 'LINE_FIELD_UPDATE_TEMPLATE' | 'REQUEST_ATTACHMENT' | 'REQUEST_TEMPLATE' | 'REQUEST_UPDATE_TEMPLATE' | 'SALES_PORTAL_COVER_LETTER' | 'STATEMENT_BATCH' | 'TASK_ATTACHMENT' | 'TICKET_ATTACHMENT' | 'WORKORDER_CONTRACT' | 'CLIENT_IMAGE' | 'REPORT' | 'EMAIL_TEMPLATE_ATTACHMENT' | 'VENDOR_STATEMENT' — Rev.io-specific type description of the file.
    - `description` string — Free-form text description of the file.
    - `created_date` string, date-time — Date and time the file was added to Rev.io.
    - `created_by` integer — Foreign identifier indicating which user added the file to Rev.io.
    - `customer_id` integer — Foreign identifier indicating an association with an account.
    - `order_id` integer — Foreign identifier indicating an association with an order.
    - `request_id` integer — Foreign identifier indicating an association with a request.
    - `links` RevAppComponentsLink[]
      - `rel` string
      - `href` string

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