How to download all documents

To download all your documents, we recommend looping through all the pages of the List Signature Requests endpoint to obtain all the signature_request_ids. Then loop through the list of signature_request_ids to download each document using the Get Files endpoint.

Here's an example using the Ruby SDK:

1. Initiate the HelloSign client

def initiate_client
     HelloSign::Client.new :api_key => 'HELLOSIGN_API_KEY'
end

2. Obtain the total number of pages of Signature Requests returned from the List Signature Requests endpoint

def get_total_pages(client)
     list = client.get_signature_requests(page_size: 100)
     list.data["list_info"]["num_pages"]
end

3. Loop through the pages of the signature requests to combine into one list

def get_all_requests(client)
     signature_requests = []
     page = 1
     total_pages = get_total_pages(client)

     while page < total_pages + 1
        req = client.get_signature_requests(page_size: 100, page: page)
        signature_requests << req.data["signature_requests"]
        page += 1
     end

     signature_requests.flatten
end

4. Loop through all signature requests and downloads the completed documents

def download_requests(client, requests)
     requests.each do |req|
        download = client.signature_request_files(
          signature_request_i: req["signature_request_id"]
          file_type: "zip"
        )

        File.open("Download-#{req["signature_request_id"]}".zip", "wb") do |file|
          file.write(download)
        end
     end
end