> ## Documentation Index
> Fetch the complete documentation index at: https://pdfbase.dev/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# List PDFs

> Retrieve a paginated list of generated PDFs.

## Phase

**Phase 1 (Launch)**

## Query parameters

<ParamField query="limit" type="integer" default="25">
  Number of results to return. Range: 1-100.
</ParamField>

<ParamField query="starting_after" type="string">
  PDF ID to paginate forward from. Returns results created after this PDF.
</ParamField>

<ParamField query="ending_before" type="string">
  PDF ID to paginate backward from.
</ParamField>

<ParamField query="status" type="string">
  Filter by status: `completed`, `completed_with_warnings`, `failed`, `expired`.
</ParamField>

<ParamField query="created_after" type="string">
  ISO 8601 timestamp. Only return PDFs created after this time.
</ParamField>

<ParamField query="created_before" type="string">
  ISO 8601 timestamp. Only return PDFs created before this time.
</ParamField>

<ParamField query="metadata" type="string">
  Filter by metadata. Format: `key:value`. Example: `metadata=order_id:42`.
</ParamField>

## Response

```json theme={null}
{
  "object": "list",
  "data": [
    {
      "id": "pdf_newer",
      "object": "pdf",
      "status": "completed",
      "pages": 1,
      "bytes": 24310,
      "format": "a4",
      "metadata": {},
      "created_at": "2026-05-19T11:00:00Z",
      "expires_at": "2026-05-20T11:00:00Z"
    },
    {
      "id": "pdf_older",
      "object": "pdf",
      "status": "completed",
      "pages": 5,
      "bytes": 198000,
      "format": "letter",
      "metadata": { "order_id": "41" },
      "created_at": "2026-05-19T10:30:00Z",
      "expires_at": "2026-05-20T10:30:00Z"
    }
  ],
  "has_more": true,
  "next_cursor": "pdf_older"
}
```

<Note>
  List responses don't include `url` fields to keep payloads small. Use `GET /v1/pdfs/:id` to get a download URL for a specific PDF.
</Note>

## Example

```bash theme={null}
# Get the 10 most recent PDFs for a specific order
curl "https://api.pdfbase.dev/v1/pdfs?limit=10&metadata=order_id:42" \
  -H "Authorization: Bearer pk_live_xxx"
```