Skip to main content
curl -X GET "https://your-zipline.com/api/user/files/clxyz123" \
  -H "Authorization: YOUR_TOKEN"

​
GET /api/user/files/:id

Retrieve detailed information about a specific file by ID or name.

​
Path Parameters

​
id
string
required
The file ID or file name to retrieve. Both the unique file ID (clxyz123) and the file name on server (abc123.png) are accepted.

​
Response

​
id
string
Unique file identifier
​
name
string
File name on server
​
originalName
string | null
Original name of the uploaded file
​
size
number
File size in bytes
​
type
string
MIME type of the file
​
views
number
Number of times the file has been viewed
​
maxViews
number | null
Maximum allowed views before deletion. null means unlimited.
​
favorite
boolean
Whether the file is marked as favorite
​
password
boolean
Whether the file is password-protected
​
folderId
string | null
ID of the folder containing this file. null if not in a folder.
​
createdAt
string
ISO 8601 timestamp of file creation
​
updatedAt
string
ISO 8601 timestamp of last update
​
deletesAt
string | null
ISO 8601 timestamp of scheduled deletion. null if no deletion is scheduled.
​
url
string
Full URL to access the file
​
thumbnail
object | null
Thumbnail information if available
​
tags
array
Array of tag objects associated with this file

​
Example Response

{
  "id": "clxyz123",
  "name": "abc123.png",
  "originalName": "screenshot.png",
  "size": 152400,
  "type": "image/png",
  "views": 42,
  "maxViews": 100,
  "favorite": true,
  "password": false,
  "folderId": "folder123",
  "createdAt": "2024-01-15T10:30:00.000Z",
  "updatedAt": "2024-01-16T14:20:00.000Z",
  "deletesAt": "2024-02-15T10:30:00.000Z",
  "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"
    },
    {
      "id": "tag2",
      "name": "work",
      "color": "#10b981",
      "createdAt": "2024-01-12T09:15:00.000Z",
      "updatedAt": "2024-01-12T09:15:00.000Z"
    }
  ]
}

​
Error Responses

​
404 Not Found
The file does not exist, or you don’t have permission to access it.

Build docs developers (and LLMs) love

Get started for freeTalk to us