Download document

Downloads a specific document associated with the provided UUID. This UUID represents a document which could be of type FCCORE_attachment, FCCORE_emailSent, FCCORE_letterSent, FCCORE_smsSent or DASHBOARD_email.

For S3-backed documents, the default behaviour is an HTTP 302 redirect to a signed S3 URL. Set mode=url to return the signed URL in a 200 JSON response instead. FCCORE_smsSent documents return 200 text/plain because SMS content is stored as text rather than an S3 file.

Set parser=email for supported inbound dashboard emails to return rendered 200 text/html content instead of a signed URL or redirect.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

This is a required string parameter provided in the path. It represents the unique identifier of the document that needs to be downloaded.

Query Params
string
enum

Optional response mode for S3-backed documents. The default is redirect, which returns 302 with a signed S3 URL in the Location header. Use url to return 200 application/json containing the signed URL.

Allowed:
string
enum

This is an optional query parameter that, when set to email, will render an email document into HTML rather than returning the raw email file. This parameter is useful when the UUID refers to a DASHBOARD_email.

Allowed:
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

mode=url, when downloading SMS text, or when rendering supported email content with parser=email.

documents:upload role.

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
text/plain
text/html
*/*