Skip to main content
curl -X GET "https://your-zipline.com/api/user/files?page=1&perpage=15" \
  -H "Authorization: YOUR_TOKEN"

GET /api/user/files

Retrieve a paginated list of files with support for filtering, sorting, and searching.

Query Parameters

page
number
required
Page number for pagination (1-indexed)
perpage
number
default:"15"
Number of files per page
filter
enum
default:"none"
Filter files by type
favorite
boolean
default:"false"
Filter to show only favorited files
sortBy
enum
default:"createdAt"
Field to sort files by
order
enum
default:"desc"
Sort order
  • asc - Ascending
  • desc - Descending
searchField
enum
default:"name"
Field to search in
searchQuery
string
Search query string. When searching by tags, use comma-separated tag IDs
id
string
Filter files by a specific user ID (requires permission)
folder
string
Filter files by folder ID

Response

page
array
Array of file objects
total
number
Total number of files matching the query (only present without search)
pages
number
Total number of pages (only present without search)
Search metadata (only present when searching)
field
string
The field that was searched
query
string | string[]
The search query (array when searching tags)

Example Response

{
  "page": [
    {
      "id": "clxyz123",
      "name": "abc123.png",
      "originalName": "screenshot.png",
      "size": 152400,
      "type": "image/png",
      "views": 42,
      "maxViews": null,
      "favorite": false,
      "password": false,
      "folderId": null,
      "createdAt": "2024-01-15T10:30:00.000Z",
      "updatedAt": "2024-01-15T10:30:00.000Z",
      "deletesAt": null,
      "url": "https://your-zipline.com/u/abc123.png",
      "thumbnail": {
        "path": "/thumbnails/abc123.jpg"
      },
      "tags": [
        {
          "id": "tag1",
          "name": "screenshots",
          "color": "#3b82f6",
          "createdAt": "2024-01-10T08:00:00.000Z",
          "updatedAt": "2024-01-10T08:00:00.000Z"
        }
      ]
    }
  ],
  "total": 150,
  "pages": 10
}

Search Example Response

{
  "page": [
    {
      "id": "clxyz123",
      "name": "screenshot-2024.png",
      "originalName": "screenshot.png",
      "size": 152400,
      "type": "image/png",
      "views": 42,
      "maxViews": null,
      "favorite": false,
      "password": false,
      "folderId": null,
      "createdAt": "2024-01-15T10:30:00.000Z",
      "updatedAt": "2024-01-15T10:30:00.000Z",
      "deletesAt": null,
      "url": "https://your-zipline.com/u/screenshot-2024.png",
      "thumbnail": null,
      "tags": []
    }
  ],
  "search": {
    "field": "originalName",
    "query": "screenshot"
  }
}

Build docs developers (and LLMs) love