List uploads

http
GET /projects/{project_reference}/uploads

List the uploads the caller can see under an optional folder prefix, newest first by default, with the visible folders in a separate list. Requires project.uploads.read.

Servers

json
[
  {
    "url": "https://api.veryfront.com"
  }
]

Authentication

json
[
  {
    "bearerAuth": []
  },
  {
    "apiKeyAuth": []
  }
]
json
{
  "bearerAuth": {
    "type": "http",
    "scheme": "bearer",
    "bearerFormat": "JWT or API Key",
    "description": "Use a JWT bearer token or a Veryfront API key in the `Authorization` header."
  },
  "apiKeyAuth": {
    "type": "apiKey",
    "in": "header",
    "name": "X-API-Key",
    "description": "Alternative API key header for `vf_<prefix>_<secret>` tokens."
  }
}

Parameters

NameLocationRequiredDescription
project_referencepathYesProject slug, UUID, or domain that identifies the project.
pathqueryNo
cursorqueryNo
limitqueryNoMaximum number of entries to return. Defaults to 20 and is capped at 100.
sort_byqueryNo
sort_orderqueryNo
recursivequeryNo

Parameter contracts

json
[
  {
    "schema": {
      "$ref": "#/components/schemas/ProjectReference"
    },
    "required": true,
    "description": "Project slug, UUID, or domain that identifies the project.",
    "name": "project_reference",
    "in": "path"
  },
  {
    "schema": {
      "type": "string",
      "description": "Project-relative path to select direct-child files (for example, \"assets/\"). Omit to list all project files."
    },
    "required": false,
    "name": "path",
    "in": "query"
  },
  {
    "schema": {
      "type": "string",
      "minLength": 1,
      "maxLength": 4096,
      "description": "Opaque continuation; copy unchanged with the same project/path/sort. A removed anchor requires restarting; live changes affect traversal. Legacy ISO timestamps retain the creation cutoff and cannot recover ties."
    },
    "required": false,
    "name": "cursor",
    "in": "query"
  },
  {
    "schema": {
      "$ref": "#/components/schemas/PaginationLimit"
    },
    "required": false,
    "description": "Maximum number of entries to return. Defaults to 20 and is capped at 100.",
    "name": "limit",
    "in": "query"
  },
  {
    "schema": {
      "type": "string",
      "enum": [
        "created_at",
        "name",
        "size_bytes",
        "size"
      ],
      "default": "created_at",
      "description": "Sort field. Defaults to \"created_at\". \"size\" is accepted as another spelling of \"size_bytes\"."
    },
    "required": false,
    "name": "sort_by",
    "in": "query"
  },
  {
    "schema": {
      "type": "string",
      "enum": [
        "asc",
        "desc"
      ],
      "default": "desc",
      "description": "Sort order. Defaults to \"desc\"."
    },
    "required": false,
    "name": "sort_order",
    "in": "query"
  },
  {
    "schema": {
      "type": "boolean",
      "default": true,
      "description": "When true, returns all nested folders under the given path (or all folders if no path). Default: true."
    },
    "required": false,
    "name": "recursive",
    "in": "query"
  }
]

Responses

200

One page of uploads with the visible folders in folders. data also repeats the folders as type: "folder" items before the uploads (type: "file").

json
{
  "description": "One page of uploads with the visible folders in `folders`. `data` also repeats the folders as `type: \"folder\"` items before the uploads (`type: \"file\"`).",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "properties": {
          "data": {
            "type": "array",
            "items": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/UploadFolder"
                },
                {
                  "$ref": "#/components/schemas/UploadFile"
                }
              ],
              "discriminator": {
                "propertyName": "type",
                "mapping": {
                  "folder": "#/components/schemas/UploadFolder",
                  "file": "#/components/schemas/UploadFile"
                }
              },
              "description": "Upload item, either a folder (type: \"folder\") or a file (type: \"file\")"
            }
          },
          "folders": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "path": {
                  "type": "string",
                  "description": "Folder path with a trailing slash."
                },
                "visibility": {
                  "type": "string",
                  "enum": [
                    "project",
                    "public",
                    "private"
                  ],
                  "description": "Effective access policy for the upload or folder."
                },
                "permission": {
                  "type": "string",
                  "enum": [
                    "read",
                    "write",
                    "admin"
                  ],
                  "description": "The caller’s effective access to this item: read, write, or admin."
                },
                "created_at": {
                  "type": "string",
                  "description": "Creation timestamp in ISO 8601 format."
                }
              },
              "required": [
                "path",
                "visibility",
                "permission",
                "created_at"
              ]
            },
            "description": "Visible folders, separate from the upload cursor and page size. The `data` items with `type: \"folder\"` repeat them."
          },
          "page_info": {
            "$ref": "#/components/schemas/PageInfo"
          }
        },
        "required": [
          "data",
          "folders",
          "page_info"
        ]
      }
    }
  }
}

400

Invalid request parameters

json
{
  "description": "Invalid request parameters",
  "content": {
    "application/problem+json": {
      "schema": {
        "$ref": "#/components/schemas/Problem"
      }
    }
  }
}

401

Unauthorized

json
{
  "description": "Unauthorized",
  "content": {
    "application/problem+json": {
      "schema": {
        "$ref": "#/components/schemas/Problem"
      }
    }
  }
}

403

Forbidden - insufficient permissions

json
{
  "description": "Forbidden - insufficient permissions",
  "content": {
    "application/problem+json": {
      "schema": {
        "$ref": "#/components/schemas/Problem"
      }
    }
  }
}

404

Project or upload path not found

json
{
  "description": "Project or upload path not found",
  "content": {
    "application/problem+json": {
      "schema": {
        "$ref": "#/components/schemas/Problem"
      }
    }
  }
}

500

Server error

json
{
  "description": "Server error",
  "content": {
    "application/problem+json": {
      "schema": {
        "$ref": "#/components/schemas/Problem"
      }
    }
  }
}

Referenced contracts

components/parameters/ProjectReference

json
{
  "schema": {
    "$ref": "#/components/schemas/ProjectReference"
  },
  "required": true,
  "description": "Project slug, UUID, or domain that identifies the project.",
  "name": "project_reference",
  "in": "path"
}

components/schemas/ProjectReference

json
{
  "type": "string"
}

components/parameters/PaginationLimit

json
{
  "schema": {
    "$ref": "#/components/schemas/PaginationLimit"
  },
  "required": false,
  "description": "Maximum number of entries to return. Defaults to 20 and is capped at 100.",
  "name": "limit",
  "in": "query"
}

components/schemas/PaginationLimit

json
{
  "type": "number",
  "minimum": 1,
  "maximum": 100,
  "default": 20,
  "description": "Maximum number of entries to return. Defaults to 20 and is capped at 100."
}

components/schemas/UploadFolder

json
{
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "enum": [
        "folder"
      ],
      "description": "Item type",
      "example": "folder"
    },
    "path": {
      "type": "string",
      "description": "Project-relative storage path, without a leading slash."
    },
    "visibility": {
      "type": "string",
      "enum": [
        "project",
        "public",
        "private"
      ],
      "description": "Effective access policy for the upload or folder."
    },
    "permission": {
      "type": "string",
      "enum": [
        "read",
        "write",
        "admin"
      ],
      "description": "The caller’s effective access to this item: read, write, or admin."
    },
    "created_at": {
      "type": "string",
      "description": "Creation timestamp in ISO 8601 format."
    }
  },
  "required": [
    "type",
    "path",
    "visibility",
    "permission",
    "created_at"
  ]
}

components/schemas/UploadFile

json
{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Upload UUID."
    },
    "path": {
      "type": "string",
      "description": "Project-relative storage path, without a leading slash."
    },
    "file_name": {
      "type": "string",
      "description": "File name from the upload record."
    },
    "content_type": {
      "type": [
        "string",
        "null"
      ],
      "description": "Stored MIME type, or null when unspecified."
    },
    "size_bytes": {
      "type": "number",
      "description": "File size in bytes."
    },
    "size": {
      "type": "number",
      "description": "File size in bytes; the same value as size_bytes."
    },
    "url": {
      "type": [
        "string",
        "null"
      ],
      "description": "API URL for downloading the upload; access depends on its visibility."
    },
    "status": {
      "type": "string",
      "enum": [
        "pending",
        "active",
        "failed"
      ],
      "description": "Upload lifecycle state: pending until finalized, active when available, or failed."
    },
    "visibility": {
      "type": "string",
      "enum": [
        "project",
        "public",
        "private"
      ],
      "description": "Effective access policy for the upload or folder."
    },
    "created_at": {
      "type": "string",
      "description": "Creation timestamp in ISO 8601 format."
    },
    "updated_at": {
      "type": "string",
      "description": "Last update timestamp in ISO 8601 format."
    },
    "deleted_at": {
      "type": [
        "string",
        "null"
      ],
      "description": "Soft deletion timestamp in ISO 8601 format, or null for an undeleted upload."
    },
    "type": {
      "type": "string",
      "enum": [
        "file"
      ],
      "description": "Item type",
      "example": "file"
    },
    "permission": {
      "type": "string",
      "enum": [
        "read",
        "write",
        "admin"
      ],
      "description": "The caller’s effective access to this item: read, write, or admin."
    }
  },
  "required": [
    "id",
    "path",
    "file_name",
    "content_type",
    "size_bytes",
    "size",
    "url",
    "status",
    "visibility",
    "created_at",
    "updated_at",
    "deleted_at",
    "type",
    "permission"
  ]
}

components/schemas/PageInfo

json
{
  "type": "object",
  "properties": {
    "self": {
      "type": [
        "string",
        "null"
      ],
      "description": "Cursor pointing to the current page"
    },
    "first": {
      "type": "null",
      "description": "First page cursor (always null for cursor-based pagination)"
    },
    "next": {
      "type": [
        "string",
        "null"
      ],
      "description": "Cursor for the next page (null if no more pages)"
    },
    "prev": {
      "type": [
        "string",
        "null"
      ],
      "description": "Cursor for the previous page (null if on first page)"
    }
  },
  "required": [
    "self",
    "first",
    "next",
    "prev"
  ]
}

components/schemas/Problem

json
{
  "type": "object",
  "properties": {
    "cause": {
      "type": "string",
      "enum": [
        "schedule_concurrency_forbidden",
        "schedule_fire_in_progress",
        "schedule_run_limit_reached"
      ],
      "description": "Schedule admission refusal."
    },
    "idempotency": {
      "type": "object",
      "properties": {
        "state": {
          "type": "string",
          "enum": [
            "in_progress",
            "payload_mismatch",
            "outcome_unknown"
          ]
        },
        "operation": {
          "type": "string",
          "minLength": 1
        },
        "retryable": {
          "type": "boolean"
        },
        "retry_after_seconds": {
          "type": [
            "integer",
            "null"
          ],
          "minimum": 0
        },
        "expires_at": {
          "type": [
            "string",
            "null"
          ]
        },
        "recovery": {
          "type": "object",
          "properties": {
            "available": {
              "type": "boolean"
            },
            "description": {
              "type": "string"
            },
            "resource_url": {
              "type": "string"
            }
          },
          "required": [
            "available",
            "description"
          ]
        }
      },
      "required": [
        "state",
        "operation",
        "retryable",
        "retry_after_seconds",
        "expires_at"
      ],
      "description": "Replay status, retry timing, and recovery lookup."
    },
    "type": {
      "type": "string",
      "description": "URI reference identifying the problem type",
      "example": "https://api.veryfront.com/errors/validation-failed"
    },
    "title": {
      "type": "string",
      "description": "Short human-readable summary of the problem",
      "example": "Validation Failed"
    },
    "status": {
      "type": "integer",
      "minimum": 100,
      "maximum": 599,
      "description": "HTTP status code",
      "example": 400
    },
    "code": {
      "type": "string",
      "description": "Stable machine-readable error code",
      "example": "RUN_INVALID_INPUT"
    },
    "detail": {
      "type": "string",
      "description": "Human-readable explanation specific to this occurrence",
      "example": "The 'email' field must be a valid email address"
    },
    "instance": {
      "type": "string",
      "description": "URI reference identifying the specific occurrence",
      "example": "/projects/my-project/members"
    },
    "slug": {
      "type": "string",
      "description": "Stable identifier for the problem type",
      "example": "validation-failed"
    },
    "category": {
      "type": "string",
      "enum": [
        "AUTH",
        "RESOURCE",
        "VALIDATION",
        "DATABASE",
        "SUBSCRIPTION",
        "INTEGRATION",
        "INTERNAL"
      ],
      "description": "API error category",
      "example": "VALIDATION"
    },
    "suggestion": {
      "type": "string",
      "description": "Suggested action to resolve the problem",
      "example": "Check the request body and query parameters against the API documentation."
    },
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "field": {
            "type": "string",
            "description": "Field path that caused the error",
            "example": "email"
          },
          "message": {
            "type": "string",
            "description": "Error message for this field",
            "example": "Invalid email format"
          },
          "code": {
            "type": "string",
            "description": "Error code for this field",
            "example": "INVALID_FORMAT"
          }
        },
        "required": [
          "field",
          "message"
        ]
      },
      "description": "Detailed field-level errors for validation failures"
    }
  },
  "required": [
    "type",
    "title",
    "status"
  ]
}

Operation contract

json
{
  "operationId": "listUploads",
  "tags": [
    "projects/Uploads/Project Uploads"
  ],
  "summary": "List uploads",
  "description": "List the uploads the caller can see under an optional folder prefix, newest first by default, with the visible folders in a separate list. Requires project.uploads.read.",
  "parameters": [
    {
      "$ref": "#/components/parameters/ProjectReference"
    },
    {
      "schema": {
        "type": "string",
        "description": "Project-relative path to select direct-child files (for example, \"assets/\"). Omit to list all project files."
      },
      "required": false,
      "name": "path",
      "in": "query"
    },
    {
      "schema": {
        "type": "string",
        "minLength": 1,
        "maxLength": 4096,
        "description": "Opaque continuation; copy unchanged with the same project/path/sort. A removed anchor requires restarting; live changes affect traversal. Legacy ISO timestamps retain the creation cutoff and cannot recover ties."
      },
      "required": false,
      "name": "cursor",
      "in": "query"
    },
    {
      "$ref": "#/components/parameters/PaginationLimit"
    },
    {
      "schema": {
        "type": "string",
        "enum": [
          "created_at",
          "name",
          "size_bytes",
          "size"
        ],
        "default": "created_at",
        "description": "Sort field. Defaults to \"created_at\". \"size\" is accepted as another spelling of \"size_bytes\"."
      },
      "required": false,
      "name": "sort_by",
      "in": "query"
    },
    {
      "schema": {
        "type": "string",
        "enum": [
          "asc",
          "desc"
        ],
        "default": "desc",
        "description": "Sort order. Defaults to \"desc\"."
      },
      "required": false,
      "name": "sort_order",
      "in": "query"
    },
    {
      "schema": {
        "type": "boolean",
        "default": true,
        "description": "When true, returns all nested folders under the given path (or all folders if no path). Default: true."
      },
      "required": false,
      "name": "recursive",
      "in": "query"
    }
  ],
  "responses": {
    "200": {
      "description": "One page of uploads with the visible folders in `folders`. `data` also repeats the folders as `type: \"folder\"` items before the uploads (`type: \"file\"`).",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "data": {
                "type": "array",
                "items": {
                  "oneOf": [
                    {
                      "$ref": "#/components/schemas/UploadFolder"
                    },
                    {
                      "$ref": "#/components/schemas/UploadFile"
                    }
                  ],
                  "discriminator": {
                    "propertyName": "type",
                    "mapping": {
                      "folder": "#/components/schemas/UploadFolder",
                      "file": "#/components/schemas/UploadFile"
                    }
                  },
                  "description": "Upload item, either a folder (type: \"folder\") or a file (type: \"file\")"
                }
              },
              "folders": {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "path": {
                      "type": "string",
                      "description": "Folder path with a trailing slash."
                    },
                    "visibility": {
                      "type": "string",
                      "enum": [
                        "project",
                        "public",
                        "private"
                      ],
                      "description": "Effective access policy for the upload or folder."
                    },
                    "permission": {
                      "type": "string",
                      "enum": [
                        "read",
                        "write",
                        "admin"
                      ],
                      "description": "The caller’s effective access to this item: read, write, or admin."
                    },
                    "created_at": {
                      "type": "string",
                      "description": "Creation timestamp in ISO 8601 format."
                    }
                  },
                  "required": [
                    "path",
                    "visibility",
                    "permission",
                    "created_at"
                  ]
                },
                "description": "Visible folders, separate from the upload cursor and page size. The `data` items with `type: \"folder\"` repeat them."
              },
              "page_info": {
                "$ref": "#/components/schemas/PageInfo"
              }
            },
            "required": [
              "data",
              "folders",
              "page_info"
            ]
          }
        }
      }
    },
    "400": {
      "description": "Invalid request parameters",
      "content": {
        "application/problem+json": {
          "schema": {
            "$ref": "#/components/schemas/Problem"
          }
        }
      }
    },
    "401": {
      "description": "Unauthorized",
      "content": {
        "application/problem+json": {
          "schema": {
            "$ref": "#/components/schemas/Problem"
          }
        }
      }
    },
    "403": {
      "description": "Forbidden - insufficient permissions",
      "content": {
        "application/problem+json": {
          "schema": {
            "$ref": "#/components/schemas/Problem"
          }
        }
      }
    },
    "404": {
      "description": "Project or upload path not found",
      "content": {
        "application/problem+json": {
          "schema": {
            "$ref": "#/components/schemas/Problem"
          }
        }
      }
    },
    "500": {
      "description": "Server error",
      "content": {
        "application/problem+json": {
          "schema": {
            "$ref": "#/components/schemas/Problem"
          }
        }
      }
    }
  },
  "x-documentation-source-tag": "Project Uploads",
  "x-canonical-documentation": {
    "domain": "projects",
    "resource": "Uploads",
    "subgroup": "Project Uploads",
    "name": "List uploads",
    "description": "List the uploads the caller can see under an optional folder prefix, newest first by default, with the visible folders in a separate list. Requires project.uploads.read.",
    "operationId": "listUploads"
  },
  "x-mint": {
    "href": "/cloud/rest/api-reference/projects-uploads-project-uploads/list-uploads"
  }
}