API ReferenceInquiries

Retrieve an Inquiry

Retrieves the details of an existing Inquiry.

In the Embedded Flow, the inquiry-id is the first parameter of the onStart callback. In the Hosted Flow, the inquiry-id is a query parameter in the onComplete callback.

Template information will be found in data.relationships.inquiry-template if the inquiry is a Dynamic Flow inquiry, and in data.relationships.template if the inquiry is a Legacy 2.0 inquiry. For more information, see Dynamic Flow vs. Legacy Templates.

Path parameters

inquiry-idstringRequired

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Key-InflectionenumOptional
Determines casing for the API response
Allowed values:
Idempotency-KeystringOptional
Ensures the request is idempotent
Persona-VersionenumOptionalDefaults to 2023-01-05
Allowed values:

Query parameters

includestringOptional

A comma-separated list of relationship paths. This can be used to customize which related resources will be fully serialized in the included key in the response. See Serialization for more details.

fieldsmap from strings to stringsOptional

Comma-separated list(s) of attributes to include in the response. This can be used to customize which attributes will be serialized in the response. See Serialization for more details.

Response

OK
dataobject or null
An Inquiry object

Errors