---
title: "Returns a guided selling"
method: GET
path: "/guidedselling/{id}"
tags: ["GuidedSelling"]
---

# Returns a guided selling

`GET /guidedselling/{id}`

## Request

- The document declares no server URL.
- Auth: API key in header `TWN-InstanceKey` and API key in header `TWN-Authentication`

## Path parameters

- `id` integer, required

## Response `200`

OK

- union: Base model for a guided selling
  - object: A funnel guided selling
    - `discriminator` 'ApiFunnelGuidedSelling', required
    - `FilterTemplateId` integer, nullable: The filter template used by the funnel.
    - `SortTemplateId` integer, nullable: The sort template used by the funnel.
    - `SelectionGuideId` integer: The guided selling identifier.
    - `Name` string: The guided selling name.
    - `Code` string: The guided selling code.
    - `CategoryId` integer: The category the guided selling applies to.
    - `Type` 'Funnel' | 'Compare'
    - `Attributes` ApiGuidedSellingAttribute[]: The configured attributes.
      - `SelectionGuideAttributeId` integer: The guided selling attribute identifier.
      - `AttributeId` integer: The referenced attribute identifier.
      - `Name` string, nullable: The attribute name.
      - `Type` integer: The attribute type.
      - `RangeStart` integer, nullable: The start of the configured range.
      - `RangeEnd` integer, nullable: The end of the configured range.
      - `Values` string[]: The configured values.
    - `Questions` ApiGuidedSellingQuestion[]: The configured questions.
      - `SelectionGuideQuestionId` integer: The guided selling question identifier.
      - `AttributeId` integer: The referenced attribute identifier.
      - `Name` string, nullable: The attribute name.
      - `Question` string: The question text.
      - `Explanation` string, nullable: The question explanation.
      - `ImageUrl` string, nullable: The question image url.
      - `Multiple` boolean: Indicates whether multiple answers can be selected.
      - `Skippable` boolean: Indicates whether the question can be skipped.
      - `SkipLabel` string, nullable: The label shown to skip the question.
      - `Position` integer: The position of the question.
      - `Answers` ApiGuidedSellingAnswer[]: The configured answers.
        - `SelectionGuideAnswerId` integer: The guided selling answer identifier.
        - `Answer` string: The answer text.
        - `Caption` string, nullable: The answer caption.
        - `Summary` string, nullable: The answer summary.
        - `ImageUrl` string, nullable: The answer image url.
        - `Position` integer: The position of the answer.
        - `Type` integer: The answer type.
        - `RangeStart` integer, nullable: The start of the configured range.
        - `RangeEnd` integer, nullable: The end of the configured range.
        - `NextQuestionId` integer, nullable: The question to continue with when this answer is selected.
        - `Values` string[]: The configured values.
  - object: A compare guided selling
    - `discriminator` 'ApiCompareGuidedSelling', required
    - `SelectionGuideId` integer: The guided selling identifier.
    - `Name` string: The guided selling name.
    - `Code` string: The guided selling code.
    - `CategoryId` integer: The category the guided selling applies to.
    - `Type` 'Funnel' | 'Compare'
    - `Attributes` ApiGuidedSellingAttribute[]: The configured attributes.
      - `SelectionGuideAttributeId` integer: The guided selling attribute identifier.
      - `AttributeId` integer: The referenced attribute identifier.
      - `Name` string, nullable: The attribute name.
      - `Type` integer: The attribute type.
      - `RangeStart` integer, nullable: The start of the configured range.
      - `RangeEnd` integer, nullable: The end of the configured range.
      - `Values` string[]: The configured values.
    - `Questions` ApiGuidedSellingQuestion[]: The configured questions.
      - `SelectionGuideQuestionId` integer: The guided selling question identifier.
      - `AttributeId` integer: The referenced attribute identifier.
      - `Name` string, nullable: The attribute name.
      - `Question` string: The question text.
      - `Explanation` string, nullable: The question explanation.
      - `ImageUrl` string, nullable: The question image url.
      - `Multiple` boolean: Indicates whether multiple answers can be selected.
      - `Skippable` boolean: Indicates whether the question can be skipped.
      - `SkipLabel` string, nullable: The label shown to skip the question.
      - `Position` integer: The position of the question.
      - `Answers` ApiGuidedSellingAnswer[]: The configured answers.
        - `SelectionGuideAnswerId` integer: The guided selling answer identifier.
        - `Answer` string: The answer text.
        - `Caption` string, nullable: The answer caption.
        - `Summary` string, nullable: The answer summary.
        - `ImageUrl` string, nullable: The answer image url.
        - `Position` integer: The position of the answer.
        - `Type` integer: The answer type.
        - `RangeStart` integer, nullable: The start of the configured range.
        - `RangeEnd` integer, nullable: The end of the configured range.
        - `NextQuestionId` integer, nullable: The question to continue with when this answer is selected.
        - `Values` string[]: The configured values.

## Other responses

- `404`: Not Found

---

[API](https://skmtc.dev/tweakwise/apis/app-api.md) - [All operations](https://skmtc.dev/tweakwise/apis/app-api/llms.txt) - [OpenAPI document](https://skmtc.dev/tweakwise/apis/app-api/revisions/dc936bf76941?raw)