Join BoxWorks 2024 to discover what's possible with content and AI!
Register now!Fetches details of a specific Box Sign template.
123075213-7d117509-8f05-42e4-a5ef-5190a319d41d
The ID of a Box Sign template.
Returns details of a template.
Returned when the access token provided in the Authorization
header
is not recognized or not provided.
Returned if the template is not found or the user does not have access to the associated template.
An unexpected client error.
curl -L -X GET "https://api.box.com/2.0/sign_templates/12345678" \
-H "accept: application/json" \
-H "authorization: Bearer <ACCESS_TOKEN>" \
await client.signTemplates.getSignTemplateById(signTemplates.entries![0].id!);
client.sign_templates.get_sign_template_by_id(sign_templates.entries[0].id)
await client.SignTemplates.GetSignTemplateByIdAsync(templateId: NullableUtils.Unwrap(NullableUtils.Unwrap(signTemplates.Entries)[0].Id));
try await client.signTemplates.getSignTemplateById(templateId: signTemplates.entries![0].id!)
BoxSignTemplate signTemplate = new BoxSignTemplate(api, id);
BoxSignTemplate.Info signTemplateInfo = signTemplate.getInfo();
BoxSignTemplate signTemplate = await client.SignTemplatesManager.GetSignTemplateByIdAsync("12345");
const sr = await client.signTemplates.getById({
template_id: 12345,
});
console.log(
`Sign template id ${sr.id} contains ${sr.source_files.length} files`
);
{
"id": "4206996024-14944f75-c34b-478a-95a1-264b1ff80d35",
"type": "sign-template",
"additional_info": {
"non_editable": [
"email_subject",
"name"
],
"required": {
"signers": [
[
"email"
],
[
"email"
]
]
}
},
"are_email_settings_locked": true,
"are_fields_locked": false,
"are_files_locked": true,
"are_options_locked": true,
"are_recipients_locked": false,
"custom_branding": {
"branding_color": "9E5E6F",
"company_name": "Corporation inc.",
"email_footer_text": "Contact email email@mail.com",
"logo_uri": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAA\nAAEAAAABCAQAAAC1HAwCAAAAC0lEQVR42mNk+A\n8AAQUBAScY42YAAAAASUVORK5CYII="
},
"days_valid": 2,
"email_message": "Hello! Please sign the document below",
"email_subject": "Sign Request from Acme",
"name": "Official contract",
"parent_folder": {
"id": "12345",
"type": "folder",
"etag": "1",
"name": "Contracts",
"sequence_id": "3"
},
"ready_sign_link": {
"folder_id": "12345",
"instructions": "Hello! Please sign the document below",
"is_active": false,
"is_notification_disabled": true,
"name": "Official contract",
"url": "\"https://app.box.com/sign/\nready-sign-link/a1cdf2c7-fa81-4a67-8163-1e5f4dbe5178\""
},
"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",
"label": "Jane Doe",
"public_id": "RJZYYVPR"
}
],
"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"
}
}
]
}