---
title: PDF Files API Reference
version: 1.0.0
description: "Retrieve a list of all PDF files uploaded and generated by a user. Returns an array of file objects with file ID and file name. Note: Organization members cannot access this endpoint — only the Organization Administrator can."
openapi: 3.1.1
servers:
  - https://api.apifreaks.com/v1.0
paths: 1
operations: 1
schemas: 2
---

## Table of Contents

- [PDF Files API Reference v1.0.0](#pdf-files-api-reference-v100)
  - [Authentication](#authentication)
  - [Task Status and File Info APIs](#task-status-and-file-info-apis)
    - [getFiles](#getfiles)
      - [Parameters](#parameters)
      - [Responses](#responses)
  - [Schemas](#schemas)
    - [PdfFileListResponse](#pdffilelistresponse)
    - [PdfFileItem](#pdffileitem)



# PDF Files API Reference v1.0.0

Retrieve a list of all PDF files uploaded and generated by a user. Returns an array of file objects with file ID and file name. Note: Organization members cannot access this endpoint — only the Organization Administrator can.

Base URLs:

* [https://api.apifreaks.com/v1.0](https://api.apifreaks.com/v1.0)

## Authentication

* API Key (ApiKeyAuthHeader)
    - Parameter Name: **X-apiKey**, in: header. Pass your API key via the X-apiKey request header.

* API Key (ApiKeyAuthQuery)
    - Parameter Name: **apiKey**, in: query. Pass your API key via the apiKey query parameter.

## Task Status and File Info APIs

### getFiles

`GET /pdf/files`

*Get list of PDF files*

This API retrieves a list of all PDF files uploaded and generated by a specific user. Please note that if the user is part of an organization, only the Organization Administrator can access this endpoint. Organization Members cannot access this endpoint.

#### Parameters

|Name|In|Type|Required|Description|
|---|---|---|---|---|
|format|query|string|false|Specifies the desired format for the API response. Choose 'json' for a JSON object or 'xml' for an XML structure.|

##### Enumerated Values

|Parameter|Value|
|---|---|
|format|json|
|format|xml|

> Example responses

> Successful operation

```json
{
  "files": [
    {
      "fileId": "abc123",
      "fileName": "document.pdf"
    },
    {
      "fileId": "def456",
      "fileName": "report.pdf"
    }
  ]
}
```

#### Responses

|Status|Meaning|Description|Schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Successful operation|[PdfFileListResponse](#pdffilelistresponse)|

#### Response Headers

|Status|Header|Type|Format|Description|
|---|---|---|---|---|
|200|X-AF-Credits-Cost|integer||Specifies the number of credits consumed by the current request.|

To perform this operation, you must be authenticated by means of one of the following methods:
ApiKeyAuthHeader, ApiKeyAuthQuery

## Schemas

### PdfFileListResponse

PDF file list response containing an array of file objects.

#### Properties

|Name|Type|Required|Restrictions|Description|
|---|---|---|---|---|
|files|[[PdfFileItem](#pdffileitem)]|true|none|List of files available on the server.|

### PdfFileItem

A single PDF file in the file list.

#### Properties

|Name|Type|Required|Restrictions|Description|
|---|---|---|---|---|
|fileId|string|false|none|Unique ID for the file, used to fetch or process the file.|
|fileName|string|false|none|Original name of the uploaded file.|