Get a customer file

GET/v1/api/store/{team_slug}/customer/{hash_id}/media/{id}

v1Operation ID v1_public_customer_media_show

Returns one file of the customer.

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 customer's id (id from List customers or Create a customer). A hash id from an earlier answer; unique keys and document numbers (such as PO0042) don't work here.

  • Example EDhVUaC6jbLbed
• idstringrequired

  The file's id (id from the list of the customer's or vendor's files). A hash id from an earlier answer; unique keys and document numbers (such as PO0042) don't work here.

  • Example uAu3dAKIaHyAYk

Request body

This operation takes no request body.

Response

200Successful response.

• dataobjectrequired
  Child fields (18)

  • collectionstringrequired

    Customer files: tax_exemption, internal_file or external_file. Vendor files: default, mockup or production_file.

  • created_atstring (date-time)required
  • file_namestringrequired
  • idstringrequired
  • mime_typestring | nullrequired
  • namestring | nullrequired

    The display name.

  • sizeintegerrequired

    Bytes.

  • custom_propertiesobject | array
  • customer_idstring

    Customer files only.

  • 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
  • is_imageboolean
  • positioninteger | null

    Where the file sorts.

  • previewobject | null

    Preview image links small, medium and large (250, 800 and 1200 px), or null when there is no preview.

  • 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. none: not an image.

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

    Where to download the file.

  • view_urlstring | null

    A signed link to view the file. It expires: read it fresh, and 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.

Related

• GETList a customer's files/v1/api/store/{team_slug}/customer/{hash_id}/media

Example request

curl

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

Example response 200

Response

{
  "data": {
    "collection": "tax_exemption",
    "created_at": "2026-11-01T09:00:00+00:00",
    "custom_properties": [],
    "customer_id": "V4keXwwxMQyXw7",
    "file_name": "resale-certificate.pdf",
    "id": "4GR9C3ZTMYtda5",
    "is_image": false,
    "mime_type": "application/pdf",
    "name": "Resale certificate 2026.pdf",
    "position": 0,
    "preview": null,
    "show_in_pdf": null,
    "size": 48211,
    "source_media_id": null,
    "url": "https://example.com/media/4GR9C3ZTMYtda5/download",
    "view_url": "https://example.com/media/4GR9C3ZTMYtda5/view"
  },
  "status": 200,
  "success": true
}