Skip to content

Latest commit

 

History

History
118 lines (80 loc) · 3.33 KB

TemplatesApi.md

File metadata and controls

118 lines (80 loc) · 3.33 KB
Raw

signrequest_client.TemplatesApi

All URIs are relative to https://signrequest.com/api/v1

Method HTTP request Description
templates_list GET /templates/ Retrieve a list of Templates
templates_read GET /templates/{uuid}/ Retrieve a Template

templates_list

InlineResponse2008 templates_list(page=page, limit=limit)

Retrieve a list of Templates

Example

from __future__ import print_function
import time
import signrequest_client
from signrequest_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: Token
configuration = signrequest_client.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
configuration.api_key_prefix['Authorization'] = 'Token'

# create an instance of the API class
api_instance = signrequest_client.TemplatesApi(signrequest_client.ApiClient(configuration))
page = 56 # int | A page number within the paginated result set. (optional)
limit = 56 # int | Number of results to return per page. (optional)

try:
    # Retrieve a list of Templates
    api_response = api_instance.templates_list(page=page, limit=limit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TemplatesApi->templates_list: %s\n" % e)

Parameters

Name Type Description Notes
page int A page number within the paginated result set. [optional]
limit int Number of results to return per page. [optional]

Return type

InlineResponse2008

Authorization

Token

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

templates_read

Template templates_read(uuid)

Retrieve a Template

Example

from __future__ import print_function
import time
import signrequest_client
from signrequest_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: Token
configuration = signrequest_client.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
configuration.api_key_prefix['Authorization'] = 'Token'

# create an instance of the API class
api_instance = signrequest_client.TemplatesApi(signrequest_client.ApiClient(configuration))
uuid = 'uuid_example' # str | 

try:
    # Retrieve a Template
    api_response = api_instance.templates_read(uuid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TemplatesApi->templates_read: %s\n" % e)

Parameters

Name Type Description Notes
uuid str

Return type

Template

Authorization

Token

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]