> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://docs.itspropel.com/llms.txt. > For full documentation content, see https://docs.itspropel.com/llms-full.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.itspropel.com/_mcp/server. # List Envelopes GET https://documents/envelopes Reference: https://docs.itspropel.com/propel-biz/30-documents/envelopes/list-envelopes ## OpenAPI Specification ```yaml openapi: 3.1.0 info: title: PropelBiz version: 1.0.0 paths: /documents/envelopes: get: operationId: list-envelopes summary: List Envelopes tags: - subpackage_30Documents.subpackage_30Documents/envelopes parameters: - name: status in: query description: >- Optional: Filter by envelope status - in: PENDING|DISPATCHED|IN_PROGRESS|COMPLETED|EXPIRED|REVOKED|DECLINED required: false schema: type: string - name: document_id in: query description: 'Optional: Filter by document UUID - exists:documents,id' required: false schema: type: string - name: parent_record_type in: query description: 'Optional: Polymorphic parent alias' required: false schema: type: string - name: parent_record_id in: query description: 'Optional: Parent record UUID' required: false schema: type: string - name: created_after in: query description: 'Optional: Lower bound on created_at - date format' required: false schema: type: string - name: created_before in: query description: 'Optional: Upper bound on created_at - date format' required: false schema: type: string - name: page in: query description: 'Optional: Page number' required: false schema: type: integer - name: per_page in: query description: 'Optional: Results per page - integer 1-200' required: false schema: type: integer - name: '{{tenant_key_name}}' in: header required: false schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: >- #/components/schemas/30 Documents_Envelopes_List Envelopes_Response_200 servers: - url: https:/ components: schemas: 30 Documents_Envelopes_List Envelopes_Response_200: type: object properties: {} description: Empty response body title: 30 Documents_Envelopes_List Envelopes_Response_200 ``` ## SDK Code Examples ```python import requests url = "https://https/documents/envelopes" querystring = {"status":"IN_PROGRESS","document_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6","parent_record_type":"contract","parent_record_id":"7c9e6679-7425-40de-944b-e07fc1f90ae7","created_after":"2024-01-01T00:00:00Z","created_before":"2024-04-01T00:00:00Z","page":"1","per_page":"15"} payload = {} headers = { "{{tenant_key_name}}": "X-Tenant-ID", "Content-Type": "application/json" } response = requests.get(url, json=payload, headers=headers, params=querystring) print(response.json()) ``` ```javascript const url = 'https://https/documents/envelopes?status=IN_PROGRESS&document_id=3fa85f64-5717-4562-b3fc-2c963f66afa6&parent_record_type=contract&parent_record_id=7c9e6679-7425-40de-944b-e07fc1f90ae7&created_after=2024-01-01T00%3A00%3A00Z&created_before=2024-04-01T00%3A00%3A00Z&page=1&per_page=15'; const options = { method: 'GET', headers: {'{{tenant_key_name}}': 'X-Tenant-ID', 'Content-Type': 'application/json'}, body: '{}' }; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go package main import ( "fmt" "strings" "net/http" "io" ) func main() { url := "https://https/documents/envelopes?status=IN_PROGRESS&document_id=3fa85f64-5717-4562-b3fc-2c963f66afa6&parent_record_type=contract&parent_record_id=7c9e6679-7425-40de-944b-e07fc1f90ae7&created_after=2024-01-01T00%3A00%3A00Z&created_before=2024-04-01T00%3A00%3A00Z&page=1&per_page=15" payload := strings.NewReader("{}") req, _ := http.NewRequest("GET", url, payload) req.Header.Add("{{tenant_key_name}}", "X-Tenant-ID") req.Header.Add("Content-Type", "application/json") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby require 'uri' require 'net/http' url = URI("https://https/documents/envelopes?status=IN_PROGRESS&document_id=3fa85f64-5717-4562-b3fc-2c963f66afa6&parent_record_type=contract&parent_record_id=7c9e6679-7425-40de-944b-e07fc1f90ae7&created_after=2024-01-01T00%3A00%3A00Z&created_before=2024-04-01T00%3A00%3A00Z&page=1&per_page=15") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Get.new(url) request["{{tenant_key_name}}"] = 'X-Tenant-ID' request["Content-Type"] = 'application/json' request.body = "{}" response = http.request(request) puts response.read_body ``` ```java import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.get("https://https/documents/envelopes?status=IN_PROGRESS&document_id=3fa85f64-5717-4562-b3fc-2c963f66afa6&parent_record_type=contract&parent_record_id=7c9e6679-7425-40de-944b-e07fc1f90ae7&created_after=2024-01-01T00%3A00%3A00Z&created_before=2024-04-01T00%3A00%3A00Z&page=1&per_page=15") .header("{{tenant_key_name}}", "X-Tenant-ID") .header("Content-Type", "application/json") .body("{}") .asString(); ``` ```php request('GET', 'https://https/documents/envelopes?status=IN_PROGRESS&document_id=3fa85f64-5717-4562-b3fc-2c963f66afa6&parent_record_type=contract&parent_record_id=7c9e6679-7425-40de-944b-e07fc1f90ae7&created_after=2024-01-01T00%3A00%3A00Z&created_before=2024-04-01T00%3A00%3A00Z&page=1&per_page=15', [ 'body' => '{}', 'headers' => [ 'Content-Type' => 'application/json', '{{tenant_key_name}}' => 'X-Tenant-ID', ], ]); echo $response->getBody(); ``` ```csharp using RestSharp; var client = new RestClient("https://https/documents/envelopes?status=IN_PROGRESS&document_id=3fa85f64-5717-4562-b3fc-2c963f66afa6&parent_record_type=contract&parent_record_id=7c9e6679-7425-40de-944b-e07fc1f90ae7&created_after=2024-01-01T00%3A00%3A00Z&created_before=2024-04-01T00%3A00%3A00Z&page=1&per_page=15"); var request = new RestRequest(Method.GET); request.AddHeader("{{tenant_key_name}}", "X-Tenant-ID"); request.AddHeader("Content-Type", "application/json"); request.AddParameter("application/json", "{}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let headers = [ "{{tenant_key_name}}": "X-Tenant-ID", "Content-Type": "application/json" ] let parameters = [] as [String : Any] let postData = JSONSerialization.data(withJSONObject: parameters, options: []) let request = NSMutableURLRequest(url: NSURL(string: "https://https/documents/envelopes?status=IN_PROGRESS&document_id=3fa85f64-5717-4562-b3fc-2c963f66afa6&parent_record_type=contract&parent_record_id=7c9e6679-7425-40de-944b-e07fc1f90ae7&created_after=2024-01-01T00%3A00%3A00Z&created_before=2024-04-01T00%3A00%3A00Z&page=1&per_page=15")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "GET" request.allHTTPHeaderFields = headers request.httpBody = postData as Data let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```