--- title: "Retrieve an Inquiry Template" method: GET path: "/inquiry-templates/{inquiry-template-id}" tags: ["inquiryTemplates"] --- # Retrieve an Inquiry Template `GET /inquiry-templates/{inquiry-template-id}` ## Request - Base URL: `https://api.withpersona.com/api/v1` - URL: `https://api.withpersona.com/api/v1/inquiry-templates/{inquiry-template-id}` - Auth: HTTP bearer Retrieves details of a specific Inquiry Template by ID. Note: You must use a production API key to access this endpoint. For security reasons, we do not expose organization-level resources like Inquiry Templates in Sandbox via API. ## Path parameters - `inquiry-template-id` string, required ## Query parameters - `include` string - `fields` object ## Headers - `Key-Inflection` 'camel' | 'kebab' | 'snake' - `Idempotency-Key` string - `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](https://docs.withpersona.com/versioning). ## Response `200` This endpoint returns an Inquiry Template object. - InquiryTemplatesRetrieveAnInquiryTemplateResponse200 - `data` InquiryTemplate, required: An Inquiry Template object - `id` string - `attributes` VerificationIncludedObjectsItemsDiscriminatorMappingInquiryTemplateAttributes - `name` string: Name of the Inquiry Template - `status` string: Possible values: - active - inactive Do not assume this is a static enumeration; Persona may add new values in the future without a versioned update. - `embedded-flow-domain-allowlist` string[]: List of domains allowed for embedded flows - `hosted-flow-subdomains` string[]: The subdomain that your hosted flow can be hosted on (e.g. "mycompany.withpersona.com") - `hosted-flow-redirect-uri-schemes` string[]: An allowlist that specifies the URI schemes for redirect after completion of a Hosted Flow. This can be used to implement deep linking for mobile integrations. If this list is empty, all URLs with the URI scheme http or https are allowed. - `field-schemas` FieldSchema[] - union - object: array variant - `type` 'array', required - `key` string - `label` string, nullable - `config` FieldSchemaArrayConfig - … - object: boolean variant - `type` 'boolean', required - `key` string - `label` string, nullable - `default-value` boolean, nullable - `config` FieldSchemaBooleanConfig - … - object: choices variant - `type` 'choices', required - `key` string - `label` string, nullable - `default-value` string, nullable: Must be one of the values in `config.options`, or null. - `config` FieldSchemaChoicesConfig - … - object: date variant - `type` 'date', required - `key` string - `label` string, nullable - `default-value` string, date, nullable - `config` FieldSchemaDateConfig - … - object: datetime variant - `type` 'datetime', required - `key` string - `label` string, nullable - `default-value` string, date-time, nullable - `config` FieldSchemaDatetimeConfig - … - object: email-address variant - `type` 'email-address', required - `key` string - `label` string, nullable - `default-value` string, nullable - `config` FieldSchemaEmailAddressConfig - … - object: file variant - `type` 'file', required - `key` string - `label` string, nullable - `config` FieldSchemaFileConfig - … - object: hash variant - `type` 'hash', required - `key` string - `label` string, nullable - `config` FieldSchemaHashConfig - … - object: integer variant - `type` 'integer', required - `key` string - `label` string, nullable - `default-value` integer, nullable - `config` FieldSchemaIntegerConfig - … - object: json variant - `type` 'json', required - `key` string - `label` string, nullable - `default-value` unknown - `config` FieldSchemaJsonConfig - … - object: multi-choices variant - `type` 'multi-choices', required - `key` string - `label` string, nullable - `default-value` string[], nullable: Each entry must be one of the values in `config.options`. - `config` FieldSchemaMultiChoicesConfig - … - object: number variant - `type` 'number', required - `key` string - `label` string, nullable - `default-value` number, double, nullable - `config` FieldSchemaNumberConfig - … - object: platform-file variant - `type` 'platform-file', required - `key` string - `label` string, nullable - `config` FieldSchemaPlatformFileConfig - … - object: string variant - `type` 'string', required - `key` string - `label` string, nullable - `default-value` string, nullable - `config` FieldSchemaStringConfig - … - object: relation-schema variant - `type` 'relation-schema', required - `key` string - `label` string, nullable - `config` FieldSchemaRelationConfig - … - `relationships` VerificationIncludedObjectsItemsDiscriminatorMappingInquiryTemplateRelationships - `latest-published-version` VerificationIncludedObjectsItemsDiscriminatorMappingInquiryTemplateRelationshipsLatestPublishedVersion - `data` VerificationIncludedObjectsItemsDiscriminatorMappingInquiryTemplateRelationshipsLatestPublishedVersionData - `type` 'inquiry-template-version' - `id` string - `included` InquiryTemplateIncludedObjectsItems[] - `type` 'inquiry-template-version', required: Discriminator value: inquiry-template-version - `id` string - `attributes` VerificationIncludedObjectsItemsDiscriminatorMappingInquiryTemplateVersionAttributes - `name-display` string, nullable - `description` string, nullable: A description of the changes in this version. - `status` string: Possible values: - published - draft Do not assume this is a static enumeration; Persona may add new values in the future without a versioned update. - `live` boolean: Whether this version is deployed in at least one environment. Reflects organization-wide state, so the value is the same for Sandbox and Production API keys. - `version-tag` VerificationIncludedObjectsItemsDiscriminatorMappingInquiryTemplateVersionAttributesVersionTag: The version's tag; null when the version is untagged. Omitted for Sandbox API keys and for API keys without `inquiry_template.read` on the parent Inquiry Template (for example, when this version is included in an Inquiry response). - `name` string, required - `description` string, nullable, required - `created-at` string, date-time, required - `deployments` VerificationIncludedObjectsItemsDiscriminatorMappingInquiryTemplateVersionAttributesDeploymentsItems[]: Deployment routes currently sending traffic to this version, one per environment; rules carry the strategy (constant today, weighted/conditional for partial rollouts) and version references carry each referenced version's token and serialized deployment tag. Omitted under the same conditions as `version-tag`. - `resource-type` string, required: The platform resource type the route targets. Possible values are `inquiry-template`, `workflow`, and `scheduled-run-config`. - `template-id` string, required: The token of the resource template the route targets. - `environment` VerificationIncludedObjectsItemsDiscriminatorMappingInquiryTemplateVersionAttributesDeploymentsItemsEnvironment, required: The environment the route applies to. - `token` string, required: The environment's token. - `name` string, required: The environment's display name. - `rules` VerificationIncludedObjectsItemsDiscriminatorMappingInquiryTemplateVersionAttributesDeploymentsItemsRulesItems[], required: The routing rules evaluated for the environment. Each rule has a strategy and may have a criteria tree with `and`, `or`, and `!` operators over context or resource origins. - `criteria` union: A deployment route criteria node: an `and`/`or`/`!` operator tree whose `origin` leaves are either `{ context }` or `{ resource-type, template-id, version }`. Version references carry the version token and its serialized deployment tag (null when the version is untagged). Each operator's operand may be a single node or a non-empty array of nodes. - DeploymentRouteCriteria0 - … - DeploymentRouteCriteria1 - … - DeploymentRouteCriteria2 - … - DeploymentRouteCriteria3 - … - `strategy` union, required - VerificationIncludedObjectsItemsDiscriminatorMappingInquiryTemplateVersionAttributesDeploymentsItemsRulesItemsStrategy0 - … - VerificationIncludedObjectsItemsDiscriminatorMappingInquiryTemplateVersionAttributesDeploymentsItemsRulesItemsStrategy1 - … - `last-updater` string, nullable: The email address of the User who last updated this version. - `enabled-locales` string[] - `created-at` string, date-time - `updated-at` string, date-time, nullable - `published-at` string, date-time, nullable - `theme` VerificationIncludedObjectsItemsDiscriminatorMappingInquiryTemplateVersionAttributesTheme - `border-radius` string, nullable - `border-radius-input` string, nullable - `border-radius-modal` string, nullable - `border-width` string, nullable - `border-width-input` string, nullable - `button-background-image` string, nullable - `button-font-weight` string, nullable - `button-position` string, nullable - `button-shadow-strength` string, nullable - `button-text-transform` string, nullable - `color-button-primary` string, nullable - `color-button-secondary` string, nullable - `color-button-secondary-fill` string, nullable - `color-button-primary-fill-disabled` string, nullable - `color-button-secondary-fill-disabled` string, nullable - `color-error` string, nullable - `color-font` string, nullable - `color-font-button-primary` string, nullable - `color-font-button-secondary` string, nullable - `color-font-small` string, nullable - `color-font-title` string, nullable - `color-icon-header` string, nullable - `color-input-background` string, nullable - `color-input-border` string, nullable - `color-link` string, nullable - `color-modal-background` string, nullable - `color-primary` string, nullable - `color-progress-bar` string, nullable - `color-success` string, nullable - `color-warning` string, nullable - `color-divider` string, nullable - `color-dropdown-background` string, nullable - `color-dropdown-option` string, nullable - `font-family` string, nullable - `font-family-title` string, nullable - `font-url` string, nullable - `font-size-body` string, nullable - `font-size-header` string, nullable - `font-size-small` string, nullable - `line-height-body` string, nullable - `line-height-header` string, nullable - `line-height-small` string, nullable - `header-font-weight` string, nullable - `header-margin-bottom` string, nullable - `icon-color-primary` string, nullable - `icon-color-highlight` string, nullable - `icon-color-stroke` string, nullable - `icon-color-background` string, nullable - `icon-color-government-id-type` string, nullable - `icon-style` string, nullable - `input-style` string, nullable - `page-transition` string, nullable - `text-align` string, nullable - `text-decoration-line-link` string, nullable - `us-state-input-method` string, nullable - `vertical-options-style` string, nullable - `government-id-pictograph-position` string, nullable - `id-back-pictograph-height` string, nullable - `id-back-pictograph-url` string, nullable - `id-front-pictograph-height` string, nullable - `id-front-pictograph-url` string, nullable - `passport-front-pictograph-height` string, nullable - `passport-front-pictograph-url` string, nullable - `passport-signature-pictograph-height` string, nullable - `passport-signature-pictograph-url` string, nullable - `government-id-select-pictograph-height` string, nullable - `government-id-select-pictograph-url` string, nullable - `device-handoff-terms-text-position` string, nullable - `selfie-pictograph-url` string, nullable - `selfie-pictograph-height` string, nullable - `selfie-center-pictograph-url` string, nullable - `selfie-center-pictograph-height` string, nullable - `selfie-left-pictograph-url` string, nullable - `selfie-left-pictograph-height` string, nullable - `selfie-right-pictograph-url` string, nullable - `selfie-right-pictograph-height` string, nullable - `document-pictograph-position` string, nullable - `document-pictograph-height` string, nullable - `document-pictograph-url` string, nullable - `camera-support-pictograph-height` string, nullable - `camera-support-pictograph-url` string, nullable - `loading-pictograph-height` string, nullable - `loading-pictograph-url` string, nullable - `navbar-logo-display` string, nullable - `logo-url` string, nullable - `logo` string, nullable - `logo-data` string, nullable - `logo-filename` string, nullable - `relationships` VerificationIncludedObjectsItemsDiscriminatorMappingInquiryTemplateVersionRelationships - `inquiry-template` VerificationIncludedObjectsItemsDiscriminatorMappingInquiryTemplateVersionRelationshipsInquiryTemplate - `data` VerificationIncludedObjectsItemsDiscriminatorMappingInquiryTemplateVersionRelationshipsInquiryTemplateData - `type` 'inquiry-template' - `id` string ## Other responses - `400`: The request was unacceptable, often due to invalid parameters. - `401`: An invalid API key was provided. - `403`: The given API key doesn’t have permissions to perform the request or a quota has been exceeded. - `404`: The requested resource doesn’t exist. - `429`: Your organization’s rate limit has been exceeded. We recommend an exponential backoff on requests. --- [API](https://skmtc.dev/withpersona/apis/withpersona-8.md) - [All operations](https://skmtc.dev/withpersona/apis/withpersona-8/llms.txt) - [OpenAPI document](https://skmtc.dev/withpersona/apis/withpersona-8/revisions/3683a7f9e1fe?raw)