WIwithpersona
inquiries

Retrieve an Inquiry

Changed on

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.

get/inquiries/{inquiry-id}

Request

  • Base URL
    https://api.withpersona.com/api/v1
  • URL
    https://api.withpersona.com/api/v1/inquiries/{inquiry-id}
  • Auth
    HTTP bearer

Path parameters

inquiry-idstring required

Query parameters

includestring

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.

fieldsobject

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.

Headers

Key-Inflection'camel' | 'kebab' | 'snake'

Determines casing for the API response.

Idempotency-Keystring

Ensures the request is idempotent.

Persona-Version'2026-09-29' | '2025-12-08' | '2025-10-27' | '2023-01-05' | '2022-09-01' | '2021-08-18' | '2021-07-05' | '2021-02-21' | '2020-05-18'

Server API version. More info on versioning can be found here.

Response

This endpoint returns an Inquiry object and (optionally) its related objects in included.

Changes

  • e0c6bae9a292Revision changes
    • info

      added the optional property //// to the response with the status

  • 9b10833aac66Revision changes
    • breaking

      added subschema #16 to the / response property oneOf list for the response status