Skip to main content
GET
Download an attachment
Any member of the organization can download it. The url works for 10 minutes: fetch it with a plain GET, without an Authorization header, and ask for a new one whenever you need the file — don’t store it. It always serves the file exactly as it was uploaded. Only an AVAILABLE attachment can be downloaded. Right after the upload, while it is still PENDING_UPLOAD, this answers 409 ATTACHMENT_NOT_AVAILABLE — retry shortly. A DELETED attachment answers the same 409, for good.

Path Parameters

realmId
string<uuid>
required

ID of your realm.

Format: UUID

organizationId
string<uuid>
required

ID of the organization the attachment belongs to.

Format: UUID

attachmentId
string<uuid>
required

ID of the attachment, as returned when it was created.

Format: UUID

Response

Successful response

A short-lived link to the attachment's file.

url
string
required

Pre-signed URL that serves the file for 10 minutes. Fetch it with a plain GET and no Authorization header; request a new one when it expires instead of storing it. (The example is shortened.)

Example:

"https://files.example.com/3f6c2a1e-8b4d-4f7a-9c2e-5d1b7a9e4c60.jpg?signature=…"

name
string
required

Name of the file, as sent when the attachment was created.

Example:

"cupom-fiscal-posto.jpg"

contentType
string
required

Media type of the file, as declared when the attachment was created.

Example:

"image/jpeg"