Fair API Pricing

    No Surprise Fees

    Secure Your Document Distribution and Management with a Signority API Plan

    Home
    Home
    Quick Navigation
    Getting Started
    Getting Started
    Quick Start
    Testing
    Authentication
    Charging and Rate Limits
    API Reference
    API Reference
    Callbacks
    Constants
    Examples
    Examples
    Integration Examples
    Sample Code
    Anchor Tags
    Frequently Asked Questions
    Frequently Asked Questions
    Further Support

    List Documents

    GET: /v2/documents/search2

    Description
    Get a list of documents

     

    Format
    JSON <multipart/related>

     

    URL Parameters

    Name Mandatory Type Description
    pageIndex No Integer Index for the page to be retrieved (1 = first page, 2 = second page, etc.)
    pageSize No Integer Number of documents to be included in one page. Determines the number of documents that will be returned per request

    Data Parameters
    None
    Response
    Response returns a response containing the list of documents of the user as well as it’s information or an error response

     

    Response Parameters

    Field Mandatory Type Description
    documentCount Yes Integer The number of documents owned by the user
    id Yes Integer ID of the document
    title Yes String Name of the document
    signingStatus Yes Integer The current status of document
    * when creating or updating a document, if signingStatus = 52, system will send the invitation out to the recipients.
    SIGNING_STATUS_DRAFT = 51
    SIGNING_STATUS_IN_PROGRESS = 52
    SIGNING_STATUS_COMPLETED = 53
    SIGNING_STATUS_REJECTED = 54
    createdTime No Integer Time that the document was created
    lastModifiedTime No Integer Time of the last modification
    documentSentTime No Integer Time that the document was sent
    Year, Month, Day, Hour, Minute, Second, Millisecond
    user Yes JSONObject The owner of the account which is used to send this document out
    documentType Yes Integer DOCUMENT_TYPE_DOCUMENT = 5
    DOCUMENT_TYPE_TEMPLATE_LINK = 6
    DOCUMENT_TYPE_REGULAR_TEMPLATE = 7
    DOCUMENT_TYPE_BULK_TEMPLATE = 8

    EXAMPLE REQUEST / RESPONSE (Python)
    Request:
requests.get('https://sign.signority.com/api/v2/documents/search2', auth=(apiKey, ''))
Response:
{
    'documentCount': 2,
    'documents': [
        {
            'GUID': '8ec1f45a-bdf7-4972-8716-35919d12c768',
            'createdTime': 1590593250000,
            'deleted': False,
            'documentSentTime': 1590593252000,
            'documentType': 5,
            'eSigningStatus': 52,
            'firstRecipientName': 'user01@mail.com',
            'folderId': -5,
            'hasBouncedEmails': False,
            'hsmDigitalSignEnabled': False,
            'id': 27445,
            'invitationStatus': 60,
            'invitationType': 15,
            'isPublished': False,
            'lastModifiedTime': 1590593255000,
            'pkiEnabled': False,
            'sharedToTeam': False,
            'signerCount': 2,
            'signingStatus': 52,
            'templateLink': False,
            'title': 'API Test document 001 (11)',
            'user': 
                {
                    'companyname': 'Signority',
                    'email': 'signorityapidemo@gmail.com',
                    'id': 1354,
                    'name': 'Demo Account',
                    'usersgroupsroleId': 1198
                },
            'version': 6
        },
        {
            'GUID': 'a5d9aa5c-482c-4d2f-ada1-4db9fe0a9f22',
            'createdTime': 1590611014000,
            'deleted': False,
            'documentSentTime': 1590611014000,
            'documentType': 5,
            'eSigningStatus': 51,
            'firstRecipientName': 'pythonrecip@mail.com',
            'folderId': -5,
            'hasBouncedEmails': False,
            'hsmDigitalSignEnabled': False,
            'id': 27761,
            'invitationStatus': 60,
            'invitationType': 15,
            'isPublished': False,
            'lastModifiedTime': 1590611016000,
            'pkiEnabled': False,
            'sharedToTeam': False,
            'signerCount': 1,
            'signingStatus': 51,
            'templateLink': False,
            'title': 'API Test document 001',
            'user': 
                {
                    'companyname': 'Signority',
                    'email': 'signorityapidemo@gmail.com',
                    'id': 1354,
                    'name': 'Demo Account',
                    'usersgroupsroleId': 1198
                },
            'version': 4
        }
    ],
    'success': True
}