Get a template

Arguments

Argument Required/optional Description
template_fingerprint required A string indicating the fingerprint of the template you want to retrieve

Example Request

cURL

curl https://api.signable.co.uk/v1/templates/84f3aec70d25a7b35844a0f51f70e9d0
-u d41d8cd98f00b204e9800998ecf8427e:x
		

PHP


// Download our PHP SDK Library here: https://github.com/Signable/signable-sdk-php
$response = Signable\Templates::getSingle( "84f3aec70d25a7b35844a0f51f70e9d0" );
// Output the response
var_dump($response);
			

Example Response

{
    "http": 200,
    "template_id": "1000",
    "template_fingerprint": "d41d8cd98f00b204e9800998ecf8427e",
    "template_title": "Example Template",
    "template_page_total": "4",
    "template_in_progress": "0",
    "template_parties_total": "1",
    "template_parties": [
        {
            "party_id": "999",
            "party_name": "Signatory",
            "party_merge_fields": [
                {
                    "field_id": "1234",
                    "field_merge": "Rent",
                    "field_type": "text"
                }
            ]
        }
    ],
    "template_widget_url": "https://app.signable.co.uk/widget/url/ABC1234",
    "template_widget_embed": "<script type='text/javascript' src='https://app.signable.co.uk/widget/embed/ABC1234'></script>",
    "template_pdf_url": "http://docs.signable.co.uk/original/d41d8cd98f00b204e9800998ecf8427e.pdf",
    "template_thumbnails": [
        "http://docs.signable.co.uk/small/d41d8cd98f00b204e9800998ecf8427e-0.jpg",
        "http://docs.signable.co.uk/small/d41d8cd98f00b204e9800998ecf8427e-1.jpg",
        "http://docs.signable.co.uk/small/d41d8cd98f00b204e9800998ecf8427e-2.jpg",
        "http://docs.signable.co.uk/small/d41d8cd98f00b204e9800998ecf8427e-3.jpg"
    ],
    "template_pages": [
        "http://docs.signable.co.uk/large/d41d8cd98f00b204e9800998ecf8427e-0.jpg",
        "http://docs.signable.co.uk/large/d41d8cd98f00b204e9800998ecf8427e-1.jpg",
        "http://docs.signable.co.uk/large/d41d8cd98f00b204e9800998ecf8427e-2.jpg",
        "http://docs.signable.co.uk/large/d41d8cd98f00b204e9800998ecf8427e-3.jpg"
    ],
    "template_uploaded": "2013-10-04T11:57:59+0000"
}

 


List templates

Arguments

Argument Required/optional Description
offset optional A positive integer indicating the first record to retrieve. Defaults to the first template.
limit optional A positive integer indicating the maximum number of templates to return. Defaults to 10.

Example Request

cURL

curl https://api.signable.co.uk/v1/templates?offset=0&limit=3 
-u d41d8cd98f00b204e9800998ecf8427e:x
		

PHP


// Download our PHP SDK Library here: https://github.com/Signable/signable-sdk-php
$response = Signable\Templates::getMultiple(0,10);
// Output the response
var_dump($response);
			

Example Response

{
   "http":200,
   "offset":0,
   "limit":3,
   "total_templates":"10",
   "next":"https://api.signable.co.uk/v1/templates?offset=3&limit=3",
   "templates":[
      {
         "template_id":"1000",
         "template_fingerprint":"d41d8cd98f00b204e9800998ecf8427e",
         "template_title":"Example Template",
         "template_page_total":"4",
         "template_in_progress":"0",
         "template_parties_total":"1",
         "template_widget_url":"https://app.signable.co.uk/widget/url/ABC123",
         "template_widget_embed":"<script type='text/javascript' src='https://app.signable.co.uk/widget/embed/ABC123'></script>",
         "template_pdf_url":"http://docs.signable.co.uk/original/d41d8cd98f00b204e9800998ecf8427e.pdf",
         "template_thumbnails":[
            "http://docs.signable.co.uk/small/d41d8cd98f00b204e9800998ecf8427e-0.jpg",
            "http://docs.signable.co.uk/small/d41d8cd98f00b204e9800998ecf8427e-1.jpg",
            "http://docs.signable.co.uk/small/d41d8cd98f00b204e9800998ecf8427e-2.jpg",
            "http://docs.signable.co.uk/small/d41d8cd98f00b204e9800998ecf8427e-3.jpg"
         ],
         "template_pages":[
            "http://docs.signable.co.uk/large/d41d8cd98f00b204e9800998ecf8427e-0.jpg",
            "http://docs.signable.co.uk/large/d41d8cd98f00b204e9800998ecf8427e-1.jpg",
            "http://docs.signable.co.uk/large/d41d8cd98f00b204e9800998ecf8427e-2.jpg",
            "http://docs.signable.co.uk/large/d41d8cd98f00b204e9800998ecf8427e-3.jpg"
         ],
         "template_parties":[
            {
               "party_id":"999",
               "party_name":"Signatory",
               "party_merge_fields":[
                  {
                     "field_id":"1234",
                     "field_merge":"Rent",
                     "field_type":"text"
                  }
               ]
            }
         ],
         "template_uploaded":"2013-10-04T11:57:59+0000"
      },
      {
         "template_id":"1001",
         "template_fingerprint":"d41d8cd98f00b204e9800998ecf8427e",
         "template_title":"Example Template 1",
         "template_page_total":"4",
         "template_in_progress":"0",
         "template_parties_total":"1",
         "template_widget_url":"https://app.signable.co.uk/widget/url/ABC123",
         "template_widget_embed":"<script type='text/javascript' src='https://app.signable.co.uk/widget/embed/ABC123'></script>",
         "template_pdf_url":"http://docs.signable.co.uk/original/d41d8cd98f00b204e9800998ecf8427e.pdf",
         "template_thumbnails":[
            "http://docs.signable.co.uk/small/d41d8cd98f00b204e9800998ecf8427e-0.jpg",
            "http://docs.signable.co.uk/small/d41d8cd98f00b204e9800998ecf8427e-1.jpg",
            "http://docs.signable.co.uk/small/d41d8cd98f00b204e9800998ecf8427e-2.jpg",
            "http://docs.signable.co.uk/small/d41d8cd98f00b204e9800998ecf8427e-3.jpg"
         ],
         "template_pages":[
            "http://docs.signable.co.uk/large/d41d8cd98f00b204e9800998ecf8427e-0.jpg",
            "http://docs.signable.co.uk/large/d41d8cd98f00b204e9800998ecf8427e-1.jpg",
            "http://docs.signable.co.uk/large/d41d8cd98f00b204e9800998ecf8427e-2.jpg",
            "http://docs.signable.co.uk/large/d41d8cd98f00b204e9800998ecf8427e-3.jpg"
         ],
         "template_parties":[
            {
               "party_id":"999",
               "party_name":"Signatory",
               "party_merge_fields":[
                  {
                     "field_id":"1234",
                     "field_merge":"Rent",
                     "field_type":"text"
                  }
               ]
            }
         ],
         "template_uploaded":"2013-10-04T11:57:59+0000"
      },
      {
         "template_id":"1002",
         "template_fingerprint":"d41d8cd98f00b204e9800998ecf8427e",
         "template_title":"Example Template 2",
         "template_page_total":"4",
         "template_in_progress":"0",
         "template_parties_total":"1",
         "template_widget_url":"https://app.signable.co.uk/widget/url/ABC123",
         "template_widget_embed":"<script type='text/javascript' src='https://app.signable.co.uk/widget/embed/ABC123'></script>",
         "template_pdf_url":"http://docs.signable.co.uk/original/d41d8cd98f00b204e9800998ecf8427e.pdf",
         "template_thumbnails":[
            "http://docs.signable.co.uk/small/d41d8cd98f00b204e9800998ecf8427e-0.jpg",
            "http://docs.signable.co.uk/small/d41d8cd98f00b204e9800998ecf8427e-1.jpg",
            "http://docs.signable.co.uk/small/d41d8cd98f00b204e9800998ecf8427e-2.jpg",
            "http://docs.signable.co.uk/small/d41d8cd98f00b204e9800998ecf8427e-3.jpg"
         ],
         "template_pages":[
            "http://docs.signable.co.uk/large/d41d8cd98f00b204e9800998ecf8427e-0.jpg",
            "http://docs.signable.co.uk/large/d41d8cd98f00b204e9800998ecf8427e-1.jpg",
            "http://docs.signable.co.uk/large/d41d8cd98f00b204e9800998ecf8427e-2.jpg",
            "http://docs.signable.co.uk/large/d41d8cd98f00b204e9800998ecf8427e-3.jpg"
         ],
         "template_parties":[
            {
               "party_id":"999",
               "party_name":"Signatory",
               "party_merge_fields":[
                  {
                     "field_id":"1234",
                     "field_merge":"Rent",
                     "field_type":"text"
                  }
               ]
            }
         ],
         "template_uploaded":"2013-10-04T11:57:59+0000"
      },

   ]
}

 


Delete a template

Arguments

Argument Required/optional Description
fingerprint required A string indicating the fingerprint of the template you want to delete

Example Request

cURL

curl https://api.signable.co.uk/v1/templates/4a7e40b0d6488b2a895e911216b79bb3 
   -u d41d8cd98f00b204e9800998ecf8427e:x 
   -X DELETE
		

PHP


// Download our PHP SDK Library here: https://github.com/Signable/signable-sdk-php
$response = Signable\Templates::delete( "4a7e40b0d6488b2a895e911216b79bb3" );
// Output the response
var_dump($response);
			

Example Response

{
    "http": 200,
    "message": "Test Template has been removed from your template list.",
    "template_id": "1000",
    "tempate_fingerprint": "4a7e40b0d6488b2a895e911216b79bb3",
    "tempate_title": "Test Template"
}