Uploaded files

Get a file from a response

get
https://api.typeform.com/forms/{form_id}/responses/{response_id}/fields/{field_id}/files/{filename}

Download an uploaded file knowing its form, response, field and name. This endpoint requires your personal access token.

Request

Query Parameters

inline
string

Request a file with HTTP header Content-Disposition: inline. Possible values: true, false. Default: false

Path Parameters

form_id
, required

Unique ID for the form. Find in your form URL. For example, in the URL "https://mysite.typeform.com/to/u6nXL7" the form_id is u6nXL7.

response_id
string, required

Unique ID for the response.

field_id
string, required

Unique ID for the file upload field

filename
string, required

filename for the uploaded file

form_id
string, required

Unique ID for the form. Find in your form URL. For example, in the URL "https://mysite.typeform.com/to/u6nXL7" the form_id is u6nXL7.

response_id
string, required

Unique ID for the response.

field_id
string, required

Unique ID of a file upload field within the form.

filename
string, required

filename for the uploaded file.

Responses

Status

200 OK, with file contents inline

Status

400 Bad Request

Schema

code
string

A developer-readable snake_case key, indicating some idea of what type of error occurred.

description
string

A developer-readable description of the error, expanding on the terse code.

details Path 3
array of object

An optional object containing more detailed info regarding which field the error occurred in.

code
string

A developer-readable snake_case key, indicating some idea of what type of error occurred.

description
string

A developer-readable description about the field-level error.

field
string

Which field the error occurred. This could refer to a field in the request body, request header, or query parameter.

help
string

A URL linking to help content, to aid the client developer in resolving the error. This value should be provided whenever available.

in
string
Valid values:headerbodyquery

The type of field that caused the error.

help
string

A URL linking to help content, to aid the client developer in resolving the error. This value should be provided whenever available.

Status

401 Wrong credentials / no credentials provided

Schema

code
string

A developer-readable snake_case key, indicating some idea of what type of error occurred.

description
string

A developer-readable description of the error, expanding on the terse code.

details Path 3
array of object

An optional object containing more detailed info regarding which field the error occurred in.

code
string

A developer-readable snake_case key, indicating some idea of what type of error occurred.

description
string

A developer-readable description about the field-level error.

field
string

Which field the error occurred. This could refer to a field in the request body, request header, or query parameter.

help
string

A URL linking to help content, to aid the client developer in resolving the error. This value should be provided whenever available.

in
string
Valid values:headerbodyquery

The type of field that caused the error.

help
string

A URL linking to help content, to aid the client developer in resolving the error. This value should be provided whenever available.

Status

404 File not found

Schema

code
string

A developer-readable snake_case key, indicating some idea of what type of error occurred.

description
string

A developer-readable description of the error, expanding on the terse code.

details Path 3
array of object

An optional object containing more detailed info regarding which field the error occurred in.

code
string

A developer-readable snake_case key, indicating some idea of what type of error occurred.

description
string

A developer-readable description about the field-level error.

field
string

Which field the error occurred. This could refer to a field in the request body, request header, or query parameter.

help
string

A URL linking to help content, to aid the client developer in resolving the error. This value should be provided whenever available.

in
string
Valid values:headerbodyquery

The type of field that caused the error.

help
string

A URL linking to help content, to aid the client developer in resolving the error. This value should be provided whenever available.