Download a file of a request

Changed on Oct 28, 2026

A single-use link to a file a message carries on one of the customer's own requests. A file of a type Chrome and Firefox both show as a page from such a link (a JPEG, PNG, GIF, WebP, AVIF or BMP image, or a PDF) is served inline; anything else downloads, every recording included.

get/hd/desks/{desk_id}/attachments/{attachment_id}/download

Request

Base URL
https://api.sparkvault.com/v1
Auth
HTTP bearer
TypeScript
https://skmtc.dev/sparkvault/apis/sparkvault-api/docs/hd/desks/:desk_id/attachments/:attachment_id/download/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

desk_idstring required

The desk, as its lookup answered it.

attachment_idstring required

The file, as the request's timeline names it.

Query parameters

ticketinteger required

The number of the request the file is on.

Headers

X-SV-Client'help-desk-portal' required

Names the portal. A request without it answers 400 CLIENT_HEADER_REQUIRED.

Response

The link.

Changes

Oct 28, 2026a9a10e328ba5 Revision changes
- info
  the response property / became required for the status
- info
  the response property / became required for the status
- info
  the response property / became required for the status
- info
  the response property / became required for the status
- info
  the response property / became required for the status
- info
  the response property / became required for the status
- info
  the response property became required for the status
- info
  the response property became required for the status
- info
  the response property became required for the status
- info
  the response property became required for the status
- info
  the response property became required for the status
- info
  the response property became required for the status
- info
  the response property / became required for the status
- info
  the response property / became required for the status
- info
  the response property / became required for the status
- info
  the response property / became required for the status
- info
  the response property / became required for the status
- info
  the response property / became required for the status
- info
  added the required property / to the response with the status
- info
  added the required property / to the response with the status
- info
  added the required property / to the response with the status
- info
  added the required property / to the response with the status
- info
  added the required property / to the response with the status
- info
  added the required property / to the response with the status
Oct 28, 202656d7c265a77a Revision changes
- breaking
  the response property / became nullable for the status
- breaking
  the response property / became nullable for the status
- breaking
  the response property / became nullable for the status
- breaking
  the response property / became nullable for the status
- breaking
  the response property / became nullable for the status
- breaking
  the response property / became nullable for the status

Operation history (3 revisions)