Uploads

Get an upload

Copy page

Returns an upload's metadata and current status. Requires customisers:read.

GET/api/v3/uploads/{upload_id}

Get an upload

Returns an upload's metadata and current status. Requires `customisers:read`. Uploads belonging to another store are indistinguishable from unknown ones. `status` is `pending` until the bytes arrive in staging and `uploaded` once they have, so this is how you confirm a presigned PUT landed before attaching. The presigned target is never returned here: it exists only on the create response.

Get an upload

Click Send to see the live response.

Overview

Uploads belonging to another store are indistinguishable from unknown ones. status is pending until the bytes arrive in staging and uploaded once they have, so this is how you confirm a presigned PUT landed before attaching. The presigned target is never returned here: it exists only on the create response.

Authorisation

Bearer token required. Include it in the Authorization header.

Required scope: customisers:read

Path parameters

upload_idstringpathrequired

The opaque upload ID.

Example: upl_9f2c4b7ad13e6058ba41cd4201

Get an upload

curl https://web.signcustomiser.com/api/v3/uploads/upl_9f2c4b7ad13e6058ba41cd4201 \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_API_TOKEN'

{
  "data": {
    "object": "upload",
    "id": "upl_9f2c4b7ad13e6058ba41cd4201",
    "purpose": "font_ttf",
    "filename": "Signature.ttf",
    "content_type": "font/ttf",
    "byte_size": 184320,
    "status": "uploaded",
    "verification_failure_code": null,
    "expires_at": "2026-07-23T00:00:00Z",
    "attached_at": null,
    "created_at": "2026-07-22T00:00:00Z",
    "upload_target": null
  },
  "links": {
    "self": "https://web.signcustomiser.com/api/v3/uploads/upl_9f2c4b7ad13e6058ba41cd4201",
    "documentation": "https://www.signcustomiser.com/help/api/"
  },
  "meta": {
    "api_version": "v3",
    "request_id": "req_01jz9x2k7c8f3m5n6p7q8r9s0t"
  }
}

{
  "type": "https://www.signcustomiser.com/help/api/problems/missing_api_key",
  "title": "Missing API key",
  "status": 401,
  "code": "missing_api_key",
  "detail": "Provide a store API key as a bearer token.",
  "request_id": "req_01jz9x2k7c8f3m5n6p7q8r9s0t"
}

{
  "type": "https://www.signcustomiser.com/help/api/problems/insufficient_scope",
  "title": "Insufficient scope",
  "status": 403,
  "code": "insufficient_scope",
  "detail": "This operation requires the customisers:read scope.",
  "required_scopes": [
    "customisers:read"
  ],
  "granted_scopes": [
    "orders:read"
  ],
  "request_id": "req_01jz9x2k7c8f3m5n6p7q8r9s0t"
}

{
  "type": "https://www.signcustomiser.com/help/api/problems/resource_not_found",
  "title": "Resource not found",
  "status": 404,
  "code": "resource_not_found",
  "detail": "The requested resource does not exist or does not belong to the authenticated store.",
  "request_id": "req_01jz9x2k7c8f3m5n6p7q8r9s0t"
}

{
  "type": "https://www.signcustomiser.com/help/api/problems/unknown_parameter",
  "title": "Unknown query parameter",
  "status": 422,
  "code": "unknown_parameter",
  "detail": "This endpoint accepts no query parameters.",
  "request_id": "req_01jz9x2k7c8f3m5n6p7q8r9s0t"
}

{
  "type": "https://www.signcustomiser.com/help/api/problems/rate_limited",
  "title": "Too many requests",
  "status": 429,
  "code": "rate_limited",
  "detail": "You have exceeded the request limit for this API key.",
  "retry_after": 60,
  "request_id": "req_01jz9x2k7c8f3m5n6p7q8r9s0t"
}