---
updatedAt: 2026-04-24T14:51:18.000Z
agentTools:
  projectIndex: https://api-doc.jethr.com/llms.txt
---

# List documents

Required scope: `documents:read`

# OpenAPI definition

```json
{
  "openapi": "3.0.3",
  "info": {
    "title": "",
    "version": "0.0.0"
  },
  "paths": {
    "/public-api/v1/documents/": {
      "get": {
        "operationId": "documents_list",
        "description": "Required scope: `documents:read`",
        "summary": "List documents",
        "parameters": [
          {
            "in": "query",
            "name": "employee",
            "schema": {
              "type": "string",
              "format": "uuid"
            },
            "description": "Filter documents by employee UUID"
          },
          {
            "in": "query",
            "name": "kind_name",
            "schema": {
              "type": "string"
            },
            "description": "Filter documents by kind name"
          },
          {
            "in": "query",
            "name": "last_updated_at__gt",
            "schema": {
              "type": "string",
              "format": "date-time"
            },
            "description": "Filter by last update date greater than."
          },
          {
            "in": "query",
            "name": "last_updated_at__gte",
            "schema": {
              "type": "string",
              "format": "date-time"
            },
            "description": "Filter by last update date greater than or equal to."
          },
          {
            "in": "query",
            "name": "last_updated_at__lt",
            "schema": {
              "type": "string",
              "format": "date-time"
            },
            "description": "Filter by last update date less than."
          },
          {
            "in": "query",
            "name": "last_updated_at__lte",
            "schema": {
              "type": "string",
              "format": "date-time"
            },
            "description": "Filter by last update date less than or equal to."
          },
          {
            "name": "page",
            "required": false,
            "in": "query",
            "description": "A page number within the paginated result set.",
            "schema": {
              "type": "integer"
            }
          },
          {
            "in": "query",
            "name": "period",
            "schema": {
              "type": "string"
            },
            "description": "Filter documents by the period of the associated payroll,\n        in the format YYYY-MM"
          }
        ],
        "tags": [
          "documents"
        ],
        "security": [
          {
            "tokenAuth": []
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PaginatedDocumentList"
                }
              }
            },
            "description": ""
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "Document": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "readOnly": true,
            "description": "Display name of the document"
          },
          "last_updated_at": {
            "type": "string",
            "format": "date-time",
            "readOnly": true,
            "description": "Last update timestamp of the document"
          },
          "period": {
            "type": "string",
            "readOnly": true,
            "title": "Periodo"
          },
          "download_url": {
            "type": "string",
            "nullable": true,
            "readOnly": true,
            "description": "Short-lived URL for file download"
          },
          "kind_name": {
            "type": "string",
            "title": "Tipologia",
            "readOnly": true,
            "description": "Name of the document kind"
          },
          "employee": {
            "allOf": [
              {
                "$ref": "#/components/schemas/EmployeeBasicInfo"
              }
            ],
            "readOnly": true,
            "nullable": true,
            "description": "The employee the document is related to"
          }
        },
        "required": [
          "download_url",
          "employee",
          "kind_name",
          "last_updated_at",
          "name",
          "period"
        ]
      },
      "EmployeeBasicInfo": {
        "type": "object",
        "properties": {
          "uuid": {
            "type": "string",
            "format": "uuid",
            "readOnly": true,
            "description": "Identifier of the employee"
          },
          "full_name": {
            "type": "string",
            "readOnly": true,
            "description": "Full name"
          }
        },
        "required": [
          "full_name",
          "uuid"
        ]
      },
      "PaginatedDocumentList": {
        "type": "object",
        "required": [
          "count",
          "results"
        ],
        "properties": {
          "count": {
            "type": "integer",
            "example": 123
          },
          "next": {
            "type": "string",
            "nullable": true,
            "format": "uri",
            "example": "http://api.example.org/accounts/?page=4"
          },
          "previous": {
            "type": "string",
            "nullable": true,
            "format": "uri",
            "example": "http://api.example.org/accounts/?page=2"
          },
          "results": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Document"
            }
          }
        }
      }
    },
    "securitySchemes": {
      "tokenAuth": {
        "type": "http",
        "scheme": "bearer"
      }
    }
  },
  "x-proxy-enabled": false,
  "servers": [
    {
      "url": "https://backend.jethr.com",
      "description": "Production environment"
    },
    {
      "url": "https://api.demo.jethr.com/backend",
      "description": "Api demo environment"
    }
  ]
}
```