Get one upload's metadata

GET /uploads/{uploadId}

Path parameters

uploadId string Required

Headers

Authorization string Required
Bearer <session token>: the signed-in user’s Scaffold session token.
x-org-id string Required

Returns

upload object
The persisted upload/document row, as returned by every route that creates or mutates upload content (create, save draft, rename, delete, new version, revision-apply, redline edits).
Show 19 fields
- id string
- artifactId string | null
- orgId string
- createdByUserId string | null
- fileName string
- mimeType string
- sizeBytes integer
- purpose string
  One of source_doc playbook
- clientReferenceId string | null
- documentSeriesId string
- documentVersion integer
- parentUploadId string | null
- versionKind string
  One of original working_draft
- storageKey string | null
- contentSha256 string | null
- hasBinary boolean
- status string
- createdAt string
- updatedAt string

cURL Node Python

curl -X GET "https://api.scaffoldyourdocs.com/uploads/upload_example" \
  -H "Authorization: Bearer <session token>" \
  -H "x-org-id: org_example"

const response = await fetch("https://api.scaffoldyourdocs.com/uploads/upload_example", {
  method: "GET",
  headers: {
    "Authorization": "Bearer <session token>",
    "x-org-id": "org_example"
  }
});

import requests

response = requests.get(
    "https://api.scaffoldyourdocs.com/uploads/upload_example",
    headers={
        "Authorization": "Bearer <session token>",
        "x-org-id": "org_example"
    }
)

Response (shape)

{
  "upload": {
    "id": "string",
    "artifactId": "string",
    "orgId": "string",
    "createdByUserId": "string",
    "fileName": "string",
    "mimeType": "string",
    "sizeBytes": 0,
    "purpose": "source_doc",
    "clientReferenceId": "string",
    "documentSeriesId": "string",
    "documentVersion": 0,
    "parentUploadId": "string",
    "versionKind": "original",
    "storageKey": "string",
    "contentSha256": "string",
    "hasBinary": true,
    "status": "string",
    "createdAt": "string",
    "updatedAt": "string"
  }
}