Skip to content

Attachments

Partner-facing endpoints for retrieving appointment attachments and generating short-lived presigned URLs.

Operations

List attachments for an appointment

Request

Returns appointment attachments (e.g. referrals, worksheets) and a short-lived presigned URL for each attachment when available.

Response body is a JSON array. Fields below apply to each array item.

Security
Bearer
Path
domainstringrequired

Partner domain identifier for the organisation/tenant. Your bearer token is scoped to one or more domains and requests outside that scope are rejected.

Example:acme
appointmentIdstringrequired

Opaque appointment identifier within the specified domain. Preserve the value exactly as returned; values may look numeric but are not guaranteed to be numeric, so do not parse as an integer.

Example:200006
Query
urlTtlSecondsinteger, (int32), [ 60 .. 3600 ]

Optional presigned URL lifetime (in seconds). Defaults to 900 when omitted. Values outside 60-3600 are clamped.

Default:900
Example:urlTtlSeconds=900
dispositionstring

Optional content disposition for the presigned URL (inline for display, attachment for download). Defaults to inline.

Enum:"inline""attachment"
Example:disposition=inline
Headers
X-Correlation-Idstring

Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.

Example:4b7f0a91b4f54f2a
curl -i -X GET \
  'https://partnerdocs.qubs.io/_mock/openapi/integrations/v1/acme/appointments/200006/attachments?urlTtlSeconds=900&disposition=inline' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'X-Correlation-Id: 4b7f0a91b4f54f2a'

Responses

Array of attachments for the requested appointment, including short-lived presigned URLs when available.

Headers
X-Correlation-Idstring

Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.

Example:"4b7f0a91b4f54f2a"
Bodyapplication/json
Array [
guidstringrequired

Attachment GUID.

Example:"123"
appointmentIdstring
Example:"123"
categorystring

Attachment category (e.g. Referral, Worksheet).

Example:"Example category"
fileNamestring

Suggested filename for display/download.

Example:"Example Name"
fileExtensionstring
Example:"Example fileExtension"
addedDateTimenull or string, (date-time)

When the attachment was added (UTC).

Example:"2020-01-01T00:00:00Z"
addedByobject(UserSummaryResponse)

Who added the attachment when available.

lastModifiedDateTimenull or string, (date-time)

When the attachment was last modified (UTC).

Example:"2020-01-01T00:00:00Z"
lastModifiedByobject(UserSummaryResponse)

Who last modified the attachment when available.

urlnull or string

Short-lived presigned URL for retrieving the attachment content when available.

Example:"https://example.com"
urlExpiresAtUtcnull or string, (date-time)

UTC expiry timestamp for the presigned URL when available.

Example:"2020-01-01T00:00:00Z"
canPreviewboolean
Example:true
previewUnavailableReasonstring
Example:"Example previewUnavailableReason"
]
Response
[
  {
    "guid": "989dd0c7-13bb-4bba-b7a0-53a28bdf5155",
    "category": "Referral",
    "fileName": "referral.pdf",
    "addedDateTime": "2025-01-10T01:02:03Z",
    "addedBy": { … },
    "lastModifiedDateTime": "2025-01-10T01:02:03Z",
    "lastModifiedBy": { … },
    "url": "https://example.com/attachments/referral.pdf",
    "urlExpiresAtUtc": "2025-01-10T01:17:03Z"
  }
]