Skip to content
Leadtime
English
EnglishDeutschNot translated
Esc
↑↓navigate↵open⌘Jpreview

Create project upload

Creates a new project upload record, linking an uploaded file to a project.

How to upload files:

  1. First, upload the file using POST /workspace/upload to obtain a fileId
  2. Then use that fileId in this endpoint to create the project upload record

Required fields:

  • projectId: The project to attach the upload to (must exist and user must have access)
  • fileId: The file ID from the workspace upload endpoint (must exist in workspace)

Optional fields:

  • description: Free text field for classifying the content (e.g., “Signed contract 10/28/2025”, “Kickoff protocol”)
  • categoryId: Thematic classification for organizing uploads (e.g., Contract, Offer, Documentation)

Validation:

  • Project must exist and belong to the workspace
  • User must have access to the project
  • File must exist and belong to the workspace
  • Category must exist and belong to the workspace (if provided)

What is returned: Complete upload details including file metadata, timestamps, and user information.

Note: This endpoint requires the Projects.manageUploads permission.

POST/projects/uploads
Authorization
AuthorizationOAuth2 access token · headerrequired
Scopes:api:write
or
AuthorizationBearer token (JWT) · headerrequired
Query parameters
fieldsToReturnstring

Comma-separated list of top-level response fields to return. Overrides the endpoint compact default unless responseShape=full is used.

responseShapestring

Advanced override. Omit for the endpoint compact default. Use full only when you need the complete endpoint response, including nested fields that are not selectable with fieldsToReturn.

Allowed:compactfull
Header parameters
LT-Response-Shapestring

Advanced override. Set to full only when you need the complete endpoint response, including nested fields that are not selectable with fieldsToReturn.

Allowed:full
Request body
requiredapplication/json
categoryIdobject | null

Optional UUID of a category for organizing uploads thematically (e.g., Contract, Offer, Documentation, Dossier). Categories help with filtering, sorting, and finding files. The category must exist in the workspace. Set to null to create an upload without a category. Categories can be created dynamically during upload if they do not exist yet.

descriptionstring

Optional free text description for classifying and identifying the upload content. Use clear, descriptive text like "Signed contract 10/28/2025", "Kickoff protocol", or "Technical specification v2". This helps users quickly understand what the file contains without opening it.

fileIdstringrequired

The UUID of the file obtained from the POST /workspace/upload endpoint. You must upload the file first using that endpoint to receive a fileId, then use that ID here. The file must exist in the workspace and belong to the same workspace.

projectIdstringrequired

The UUID of the project to attach this upload to. The project must exist in the workspace and the user must have access to it. This determines which project the file will be associated with.

Responses
200
categoryIdobject | nullrequired

UUID of the category assigned to this upload for thematic organization. Can be null if no category is assigned.

createdAtstringrequired

ISO 8601 formatted timestamp indicating when the upload record was created. Format: YYYY-MM-DDTHH:mm:ss.sssZ

descriptionobject | nullrequired

Free text description for classifying the upload content. Can be null if no description was provided.

fileIdstringrequired

UUID of the underlying file in workspace storage. This references the file uploaded via POST /workspace/upload.

fileNamestringrequired

Original filename of the uploaded file, as stored in the File relation. This is the name the file had when uploaded.

fileSizenumberrequired

Size of the file in bytes. Use this to display file sizes in a human-readable format (e.g., KB, MB).

idstringrequired

Unique identifier for the project upload record (UUID format)

mimeTypestringrequired

MIME type of the file indicating its format (e.g., application/pdf, image/png, text/plain). Retrieved from the File relation.

projectIdstringrequired

UUID of the project this upload belongs to. Determines which project the file is associated with.

updatedAtstringrequired

ISO 8601 formatted timestamp indicating when the upload record was last updated. Format: YYYY-MM-DDTHH:mm:ss.sssZ. This changes whenever any field of the upload is modified.

userIdstringrequired

UUID of the user who created this upload. This identifies who uploaded or last updated the file.

400

Validation errors

errorsobject
messagestring
statusCodenumber
401

Unauthorized - Invalid or missing authentication token

403

Forbidden - Insufficient API scopes or permissions

Try it
Server
Authorization
Parameters
Bodyapplication/json
Request
curl -X POST "https://leadtime.app/api/public/projects/uploads" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "categoryId": "123e4567-e89b-12d3-a456-426614174222",
  "description": "Project documentation for Q1 2024",
  "fileId": "123e4567-e89b-12d3-a456-426614174111",
  "projectId": "123e4567-e89b-12d3-a456-426614174000"
}'
Response
{
  "categoryId": "123e4567-e89b-12d3-a456-426614174222",
  "createdAt": "2024-01-01T12:00:00.000Z",
  "description": "Project documentation for Q1 2024",
  "fileId": "123e4567-e89b-12d3-a456-426614174111",
  "fileName": "documentation.pdf",
  "fileSize": 1048576,
  "id": "123e4567-e89b-12d3-a456-426614174333",
  "mimeType": "application/pdf",
  "projectId": "123e4567-e89b-12d3-a456-426614174000",
  "updatedAt": "2024-01-02T14:30:00.000Z",
  "userId": "123e4567-e89b-12d3-a456-426614174444"
}