Box Developer Documentation
Log in
Latest version

List Box Sign requests

get
https://api.box.com/2.0
/sign_requests

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

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.

Request

bearer [ACCESS_TOKEN]
application/json

Query Parameters

integer (int64)in queryoptional
1000
1000

The maximum number of items to return per page.

stringin queryoptional
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.

string arrayin queryoptional
["sender1@boxdemo.com","sender2@boxdemo.com"]

A list of sender emails to filter the signature requests by sender. If provided, shared_requests must be set to true.

booleanin queryoptional
true
false

If set to true, only includes requests that user is not an owner, but user is a collaborator. Collaborator access is determined by the user access level of the sign files of the request. Default is false. Must be set to true if senders are provided.

Response

application/jsonBox Sign requests

Returns a collection of sign requests

application/jsonClient error

An unexpected client error.

get
List Box Sign requests
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/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();
Swift Gen (Beta)
try await client.signRequests.getSignRequests()
Java Gen (Beta)
client.getSignRequests().getSignRequests()
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)
    }
}

Response Example

{
  "entries": [
    {
      "are_reminders_enabled": true,
      "are_text_signatures_enabled": true,
      "days_valid": 2,
      "declined_redirect_url": "https://declined-redirect.com",
      "email_message": "Hello! Please sign the document below",
      "email_subject": "Sign Request from Acme",
      "external_id": "123",
      "external_system_name": "Box",
      "is_document_preparation_needed": true,
      "name": "name",
      "prefill_tags": [
        {
          "checkbox_value": true,
          "date_value": "2021-04-26",
          "document_tag_id": "1234",
          "text_value": "text"
        }
      ],
      "redirect_url": "https://www.example.com",
      "template_id": "123075213-af2c8822-3ef2-4952-8557-52d69c2fe9cb",
      "auto_expire_at": "2021-04-26T08:12:13.982Z",
      "collaborator_level": "owner",
      "id": "12345",
      "parent_folder": {
        "etag": "1",
        "id": "12345",
        "type": "folder",
        "name": "Contracts",
        "sequence_id": "3"
      },
      "prepare_url": "https://prepareurl.com",
      "sender_email": "sender@box.com",
      "sender_id": 12345,
      "sign_files": {
        "files": [
          {
            "etag": "1",
            "id": "12345",
            "type": "file",
            "file_version": {
              "id": "12345",
              "type": "file_version",
              "sha1": "134b65991ed521fcfe4724b7d814ab8ded5185dc"
            },
            "name": "Contract.pdf",
            "sequence_id": "3",
            "sha1": "85136C79CBF9FE36BB9D05D0639C70C265C18D37"
          }
        ],
        "is_ready_for_download": true
      },
      "signature_color": "blue",
      "signers": [
        {
          "declined_redirect_url": "https://declined-example.com",
          "email": "example@gmail.com",
          "embed_url_external_user_id": "1234",
          "is_in_person": true,
          "login_required": true,
          "order": 2,
          "password": "SecretPassword123",
          "redirect_url": "https://example.com",
          "role": "signer",
          "signer_group_id": "cd4ff89-8fc1-42cf-8b29-1890dedd26d7",
          "suppress_notifications": false,
          "verification_phone_number": "6314578901",
          "embed_url": "https://example.com",
          "has_viewed_document": true,
          "iframeable_embed_url": "https://app.box.com/embed/sign/document/gfhr4222-a331-494b-808b-79bc7f3992a3/f14d7098-a331-494b-808b-79bc7f3992a4",
          "inputs": [
            {
              "checkbox_value": true,
              "date_value": "2021-04-26",
              "document_tag_id": "1234",
              "text_value": "text",
              "content_type": "signature",
              "page_index": 4,
              "read_only": true,
              "type": "text"
            }
          ],
          "signer_decision": {
            "additional_info": "Requesting changes before signing.",
            "finalized_at": "2021-04-26T08:12:13.982Z",
            "type": "signed"
          }
        }
      ],
      "signing_log": {
        "etag": "1",
        "id": "12345",
        "type": "file",
        "file_version": {
          "id": "12345",
          "type": "file_version",
          "sha1": "134b65991ed521fcfe4724b7d814ab8ded5185dc"
        },
        "name": "Contract.pdf",
        "sequence_id": "3",
        "sha1": "85136C79CBF9FE36BB9D05D0639C70C265C18D37"
      },
      "source_files": [
        {
          "etag": "1",
          "id": "12345",
          "type": "file"
        }
      ],
      "status": "converting",
      "type": "sign-request"
    }
  ],
  "limit": 1000,
  "next_marker": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii"
}