Gets signature requests created by a user. If the sign_files
and/or
parent_folder
are deleted, the signature request will not return in the list.
1000
1000
The maximum number of items to return per page.
JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii
Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination.
This requires usemarker
to be set to true
.
Returns a collection of sign requests
An unexpected client error.
curl -i -X GET "https://api.box.com/2.0/sign_requests" \
-H "authorization: Bearer <ACCESS_TOKEN>"
await client.signRequests.getSignRequests();
client.sign_requests.get_sign_requests()
await client.SignRequests.GetSignRequestsAsync();
try await client.signRequests.getSignRequests()
Iterable<BoxSignRequest.Info> signRequests = BoxSignRequest.getAll(api);
for (BoxSignRequest.Info signRequestInfo : signRequests) {
// Do something with each `signRequestInfo`.
}
sign_requests = client.get_sign_requests()
for sign_request in sign_requests:
print(f'(Sign Request ID: {sign_request.id})')
BoxCollectionMarkerBased<BoxSignRequest> signRequests = await client.SignRequestsManager.GetSignRequestsAsync();
const result = await client.signRequests.getAll();
console.log(`There are ${result.count} sign requests`);
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)
}
}
{
"entries": [
{
"is_document_preparation_needed": true,
"redirect_url": "https://www.example.com",
"declined_redirect_url": "https://declined-redirect.com",
"are_text_signatures_enabled": true,
"email_subject": "Sign Request from Acme",
"email_message": "Hello! Please sign the document below",
"are_reminders_enabled": true,
"name": "name",
"prefill_tags": [
{
"document_tag_id": "1234",
"text_value": "text",
"checkbox_value": true,
"date_value": "2021-04-26"
}
],
"days_valid": 2,
"external_id": "123",
"is_phone_verification_required_to_view": true,
"template_id": "123075213-af2c8822-3ef2-4952-8557-52d69c2fe9cb",
"external_system_name": "Box",
"type": "sign-request",
"source_files": [
{
"id": "12345",
"etag": "1",
"type": "file"
}
],
"signers": [
{
"email": "example@gmail.com",
"role": "signer",
"is_in_person": true,
"order": 2,
"embed_url_external_user_id": "1234",
"redirect_url": "https://example.com",
"declined_redirect_url": "https://declined-example.com",
"login_required": true,
"verification_phone_number": "6314578901",
"password": "SecretPassword123",
"signer_group_id": "cd4ff89-8fc1-42cf-8b29-1890dedd26d7",
"suppress_notifications": false,
"has_viewed_document": true,
"signer_decision": {
"type": "signed",
"finalized_at": "2021-04-26T08:12:13.982Z",
"additional_info": "Requesting changes before signing."
},
"inputs": [
{
"document_tag_id": "1234",
"text_value": "text",
"checkbox_value": true,
"date_value": "2021-04-26",
"type": "text",
"content_type": "signature",
"page_index": 4,
"read_only": true
}
],
"embed_url": "https://example.com",
"iframeable_embed_url": "https://app.box.com/embed/sign/document/gfhr4222-a331-494b-808b-79bc7f3992a3/f14d7098-a331-494b-808b-79bc7f3992a4"
}
],
"signature_color": "blue",
"id": "12345",
"prepare_url": "https://prepareurl.com",
"signing_log": {
"id": "12345",
"etag": "1",
"type": "file",
"sequence_id": "3",
"name": "Contract.pdf",
"sha1": "85136C79CBF9FE36BB9D05D0639C70C265C18D37",
"file_version": {
"id": "12345",
"type": "file_version",
"sha1": "134b65991ed521fcfe4724b7d814ab8ded5185dc"
}
},
"status": "converting",
"sign_files": {
"files": [
{
"id": "12345",
"etag": "1",
"type": "file",
"sequence_id": "3",
"name": "Contract.pdf",
"sha1": "85136C79CBF9FE36BB9D05D0639C70C265C18D37",
"file_version": {
"id": "12345",
"type": "file_version",
"sha1": "134b65991ed521fcfe4724b7d814ab8ded5185dc"
}
}
],
"is_ready_for_download": true
},
"auto_expire_at": "2021-04-26T08:12:13.982Z",
"parent_folder": {
"id": "12345",
"etag": "1",
"type": "folder",
"sequence_id": "3",
"name": "Contracts"
}
}
],
"limit": 1000,
"next_marker": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii"
}