Skip to main content
GET
Get Web inquiry

Headers

api-key
string
required
Example:

"secret_live_xxx"

Path Parameters

id
string
required

Web inquiry id (web_iq_...).

Example:

"web_iq_xxx"

Response

Inquiry found.

id
string

Web inquiry id (web_iq_...).

template_id
string | null
template_key
string | null
template_version
integer
name
string
description
string
query
string
fields
object[]
user_instruction
string

End-user instruction shown in the capture flow.

acceptance_guide
string
start_url
string<uri>
return_url
string<uri>
capture_type
enum<string>
Available options:
screenshot,
document
settings
object

Template-style settings, for example show_acceptance_guide.

max_retries
integer
metadata
object | null
expires_at
string<date-time>
created_at
string<date-time>
updated_at
string<date-time>
deleted_at
string<date-time> | null
subject_id
string
result
object | null

Latest processing result for this inquiry, or null if none yet.

sessions
object[]

Capture sessions for this inquiry, ordered by creation time.