Skip to main content

SignRequest API Client

API for SignRequest.com

PyPI version

Requirements.

Python 2.7 and 3.4+

Installation & Usage

pip install

pip install signrequest-python-client

(you may need to run pip with root permission: sudo pip install signrequest_python_client)

Then import the package:

import signrequest_client 

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import signrequest_client

API Documentation

Full API documentation, including code samples, can be found here: https://signrequest.com/api/v1/docs/

Getting Started

Please follow the installation procedure and then run the following:

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
default_configuration = signrequest_client.Configuration()
default_configuration.api_key['Authorization'] = 'YOUR_API_KEY'
default_configuration.api_key_prefix['Authorization'] = 'Token'
signrequest_client.Configuration.set_default(default_configuration)

# create an instance of the API class
api_instance = signrequest_client.DocumentsApi()
data = signrequest_client.Document(
    file_from_url='https://docs.google.com/document/d/1oI2R1SxfMNZXiz3jCQvorpoklF9xq_dCJnOpkI-zo80/edit?usp=sharing'
)


try:
    # Create a Document
    api_response = api_instance.documents_create(data)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DocumentsApi->documents_create: %s\n" % e)

Documentation for API Endpoints

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

Class Method HTTP request Description
ApiTokensApi api_tokens_list GET /api-tokens/ Retrieve a list of API tokens
DocumentAttachmentsApi document_attachments_create POST /document-attachments/ Create a Document Attachment
DocumentAttachmentsApi document_attachments_list GET /document-attachments/ Retrieve a list of Document Attachments
DocumentAttachmentsApi document_attachments_read GET /document-attachments/{uuid}/ Retrieve a Document Attachment
DocumentsApi documents_create POST /documents/ Create a Document
DocumentsApi documents_delete DELETE /documents/{uuid}/ Delete a Document
DocumentsApi documents_list GET /documents/ Retrieve a list of Documents
DocumentsApi documents_read GET /documents/{uuid}/ Retrieve a Document
DocumentsSearchApi documents_search_list GET /documents-search/ Search documents
EventsApi events_list GET /events/ Retrieve a list of Events
EventsApi events_read GET /events/{id}/ Retrieve an Event
SignrequestQuickCreateApi signrequest_quick_create_create POST /signrequest-quick-create/ Quick create a SignRequest
SignrequestsApi signrequests_cancel_signrequest POST /signrequests/{uuid}/cancel_signrequest/ Cancel a SignRequest
SignrequestsApi signrequests_create POST /signrequests/ Create a SignRequest
SignrequestsApi signrequests_list GET /signrequests/ Retrieve a list of SignRequests
SignrequestsApi signrequests_read GET /signrequests/{uuid}/ Retrieve a SignRequest
SignrequestsApi signrequests_resend_signrequest_email POST /signrequests/{uuid}/resend_signrequest_email/ Resend a SignRequest
TeamMembersApi team_members_list GET /team-members/ Retrieve a list of Team Members
TeamMembersApi team_members_read GET /team-members/{uuid}/ Retrieve a Team Member
TeamsApi teams_create POST /teams/ Create a Team
TeamsApi teams_delete DELETE /teams/{subdomain}/ Delete a Team
TeamsApi teams_invite_member POST /teams/{subdomain}/invite_member/ Invite a Team Member
TeamsApi teams_list GET /teams/ Retrieve a list of Teams
TeamsApi teams_partial_update PATCH /teams/{subdomain}/ Update a Team
TeamsApi teams_read GET /teams/{subdomain}/ Retrieve a Team
TemplatesApi templates_list GET /templates/ Retrieve a list of Templates
TemplatesApi templates_read GET /templates/{uuid}/ Retrieve a Template
WebhooksApi webhooks_create POST /webhooks/ Create a Webhook
WebhooksApi webhooks_delete DELETE /webhooks/{uuid}/ Delete a Webhook
WebhooksApi webhooks_list GET /webhooks/ Retrieve a list of Webhooks
WebhooksApi webhooks_partial_update PATCH /webhooks/{uuid}/ Partially update a Webhook
WebhooksApi webhooks_read GET /webhooks/{uuid}/ Retrieve a Webhook
WebhooksApi webhooks_update PUT /webhooks/{uuid}/ Update a Webhook

Documentation For Models

Documentation For Authorization

Token

  • Type: API key
  • API key parameter name: Authorization
  • Location: HTTP header

Author

tech-support@signrequest.com

Metadata

Release files for signrequest-python-client 2.1.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for signrequest-python-client 2.1.0
File Size Uploaded
signrequest-python-client-2.1.0.tar.gz 66.2 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for signrequest-python-client 2.1.0
File Interpreter ABI Platform
signrequest_python_client-2.1.0-py3-none-any.whl Python 3 none any Details

Total release size: 251.5 kB

Release files / signrequest-python-client-2.1.0.tar.gz

Download URL signrequest-python-client-2.1.0.tar.gz
Size 66.2 kB
Tags Source
SHA-256 checksum
How to use checksums
b480a9696e05b4099ad2002b181ec597980b4d41f4eb4170da7012e724893e2f
BLAKE2b-256 checksum
How to use checksums
b735cf1227f02ac57d42dafbf690bae7a0527174dac55942bbff2a77a4d27d2c
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.1.1 pkginfo/1.4.2 requests/2.20.1 setuptools/44.0.0 requests-toolbelt/0.8.0 tqdm/4.28.1 CPython/3.7.0

Release files / signrequest_python_client-2.1.0-py3-none-any.whl

Download URL signrequest_python_client-2.1.0-py3-none-any.whl
Size 185.3 kB
Tags Python 3
SHA-256 checksum
How to use checksums
29189d8898030dcd4343e2c2982b97d1a4c4b781bbe5fb68009c1418ef73cfcd
BLAKE2b-256 checksum
How to use checksums
256c279ea276c4859eb8ec2fc1ca820e2d72143ef52e5726f4bd6ddfcfce240a
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.1.1 pkginfo/1.4.2 requests/2.20.1 setuptools/44.0.0 requests-toolbelt/0.8.0 tqdm/4.28.1 CPython/3.7.0

Release history Release notifications | RSS feed

This release

2.1.0 This release

2 release files

2.0.0

2 release files

1.1.0

2 release files

1.0.0

3 release files

0.0.9

2 release files

0.0.8

2 release files

0.0.7

2 release files

0.0.6

2 release files

0.0.5

2 release files

0.0.4

2 release files

0.0.3

2 release files

0.0.2

1 release file

0.0.1

1 release file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page