Get form metadata

curl --request GET \
  --url https://api.paubox.com/v1/forms/public/form_data/{form_id}

const options = {method: 'GET'};

fetch('https://api.paubox.com/v1/forms/public/form_data/{form_id}', 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.paubox.com/v1/forms/public/form_data/{form_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$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.paubox.com/v1/forms/public/form_data/{form_id}"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.paubox.com/v1/forms/public/form_data/{form_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "title": "Patient Intake Form",
  "description": "Please complete before your appointment.",
  "form_json": {},
  "form_html": "<form>...</form>",
  "form_css": "form { font-family: sans-serif; }",
  "active": true,
  "customer_id": 123,
  "signable": false,
  "submission_count": 42,
  "created_at": "2024-01-15T10:30:00Z",
  "updated_at": "2024-06-01T08:00:00Z"
}

GET

public

form_data

{form_id}

Get form metadata

curl --request GET \
  --url https://api.paubox.com/v1/forms/public/form_data/{form_id}

const options = {method: 'GET'};

fetch('https://api.paubox.com/v1/forms/public/form_data/{form_id}', 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.paubox.com/v1/forms/public/form_data/{form_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$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.paubox.com/v1/forms/public/form_data/{form_id}"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.paubox.com/v1/forms/public/form_data/{form_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "title": "Patient Intake Form",
  "description": "Please complete before your appointment.",
  "form_json": {},
  "form_html": "<form>...</form>",
  "form_css": "form { font-family: sans-serif; }",
  "active": true,
  "customer_id": 123,
  "signable": false,
  "submission_count": 42,
  "created_at": "2024-01-15T10:30:00Z",
  "updated_at": "2024-06-01T08:00:00Z"
}

Path Parameters

form_id

string<uuid>

required

UUID of the form to retrieve

Response

Form found

string<uuid>

title

string

description

string | null

form_html

string | null

form_json

object | null

form_css

string | null

vanity_url

string | null

version

integer

active

boolean

customer_id

integer

signable

boolean

signature_confirmation_label

string | null

submission_count

integer

type

string | null

deleted

boolean

archived

boolean

created_at

string<date-time>

updated_at

string<date-time>

⌘I

Email API · Messages

Email API · Dynamic templates

Marketing · Campaigns

Marketing · Drip campaigns

Marketing · Subscribers

Marketing · Subscription lists

Marketing · Tracking links

Marketing · Analytics

Forms API

Get form metadata

Path Parameters

Response