Get an uploaded file

GET/v1/api/store/{team_slug}/async_upload/{hash_id}

v1Operation ID v1_public_async_upload_show

Returns a file by id: its name, type, size and fresh signed links. It works for any file on your team, attached or not.

Permission

Any member of the team.

Path parameters

• team_slugstringrequired

  Your team slug, shown as Team ID next to your API key in Profile.

  • Example your-team
• hash_idstringrequired

  The file's id, from the upload answer. A hash id; unique keys and document numbers are refused with 404.

  • Example b0l2VJxwa3ppc7

Request body

This operation takes no request body.

Response

200Successful response.

• dataobjectrequired

  A file attached to a record has extra fields for it: job_id (with job_service and the current approval fields), job_preset_id (a job preset's file, with job_service: the preset's service ids), order_id, po_id or customer_id.

  Child fields (19)

  • assetUrlstring

    Images that are unattached uploads or job mockups only: a signed link the mockup editor uses. It expires; don't store it.

  • collectionstring

    An upload is default, mockup or production_file. A file attached to a record can be in another collection of that record.

  • created_atstring (date-time)
  • custom_propertiesobject | array

    Saved properties such as location and show_mockup. An empty list [] when there are none.

  • dimensionsobject | null

    Pixel size of an image, read from its header; null for other files and for images uploaded before the size was recorded.

    Child fields (2)

    • heightinteger
    • widthinteger
  • file_namestring
  • idstring

    The upload id. Pass it as attachment[].id to attach the file.

  • is_imageboolean
  • mime_typestring
  • namestring

    The original file name without its extension.

  • positioninteger | null

    The file's place in its list.

  • previewobject | null

    Preview links small, medium and large (250, 800 and 1200 px). Images up to 10 MB are their own preview, so they have these at once; a larger image has them once preview_state is ready. Other files have null while they are unattached uploads; once attached, some records (such as jobs) give them links to a converted preview.

    Child fields (3)

    • largestring
    • mediumstring
    • smallstring
  • previewUrlstring

    Same images only: a signed preview link for the mockup editor. It expires; don't store it.

  • preview_statestring

    ready: the preview links work. processing: an image over 10 MB whose stored preview a worker is still making (seconds); read the file again, or in the web app wait for media.preview_state_changed on the team channel. too_large: an image over 120 megapixels; it never gets a preview. failed: the worker gave up, or the converter could not read the original (missing, broken or unsupported); it is not retried. none: not an image.

    • One of: "ready", "processing", "too_large", "failed", "none"
  • show_in_pdfboolean | null
  • sizeinteger

    Bytes.

  • source_media_idstring | null

    The file this one was copied from, when it is a copy. Always null on job and job preset files.

  • urlstring

    A signed download link. It expires; don't store it.

  • view_urlstring

    A signed link to view the file. It expires; don't store it.

• statusintegerrequired
• successbooleanrequired

Errors

• 401The API key is missing or wrong (unauthenticated).

• 403You are not allowed to do this. api_access_not_in_plan: your team's plan doesn't include API access (Pro and above, with an active subscription or trial), so every request answers this until the team upgrades. When your role lacks the permission the operation needs, the body is only {"message": "Insufficient Permission"}. Other refusals use the error envelope, with unauthorized or user_is_not_authorized.

• 404Not found. page_not_found: the team slug is unknown, you are not a member of the team, or an id in the path is not one of this team's. code: null, with a message that starts "No query results for": there is no record with that id.

  When

  No file of this team has this id.

  Fix

  Use the id the upload returned.

Related

• POSTUpload a file/v1/api/store/{team_slug}/async_upload

Example request

curl

curl 'https://secure.yoprint.com/v1/api/store/your-team/async_upload/b0l2VJxwa3ppc7' \  -H 'Authorization: Bearer YOUR_API_KEY' \  -H 'Accept: application/json' \  -H 'X-Yoprint-Decimal-Format: exact-v1'

Example response 200

Response

{
  "data": {
    "assetUrl": "https://secure.yoprint.com/api/store/your-team/mockup-design-asset/b0l2VJxwa3ppc7/view",
    "collection": "mockup",
    "created_at": "2026-11-03T09:30:00+00:00",
    "custom_properties": [],
    "file_name": "front-logo.png",
    "id": "b0l2VJxwa3ppc7",
    "is_image": true,
    "mime_type": "image/png",
    "name": "front-logo",
    "position": 1,
    "preview": {
      "large": "https://example.com/media/front-logo-1200.png",
      "medium": "https://example.com/media/front-logo-800.png",
      "small": "https://example.com/media/front-logo-250.png"
    },
    "previewUrl": "https://secure.yoprint.com/api/store/your-team/mockup-design-asset/b0l2VJxwa3ppc7/preview?size=preview",
    "show_in_pdf": null,
    "size": 182044,
    "source_media_id": null,
    "url": "https://example.com/media/front-logo.png?download=1",
    "view_url": "https://example.com/media/front-logo.png"
  },
  "status": 200,
  "success": true
}