Add the power of the Box AI API to your custom apps at Content Cloud Summit on May 15

List Box Sign templates

get

https://api.box.com/2.0

/sign_templates

Gets Box Sign templates created by a user.

Request

authorizationbearer [ACCESS_TOKEN]

content-typeapplication/json

Query Parameters

limit integer / int64in queryoptional

example1000max1000

The maximum number of items to return per page.

marker stringin queryoptional

exampleJV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii

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.

Response

200application/jsonBox Sign templates

Returns a collection of templates.

401application/jsonClient error

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

defaultapplication/jsonClient error

An unexpected client error.

get

List Box Sign templates

You can now try out some of our APIs live, right here in the documentation.

Request Example

cURL

curl -L -X GET "https://api.box.com/2.0/sign_templates?marker=JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii&limit=1000" \
     -H "authorization: Bearer <ACCESS_TOKEN>" \

.NET

BoxCollectionMarkerBased<BoxSignTemplate> signTemplates = await client.SignTemplatesManager.GetSignTemplatesAsync();

Java

Iterable<BoxSignTemplate.Info> signTemplates = BoxSignTemplate.getAll(api);
for (BoxSignTemplate.Info signTemplateInfo : signTemplates) {
	// Do something with each `signTemplateInfo`.
}

Python

sign_templates = client.get_sign_templates()
for sign_template in sign_templates:
    print(f'(Sign Template ID: {sign_template.id})')

Node

const result = await client.signTemplates.getAll();
console.log(`There are ${result.count} sign templates`);

TypeScript (Beta)

await client.signTemplates.getSignTemplates({
  limit: 2,
} satisfies GetSignTemplatesQueryParams);

Python (Beta)

client.sign_templates.get_sign_templates(limit=2)

.NET (Beta)

await client.SignTemplates.GetSignTemplatesAsync(queryParams: new GetSignTemplatesQueryParams(limit: 2));

Response Example

{
  "entries": [
    {
      "type": "sign-template",
      "id": "4206996024-14944f75-c34b-478a-95a1-264b1ff80d35",
      "name": "Official contract",
      "email_subject": "Sign Request from Acme",
      "email_message": "Hello! Please sign the document below",
      "days_valid": 2,
      "parent_folder": {
        "id": "12345",
        "etag": "1",
        "type": "folder",
        "sequence_id": "3",
        "name": "Contracts"
      },
      "source_files": [
        {
          "id": "12345",
          "etag": "1",
          "type": "file",
          "sequence_id": "3",
          "name": "Contract.pdf",
          "sha1": "85136C79CBF9FE36BB9D05D0639C70C265C18D37",
          "file_version": {
            "id": "12345",
            "type": "file_version",
            "sha1": "134b65991ed521fcfe4724b7d814ab8ded5185dc"
          }
        }
      ],
      "are_fields_locked": false,
      "are_options_locked": true,
      "are_recipients_locked": false,
      "are_email_settings_locked": true,
      "are_files_locked": true,
      "signers": [
        {
          "inputs": [
            {
              "document_tag_id": "1234",
              "text_value": "text",
              "checkbox_value": true,
              "date_value": "2021-04-26",
              "type": "text",
              "content_type": "text",
              "is_required": true,
              "page_index": 4,
              "document_id": "123075213-eb54b537-8b25-445e-87c1-5a1c67d8cbd7",
              "dropdown_choices": [
                "Yes",
                "No",
                "Maybe"
              ],
              "group_id": "da317330-225a-4c72-89ad-0d6dcaaf4df6",
              "coordinates": {
                "x": 0.672258592471358,
                "y": 0.18654283173599448
              },
              "dimensions": {
                "width": 0.2618657937806874,
                "height": 0.05311728090109673
              },
              "label": "Legal name",
              "read_only": true
            }
          ],
          "email": "example@mail.com",
          "role": "signer",
          "is_in_person": true,
          "order": 2,
          "signer_group_id": "cd4ff89-8fc1-42cf-8b29-1890dedd26d7"
        }
      ],
      "additional_info": {
        "non_editable": [
          "email_subject",
          "name"
        ],
        "required": {
          "signers": [
            [
              "email"
            ],
            [
              "email"
            ]
          ]
        }
      },
      "ready_sign_link": {
        "url": "\"https://app.box.com/sign/\nready-sign-link/a1cdf2c7-fa81-4a67-8163-1e5f4dbe5178\"",
        "name": "Official contract",
        "instructions": "Hello! Please sign the document below",
        "folder_id": "12345",
        "is_notification_disabled": true,
        "is_active": false
      },
      "custom_branding": {
        "company_name": "Corporation inc.",
        "logo_uri": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAA\nAAEAAAABCAQAAAC1HAwCAAAAC0lEQVR42mNk+A\n8AAQUBAScY42YAAAAASUVORK5CYII=",
        "branding_color": "9E5E6F",
        "email_footer_text": "Contact email email@mail.com"
      }
    }
  ],
  "limit": 1000,
  "next_marker": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii",
  "prev_marker": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVih"
}