post https://api.safetyculture.io/documents/v1
Creates a new file in Documents and returns a URL to upload the file.
Use this endpoint to upload PDFs, Word documents, spreadsheets, or images to Documents. It is commonly used to migrate business documents from platforms like SharePoint into SafetyCulture. Files are stored in a centralized location, helping teams work from the most up-to-date version across the web and mobile apps.
This is a two-step process:
- POST to create the file record and receive a temporary
upload_url(valid for ~20 minutes). - PUT the raw file bytes to the returned
upload_urlto complete the upload. If you skip this step, the file record is created but the media won’t render in SafetyCulture. You can also automatically create folders by specifying a path in your request.
Requirements
- SafetyCulture Premium Plan or Enterprise Plan
- "Documents: Administration" permission
- Full seat
- "Edit" document access
Limitations
- You can upload files up to 50MB in DOCX, DOC, JPEG, JPG, PNG, PDF, XLS, and XLSX formats.
- You can add up to 10,000 files in total. Each folder can contain up to 200 items, which includes both files and subfolders.
Although you can specify each file's name and and description, the endpoint does not support storing external or third-party IDs as metadata. We recommend maintaining your own mapping between SafetyCulture file IDs and your external system IDs.