Skip to main content
GET
Discover candidate entries for a linked_form field

Authorizations

Authorization
string
header
required

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

form_token
string
required

Token of a published form

Query Parameters

field_api_code
string
required

api_code of the linked_form field to look up candidates for.

q
string

Search text matched against the key field named by associated_field_api_code. Required for a privacy-protected field.

associated_field_api_code
string

Which key field q matches. Must be one of the field's key api_codes; defaults to the first.

filters
object

Exact-match constraints on other key fields, keyed by api_code (excluding the associated_field_api_code target).

limit
integer
default:20

Page size (1..100, default 20)

Required range: x <= 100
cursor
string

Pagination cursor returned in the previous response as pagination.next_cursor

Response

Success

data
object[]
required
pagination
object
required
Last modified on July 24, 2026