Get embedded signing request data (JWT authenticated)
curl --request POST \
--url https://api.firma.dev/functions/v1/signing-request-api/get-embedded-signing-request \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"companies_workspaces_signing_requests_id": "123e4567-e89b-12d3-a456-426614174000"
}
'import requests
url = "https://api.firma.dev/functions/v1/signing-request-api/get-embedded-signing-request"
payload = { "companies_workspaces_signing_requests_id": "123e4567-e89b-12d3-a456-426614174000" }
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
companies_workspaces_signing_requests_id: '123e4567-e89b-12d3-a456-426614174000'
})
};
fetch('https://api.firma.dev/functions/v1/signing-request-api/get-embedded-signing-request', 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.firma.dev/functions/v1/signing-request-api/get-embedded-signing-request",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'companies_workspaces_signing_requests_id' => '123e4567-e89b-12d3-a456-426614174000'
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.firma.dev/functions/v1/signing-request-api/get-embedded-signing-request"
payload := strings.NewReader("{\n \"companies_workspaces_signing_requests_id\": \"123e4567-e89b-12d3-a456-426614174000\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.firma.dev/functions/v1/signing-request-api/get-embedded-signing-request")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"companies_workspaces_signing_requests_id\": \"123e4567-e89b-12d3-a456-426614174000\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.firma.dev/functions/v1/signing-request-api/get-embedded-signing-request")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"companies_workspaces_signing_requests_id\": \"123e4567-e89b-12d3-a456-426614174000\"\n}"
response = http.request(request)
puts response.read_body{
"signing_request": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"description": "<string>",
"document_url": "<string>",
"document_url_expires_at": "2023-11-07T05:31:56Z",
"document_page_count": 2,
"expiration_hours": 168,
"settings": {
"allow_download": true,
"attach_pdf_on_finish": true,
"allow_editing_before_sending": false,
"send_signing_email": true,
"send_finish_email": true,
"send_expiration_email": true,
"send_cancellation_email": true
},
"template_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"date_created": "2023-11-07T05:31:56Z",
"date_sent": "2023-11-07T05:31:56Z",
"date_finished": "2023-11-07T05:31:56Z",
"date_cancelled": "2023-11-07T05:31:56Z",
"expires_at": "2023-11-07T05:31:56Z",
"certificate": {
"generated": true,
"generated_on": "2023-11-07T05:31:56Z",
"has_error": true
},
"final_document_download_url": "<string>"
},
"fields": [
{
"position": {
"x": 50,
"y": 50,
"width": 50,
"height": 50
},
"page_number": 2,
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"required": false,
"recipient_id": "<string>",
"variable_name": "<string>",
"dropdown_options": [
"<string>"
],
"date_default": "2023-12-25",
"date_signing_default": false,
"multi_group_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"format_rules": {
"dateFormat": "MMMM dd, yyyy"
},
"validation_rules": {},
"read_only": false,
"read_only_value": "<string>"
}
],
"recipients": [
{
"first_name": "<string>",
"email": "jsmith@example.com",
"designation": "Signer",
"id": "<string>",
"_temp_id": "<string>",
"template_user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"last_name": "<string>",
"order": 2,
"phone_number": "<string>",
"street_address": "<string>",
"city": "<string>",
"state_province": "<string>",
"postal_code": "<string>",
"country": "<string>",
"title": "<string>",
"company": "<string>",
"custom_fields": {}
}
],
"reminders": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"hours": 2,
"subject": "<string>",
"message": "<string>",
"all_users": true,
"template_user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"date_created": "2023-11-07T05:31:56Z",
"date_changed": "2023-11-07T05:31:56Z"
}
]
}{
"error": "Validation Error",
"message": "Invalid input data",
"details": {
"name": "Name is required",
"email": "Invalid email format"
}
}{
"error": "Unauthorized",
"message": "Invalid API key"
}{
"error": "Not Found",
"message": "The requested resource was not found"
}Signing Requests
Get embedded signing request data jwt authenticated
POST
/
get-embedded-signing-request
Get embedded signing request data (JWT authenticated)
curl --request POST \
--url https://api.firma.dev/functions/v1/signing-request-api/get-embedded-signing-request \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"companies_workspaces_signing_requests_id": "123e4567-e89b-12d3-a456-426614174000"
}
'import requests
url = "https://api.firma.dev/functions/v1/signing-request-api/get-embedded-signing-request"
payload = { "companies_workspaces_signing_requests_id": "123e4567-e89b-12d3-a456-426614174000" }
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
companies_workspaces_signing_requests_id: '123e4567-e89b-12d3-a456-426614174000'
})
};
fetch('https://api.firma.dev/functions/v1/signing-request-api/get-embedded-signing-request', 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.firma.dev/functions/v1/signing-request-api/get-embedded-signing-request",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'companies_workspaces_signing_requests_id' => '123e4567-e89b-12d3-a456-426614174000'
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.firma.dev/functions/v1/signing-request-api/get-embedded-signing-request"
payload := strings.NewReader("{\n \"companies_workspaces_signing_requests_id\": \"123e4567-e89b-12d3-a456-426614174000\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.firma.dev/functions/v1/signing-request-api/get-embedded-signing-request")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"companies_workspaces_signing_requests_id\": \"123e4567-e89b-12d3-a456-426614174000\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.firma.dev/functions/v1/signing-request-api/get-embedded-signing-request")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"companies_workspaces_signing_requests_id\": \"123e4567-e89b-12d3-a456-426614174000\"\n}"
response = http.request(request)
puts response.read_body{
"signing_request": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"description": "<string>",
"document_url": "<string>",
"document_url_expires_at": "2023-11-07T05:31:56Z",
"document_page_count": 2,
"expiration_hours": 168,
"settings": {
"allow_download": true,
"attach_pdf_on_finish": true,
"allow_editing_before_sending": false,
"send_signing_email": true,
"send_finish_email": true,
"send_expiration_email": true,
"send_cancellation_email": true
},
"template_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"date_created": "2023-11-07T05:31:56Z",
"date_sent": "2023-11-07T05:31:56Z",
"date_finished": "2023-11-07T05:31:56Z",
"date_cancelled": "2023-11-07T05:31:56Z",
"expires_at": "2023-11-07T05:31:56Z",
"certificate": {
"generated": true,
"generated_on": "2023-11-07T05:31:56Z",
"has_error": true
},
"final_document_download_url": "<string>"
},
"fields": [
{
"position": {
"x": 50,
"y": 50,
"width": 50,
"height": 50
},
"page_number": 2,
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"required": false,
"recipient_id": "<string>",
"variable_name": "<string>",
"dropdown_options": [
"<string>"
],
"date_default": "2023-12-25",
"date_signing_default": false,
"multi_group_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"format_rules": {
"dateFormat": "MMMM dd, yyyy"
},
"validation_rules": {},
"read_only": false,
"read_only_value": "<string>"
}
],
"recipients": [
{
"first_name": "<string>",
"email": "jsmith@example.com",
"designation": "Signer",
"id": "<string>",
"_temp_id": "<string>",
"template_user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"last_name": "<string>",
"order": 2,
"phone_number": "<string>",
"street_address": "<string>",
"city": "<string>",
"state_province": "<string>",
"postal_code": "<string>",
"country": "<string>",
"title": "<string>",
"company": "<string>",
"custom_fields": {}
}
],
"reminders": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"hours": 2,
"subject": "<string>",
"message": "<string>",
"all_users": true,
"template_user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"date_created": "2023-11-07T05:31:56Z",
"date_changed": "2023-11-07T05:31:56Z"
}
]
}{
"error": "Validation Error",
"message": "Invalid input data",
"details": {
"name": "Name is required",
"email": "Invalid email format"
}
}{
"error": "Unauthorized",
"message": "Invalid API key"
}{
"error": "Not Found",
"message": "The requested resource was not found"
}Authorizations
API key for authentication. Use your API key directly without any prefix (e.g., 'your-api-key'). Bearer prefix is optional but not required.
Body
application/json
ID of the signing request to retrieve
Was this page helpful?
⌘I