List Box Sign Requests
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>"Node/TypeScript v10
await client.signRequests.getSignRequests();Python v10
client.sign_requests.get_sign_requests().NET v10
await client.SignRequests.GetSignRequestsAsync();Swift v10
try await client.signRequests.getSignRequests()Java v10
client.getSignRequests().getSignRequests()Java v4
Iterable<BoxSignRequest.Info> signRequests = BoxSignRequest.getAll(api);
for (BoxSignRequest.Info signRequestInfo : signRequests) {
// Do something with each `signRequestInfo`.
}Python v3
sign_requests = client.get_sign_requests()
for sign_request in sign_requests:
print(f'(Sign Request ID: {sign_request.id})').NET v5
BoxCollectionMarkerBased<BoxSignRequest> signRequests = await client.SignRequestsManager.GetSignRequestsAsync();Node v3
const result = await client.signRequests.getAll();
console.log(`There are ${result.count} sign requests`);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>"Node/TypeScript v10
await client.signRequests.getSignRequestById(createdSignRequest.id!);Python v10
client.sign_requests.get_sign_request_by_id(created_sign_request.id).NET v10
await client.SignRequests.GetSignRequestByIdAsync(signRequestId: NullableUtils.Unwrap(createdSignRequest.Id));Swift v10
try await client.signRequests.getSignRequestById(signRequestId: createdSignRequest.id!)Java v10
client.getSignRequests().getSignRequestById(createdSignRequest.getId())Java v4
BoxSignRequest signRequest = new BoxSignRequest(api, id);
BoxSignRequest.Info signRequestInfo = signRequest.getInfo();
//using `fields` parameter
BoxSignRequest.Info signRequestInfoWithFields = signRequest.getInfo("status")Python v3
sign_request = client.sign_request(sign_request_id='12345').get()
print(f'Sign Request ID is {sign_request.id}').NET v5
BoxSignRequest signRequest = await client.SignRequestsManager.GetSignRequestByIdAsync("12345");Node v3
const sr = await client.signRequests.getById({
sign_request_id: 12345,
});
console.log(
`Sign request id ${sr.id} contains ${sr.source_files.length} files`
);