List redline requests
curl --request GET \
--url https://api.formabledocs.com/v1/redline-requests \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.formabledocs.com/v1/redline-requests"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.formabledocs.com/v1/redline-requests', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.formabledocs.com/v1/redline-requests",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.formabledocs.com/v1/redline-requests"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.formabledocs.com/v1/redline-requests")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.formabledocs.com/v1/redline-requests")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body[
{
"templateId": "tmpl_abc123",
"status": "DisclosingPartyDraft",
"members": [
{
"role": "DisclosingParty",
"email": "jsmith@example.com",
"displayName": "<string>"
}
],
"testMode": true,
"currentRound": "Disclosing"
}
]{
"error": "updatedSince must be a valid ISO-8601 date string"
}{
"error": "Auth token not valid"
}{
"error": "Client not authorized to get redline requests"
}{
"error": "Internal server error"
}Redlining
List redline requests
Returns all redline requests for the authenticated client’s organization, newest updated first. Optionally pass updatedSince to return only rows with updated_at strictly after that instant (ISO-8601).
GET
/
redline-requests
List redline requests
curl --request GET \
--url https://api.formabledocs.com/v1/redline-requests \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.formabledocs.com/v1/redline-requests"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.formabledocs.com/v1/redline-requests', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.formabledocs.com/v1/redline-requests",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.formabledocs.com/v1/redline-requests"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.formabledocs.com/v1/redline-requests")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.formabledocs.com/v1/redline-requests")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body[
{
"templateId": "tmpl_abc123",
"status": "DisclosingPartyDraft",
"members": [
{
"role": "DisclosingParty",
"email": "jsmith@example.com",
"displayName": "<string>"
}
],
"testMode": true,
"currentRound": "Disclosing"
}
]{
"error": "updatedSince must be a valid ISO-8601 date string"
}{
"error": "Auth token not valid"
}{
"error": "Client not authorized to get redline requests"
}{
"error": "Internal server error"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Query Parameters
ISO-8601 timestamp; only redline requests updated strictly after this time are returned
Response
Redline requests retrieved successfully (empty array if none match)
The template ID associated with the redline request
Example:
"tmpl_abc123"
Current status of the redline request
Available options:
DisclosingPartyDraft, DisclosingPartyRequestedReview, DocumentReadyForSigning, ReceivingPartyDraft, ReceivingPartyOpened, ReceivingPartyRequestedReview List of members in the redline request
Show child attributes
Show child attributes
Whether the redline request is in test mode
The party whose turn it is in the current round
Available options:
Disclosing, Receiving