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.
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).
Page size (1..100, default 20)
x <= 100Pagination cursor returned in the previous response as pagination.next_cursor