Box Developer Documentation
Log in
Latest version

Get file request

get
https://api.box.com/2.0
/file_requests/:file_request_id

This endpoint is in the version 2024.0. No changes are required to continue using it. For more details, see Box API versioning.

Retrieves the information about a file request.

Related Guides

Request

bearer [ACCESS_TOKEN]
application/json

Path Parameters

stringin pathrequired
123

The unique identifier that represent a file request.

The ID for any file request can be determined by visiting a file request builder in the web application and copying the ID from the URL. For example, for the URL https://*.app.box.com/filerequest/123 the file_request_id is 123.

Response

application/jsonFile Request

Returns a file request object.

application/jsonClient error

Returned when the access token provided in the Authorization header is not recognized or not provided.

application/jsonClient error

Returned if the file request is not found, or the user does not have access to the associated folder.

application/jsonClient error

Returned if the file_request_id is not in a recognized format.

application/jsonClient error

An unexpected client error.

get
Get file request
You can now try out some of our APIs live, right here in the documentation.
Log in

Request Example

cURL
curl -i -X GET "https://api.box.com/2.0/file_requests/42037322" \
     -H "authorization: Bearer <ACCESS_TOKEN>"
TypeScript Gen
await client.fileRequests.getFileRequestById(fileRequestId);
Python Gen
client.file_requests.get_file_request_by_id(file_request_id)
.NET Gen
await client.FileRequests.GetFileRequestByIdAsync(fileRequestId: fileRequestId);
Swift Gen (Beta)
try await client.fileRequests.getFileRequestById(fileRequestId: fileRequestId)
Java
BoxFileRequest fileRequest = new BoxFileRequest(api, "id");
BoxFileRequest.Info fileRequestInfo = fileRequest.getInfo();
Python
file_request = client.file_request(file_request_id='123456').get()
print(f'File request {file_request.id} on folder {file_request.folder.name}')
.NET
BoxFileRequestObject fileRequest = await client.FileRequestsManager.GetFileRequestByIdAsync("12345");
Node
client.fileRequests.getById(fileRequestId)
iOS
client.fileRequests.get(fileRequestId: "123456") { result in
    guard case let .success(fileRequest) = result else {
        print("Error getting file request")
        return
    }
    
    print("File request title: \(fileRequest.title ?? "n/a"), description: \(fileRequest.description ?? "n/a")")
}

Response Example

{
  "id": "42037322",
  "type": "file_request",
  "created_at": "2020-09-28T10:53:43-08:00",
  "created_by": {
    "id": "11446498",
    "type": "user",
    "login": "ceo@example.com",
    "name": "Aaron Levie"
  },
  "description": "Following documents are requested for your process",
  "etag": "1",
  "expires_at": "2020-09-28T10:53:43-08:00",
  "folder": {
    "id": "12345",
    "type": "folder",
    "etag": "1",
    "name": "Contracts",
    "sequence_id": "3"
  },
  "is_description_required": true,
  "is_email_required": true,
  "status": "active",
  "title": "Please upload documents",
  "updated_at": "2020-09-28T10:53:43-08:00",
  "updated_by": {
    "id": "11446498",
    "type": "user",
    "login": "ceo@example.com",
    "name": "Aaron Levie"
  },
  "url": "/f/19e57f40ace247278a8e3d336678c64a"
}