curl --request GET \
--url https://formhug.ai/api/v1/f/{form_token}/associated_entry_options \
--header 'Authorization: Bearer <token>'import requests
url = "https://formhug.ai/api/v1/f/{form_token}/associated_entry_options"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://formhug.ai/api/v1/f/{form_token}/associated_entry_options', 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://formhug.ai/api/v1/f/{form_token}/associated_entry_options",
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://formhug.ai/api/v1/f/{form_token}/associated_entry_options"
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://formhug.ai/api/v1/f/{form_token}/associated_entry_options")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://formhug.ai/api/v1/f/{form_token}/associated_entry_options")
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{
"data": [
{
"entry_token": "aB2cD9eF",
"serial_number": 12,
"associated_fields": {
"field_1": "Sales",
"field_2": "A***e"
},
"display_fields": {
"field_5": "138****5678"
}
}
],
"pagination": {
"total": 123,
"next_cursor": "NQ=="
}
}{
"error": "Invalid token"
}{
"error": "Name can't be blank",
"error_details": [
{
"attribute": "name",
"message": "can't be blank"
}
]
}{
"error": "Form not found"
}{
"error": "`field_api_code` must reference a `linked_form` field on this form"
}Discover candidate entries for a linked_form field
Lists candidate entries for a linked_form field on a published form, so a filler can
pick a value and obtain the entry_token to submit. field_api_code must reference a
linked_form field among the form’s public fields.
Values are rendered exactly as the published form shows them: the searched key field is returned as plain text, while other key fields (and display fields configured as privacy-protected) are masked.
Results are paginated by cursor and ordered by the candidate entry’s serial number,
descending. pagination.total is an upper bound: an in-page match recheck may drop rows,
so a page can contain fewer items than requested even when more pages follow.
For a privacy-protected linked_form field, q is required and matched exactly.
Required scope: form:respond.
curl --request GET \
--url https://formhug.ai/api/v1/f/{form_token}/associated_entry_options \
--header 'Authorization: Bearer <token>'import requests
url = "https://formhug.ai/api/v1/f/{form_token}/associated_entry_options"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://formhug.ai/api/v1/f/{form_token}/associated_entry_options', 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://formhug.ai/api/v1/f/{form_token}/associated_entry_options",
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://formhug.ai/api/v1/f/{form_token}/associated_entry_options"
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://formhug.ai/api/v1/f/{form_token}/associated_entry_options")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://formhug.ai/api/v1/f/{form_token}/associated_entry_options")
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{
"data": [
{
"entry_token": "aB2cD9eF",
"serial_number": 12,
"associated_fields": {
"field_1": "Sales",
"field_2": "A***e"
},
"display_fields": {
"field_5": "138****5678"
}
}
],
"pagination": {
"total": 123,
"next_cursor": "NQ=="
}
}{
"error": "Invalid token"
}{
"error": "Name can't be blank",
"error_details": [
{
"attribute": "name",
"message": "can't be blank"
}
]
}{
"error": "Form not found"
}{
"error": "`field_api_code` must reference a `linked_form` field on this form"
}Authorizations
Personal Access Token prefixed with fh_. Sent as Authorization: Bearer fh_xxx.
The scope required by each endpoint is listed in that endpoint's description.
Path Parameters
Token of a published form
Query Parameters
api_code of the linked_form field to look up candidates for.
Search text matched against the key field named by associated_field_api_code. Required for a privacy-protected field.
Which key field q matches. Must be one of the field's key api_codes; defaults to the first.
Exact-match constraints on other key fields, keyed by api_code (excluding the associated_field_api_code target).
Show child attributes
Show child attributes
Page size (1..100, default 20)
x <= 100Pagination cursor returned in the previous response as pagination.next_cursor
Was this page helpful?