Skip to main content
GET
/
files
curl -X GET "https://api.tktchurch.com/v1/files?search=example&provider=s3&page=1&per=10" \
  -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIs..."
{
  "items": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "originalName": "example.jpg",
      "url": "https://storage.example.com/uploads/abc123.jpg",
      "key": "uploads/abc123.jpg",
      "contentType": "image/jpeg",
      "size": 1048576,
      "provider": "s3",
      "providerMetadata": {
        "bucket": "my-bucket",
        "region": "us-east-1"
      },
      "uploadedBy": "123e4567-e89b-12d3-a456-426614174001",
      "createdAt": "2024-01-20T15:00:00Z",
      "updatedAt": "2024-01-20T15:00:00Z"
    }
  ],
  "metadata": {
    "page": 1,
    "per": 10,
    "total": 1,
    "pageCount": 1
  }
}
This endpoint requires authentication.

Query Parameters

Search term to filter files by name or content type
uploadedBy
string
Filter by UUID of the user who uploaded the files
contentType
string
Filter by file content type (MIME type)
startDate
string
Filter by upload date range start (ISO 8601 format)
endDate
string
Filter by upload date range end (ISO 8601 format)
provider
string
Filter by storage provider (s3 or local)
page
integer
Page number for pagination (default: 1)
per
integer
Items per page (default: 10, max: 100)

Response

items
array
Array of file objects
metadata
object
Pagination metadata

Error Responses

error
object
Error details when the request fails
Common error cases:
  • 401 Unauthorized: Missing or invalid access token
curl -X GET "https://api.tktchurch.com/v1/files?search=example&provider=s3&page=1&per=10" \
  -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIs..."
{
  "items": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "originalName": "example.jpg",
      "url": "https://storage.example.com/uploads/abc123.jpg",
      "key": "uploads/abc123.jpg",
      "contentType": "image/jpeg",
      "size": 1048576,
      "provider": "s3",
      "providerMetadata": {
        "bucket": "my-bucket",
        "region": "us-east-1"
      },
      "uploadedBy": "123e4567-e89b-12d3-a456-426614174001",
      "createdAt": "2024-01-20T15:00:00Z",
      "updatedAt": "2024-01-20T15:00:00Z"
    }
  ],
  "metadata": {
    "page": 1,
    "per": 10,
    "total": 1,
    "pageCount": 1
  }
}