---
title: "Indexes all the documents for the employee"
method: GET
path: "/v1/employee/documents"
tags: ["Employee Documents"]
---

# Indexes all the documents for the employee

`GET /v1/employee/documents`

## Scopes

| Category | Read only Scope | Write only Scope (read access implicit) |
|---|---|---|
| Manage employment documents (`employment_documents`) | View documents (`document:read`) | Manage documents (`document:write`) |

## Query parameters

- `page` integer
- `page_size` integer
- `name` string
- `inserted_after` string, date — UTC date in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format
- `inserted_before` string, date — UTC date in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format
- `sort_by` 'description' | 'document_source' | 'inserted_at' | 'name' | 'type' | 'uploaded_by_role' | 'related_to' | 'sub_type' | 'uploaded_by'
- `order` 'asc' | 'desc'

## Response `200`

Success

- ListDocumentsResponse — Response schema listing many documents
  - `data` object
    - `current_page` integer — The current page among all of the total_pages
    - `documents` File[]
      - `id` string, required — The unique identifier (UUID) of the file.
      - `inserted_at` string, date-time, required — UTC date time in [ISO 8601][] format. [ISO 8601]: https://en.wikipedia.org/wiki/ISO_8601
      - `name` string, required — The file name including extension (e.g., "id.pdf", "contract.pdf").
      - `sub_type` string, nullable — A more specific classification of the file within its type (e.g., "personal_id" within type "id", or "ir_35" within type "contract"). Null if no sub-type applies.
      - `type` string, required — The broad category of the file (e.g., "id", "contract", "tax_form").
    - `total_count` integer — The total number of records in the result
    - `total_pages` integer — The total number of pages the user can go through

## Other responses

- `403` — Forbidden
- `404` — Not Found

---

[API](https://skmtc.net/remote-com/apis/remote.md) · [All operations](https://skmtc.net/remote-com/apis/remote/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/remote-com/remote/revisions/7e6a0c61ac82/schema)