---
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`

## Request

- Base URL: `https://gateway.remote.com`
- URL: `https://gateway.remote.com/v1/employee/documents`
- Auth: one of:
  - OAuth 2
    - Client credentials
    - Token URL: `/auth/oauth2/token` scopes: `document:read`
  - OAuth 2
    - Client credentials
    - Token URL: `/auth/oauth2/token` scopes: `all:read`
  - OAuth 2
    - Client credentials
    - Token URL: `/auth/oauth2/token` scopes: `all:write`
  - OAuth 2
    - Authorization code: `/auth/oauth2/authorize`
    - Token URL: `/auth/oauth2/token` scopes: `https://gateway.remote.com/employment.manage`
  - OAuth 2
    - Authorization code: `/auth/oauth2/authorize`
    - Token URL: `/auth/oauth2/token` scopes: `document:read`
  - OAuth 2
    - Authorization code: `/auth/oauth2/authorize`
    - Token URL: `/auth/oauth2/token` scopes: `all:read`
  - OAuth 2
    - Authorization code: `/auth/oauth2/authorize`
    - Token URL: `/auth/oauth2/token` scopes: `all:write`

## Authentication

This endpoint accepts any one of the following token types:

- **Employee-scoped access token** (`OAuth2Assertion`) — obtained through the `urn:ietf:params:oauth:grant-type:jwt-bearer` grant. See [OAuth Assertion](https://developer.remote.com/docs/authorization-method-oauth-assertion).
- **Company-scoped access token** (`OAuth2AuthorizationCode`) — obtained by the employee through the Authorization Code flow or the Refresh Token flow. See [Authentication for partners](https://developer.remote.com/docs/authentication-for-partners).

## Scopes

Any one of the scopes in a token type's row is enough. `all:read` and `all:write` work too.

| Token type | Category | Read only Scope | Write only Scope (read access implicit) |
|---|---|---|---|
| Employee-scoped access token | Manage employment documents (`employment_documents`) | View documents (`document:read`) | Manage documents (`document:write`) |
| Company-scoped access token | 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_document").
    - `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.dev/remote-com/apis/employments.md) - [All operations](https://skmtc.dev/remote-com/apis/employments/llms.txt) - [OpenAPI document](https://skmtc.dev/remote-com/apis/employments/revisions/da61f6ebc73a?raw)