Sample - Box Platform API
GET/file_requests/{file_request_id}

Get a file request

Retrieves the details of a file request. Use file_request_id to obtain its status, submission settings, associated folder, generated URL, and timestamps.

1 parameter
file_request_idstringrequired
The unique identifier of the file request to retrieve.

5 status codes
200Returns a file request object containing its identifier, status, associated folder, submission settings, generated URL, and timestamps.
idstringrequired
The unique identifier for this file request.
typestringrequired
The value will always be `file_request`.
Allowed:file_request
titlestringoptional
The title of file request. This is shown in the Box UI to users uploading files. This defaults to title of the file request that was copied to create this file request.
descriptionstringoptional
The optional description of this file request. This is shown in the Box UI to users uploading files. This defaults to description of the file request that was copied to create this file request.
statusstringoptional
The status of the file request. This defaults to `active`. When the status is set to `inactive`, the file request will no longer accept new submissions, and any visitor to the file request URL will receive a `HTTP 404` status code. This defaults to status of file request that was copied to create this file request.
Allowed:activeinactive
is_email_requiredbooleanoptional
Whether a file request submitter is required to provide their email address. When this setting is set to true, the Box UI will show an email field on the file request form. This defaults to setting of file request that was copied to create this file request.
is_description_requiredbooleanoptional
Whether a file request submitter is required to provide a description of the files they are submitting. When this setting is set to true, the Box UI will show a description field on the file request form. This defaults to setting of file request that was copied to create this file request.
expires_atstringoptional
The date after which a file request will no longer accept new submissions. After this date, the `status` will automatically be set to `inactive`.
folderobjectrequired
urlstringoptional
The generated URL for this file request. This URL can be shared with users to let them upload files to the associated folder.
etagstringoptional
The HTTP `etag` of this file. This can be used in combination with the `If-Match` header when updating a file request. By providing that header, a change will only be performed on the file request if the `etag` on the file request still matches the `etag` provided in the `If-Match` header.
created_byobjectoptional
created_atstringrequired
The date and time when the file request was created.
updated_byobjectoptional
updated_atstringrequired
The date and time when the file request was last updated.
401Returned when the access token in the `Authorization` header is missing or not recognized.
typestringoptional
The value will always be `error`.
Allowed:error
statusintegeroptional
The HTTP status of the response.
codestringoptional
A Box-specific error code.
Allowed:createdacceptedno_contentredirectnot_modifiedbad_requestunauthorizedforbiddennot_foundmethod_not_allowedconflictprecondition_failed
messagestringoptional
A short message describing the error.
context_infoobjectoptional
A free-form object that contains additional context about the error. The possible fields are defined on a per-endpoint basis. `message` is only one example.
help_urlstringoptional
A URL that links to more information about why this error occurred.
request_idstringoptional
A unique identifier for this response, which can be used when contacting Box support.
404Returned when the file request is not found or the authenticated user does not have access to its associated folder.
typestringoptional
The value will always be `error`.
Allowed:error
statusintegeroptional
The HTTP status of the response.
codestringoptional
A Box-specific error code.
Allowed:createdacceptedno_contentredirectnot_modifiedbad_requestunauthorizedforbiddennot_foundmethod_not_allowedconflictprecondition_failed
messagestringoptional
A short message describing the error.
context_infoobjectoptional
A free-form object that contains additional context about the error. The possible fields are defined on a per-endpoint basis. `message` is only one example.
help_urlstringoptional
A URL that links to more information about why this error occurred.
request_idstringoptional
A unique identifier for this response, which can be used when contacting Box support.
405Returned when `file_request_id` is not in a recognized format.
typestringoptional
The value will always be `error`.
Allowed:error
statusintegeroptional
The HTTP status of the response.
codestringoptional
A Box-specific error code.
Allowed:createdacceptedno_contentredirectnot_modifiedbad_requestunauthorizedforbiddennot_foundmethod_not_allowedconflictprecondition_failed
messagestringoptional
A short message describing the error.
context_infoobjectoptional
A free-form object that contains additional context about the error. The possible fields are defined on a per-endpoint basis. `message` is only one example.
help_urlstringoptional
A URL that links to more information about why this error occurred.
request_idstringoptional
A unique identifier for this response, which can be used when contacting Box support.
defaultAn unexpected client error.
typestringoptional
The value will always be `error`.
Allowed:error
statusintegeroptional
The HTTP status of the response.
codestringoptional
A Box-specific error code.
Allowed:createdacceptedno_contentredirectnot_modifiedbad_requestunauthorizedforbiddennot_foundmethod_not_allowedconflictprecondition_failed
messagestringoptional
A short message describing the error.
context_infoobjectoptional
A free-form object that contains additional context about the error. The possible fields are defined on a per-endpoint basis. `message` is only one example.
help_urlstringoptional
A URL that links to more information about why this error occurred.
request_idstringoptional
A unique identifier for this response, which can be used when contacting Box support.

Error handling

A 401 is returned when the Authorization header is missing or its access token is not recognized. A 404 is returned when the file request is not found or the authenticated user cannot access its associated folder. A 405 is returned when file_request_id is not in a recognized format.