Box Developer Documentation
Log in

List Box Sign Requests

Guides Box Sign List Box Sign Requests
Edit this page

List Box Sign Requests

All

The get sign requests endpoint can be used to view a list of all Box Sign requests created by the user associated with the passed Access Token.

cURL
curl -i -X GET "https://api.box.com/2.0/sign_requests" \
     -H "authorization: Bearer <ACCESS_TOKEN>"
TypeScript Gen
await client.signRequests.getSignRequests();
Python Gen
client.sign_requests.get_sign_requests()
.NET Gen
await client.SignRequests.GetSignRequestsAsync();
Java
Iterable<BoxSignRequest.Info> signRequests = BoxSignRequest.getAll(api);
for (BoxSignRequest.Info signRequestInfo : signRequests) {
	// Do something with each `signRequestInfo`.
}
Python
sign_requests = client.get_sign_requests()
for sign_request in sign_requests:
    print(f'(Sign Request ID: {sign_request.id})')
.NET
BoxCollectionMarkerBased<BoxSignRequest> signRequests = await client.SignRequestsManager.GetSignRequestsAsync();
Node
const result = await client.signRequests.getAll();
console.log(`There are ${result.count} sign requests`);
iOS
let iterator = client.signRequests.list()
iterator.next { results in
    switch results {
    case let .success(page):
        for signRequest in page.entries {
            print("Sign request \(signRequest.id)")
        }

    case let .failure(error):
        print(error)
    }
}

By ID

The get sign requests by ID endpoint can be used to view information about a specific Box Sign request. This endpoint requires the sign request's ID, which can be obtained by using the get all Box Sign requests endpoint or in the response when creating a Box Sign request.

cURL
curl -i -X GET "https://api.box.com/2.0/sign_requests/<SIGN_REQUEST_ID>" \
     -H "authorization: Bearer <ACCESS_TOKEN>"
TypeScript Gen
await client.signRequests.getSignRequestById(createdSignRequest.id!);
Python Gen
client.sign_requests.get_sign_request_by_id(created_sign_request.id)
.NET Gen
await client.SignRequests.GetSignRequestByIdAsync(signRequestId: NullableUtils.Unwrap(createdSignRequest.Id));
Java
BoxSignRequest signRequest = new BoxSignRequest(api, id);
BoxSignRequest.Info signRequestInfo = signRequest.getInfo();

//using `fields` parameter
BoxSignRequest.Info signRequestInfoWithFields = signRequest.getInfo("status")
Python
sign_request = client.sign_request(sign_request_id='12345').get()
print(f'Sign Request ID is {sign_request.id}')
.NET
BoxSignRequest signRequest = await client.SignRequestsManager.GetSignRequestByIdAsync("12345");
Node
const sr = await client.signRequests.getById({
	sign_request_id: 12345,
});
console.log(
	`Sign request id ${sr.id} contains ${sr.source_files.length} files`
);
iOS
client.signRequests.getById(id: "1234") { (result: Result<SignRequest, BoxSDKError>) in
    guard case let .success(signRequest) = result else {
        print("Error getting sign request")
        return
    }

    print("Sign request \(signRequest.id)")
}