---
title: "Get Config Choice by Category"
method: GET
path: "/v3/config-choice/{category}/option-items"
tags: ["Config Choice"]
---

# Get Config Choice by Category

`GET /v3/config-choice/{category}/option-items`

## Request

- Base URL: `https://api.avionte.com/bo-prod`
- URL: `https://api.avionte.com/bo-prod/v3/config-choice/{category}/option-items`
- Auth: one of:
  - API key in header `x-api-key`
  - HTTP bearer

Returns a predefined list of custom setup options from the ConfigChoice table in Back Office.

## Path parameters

- `category` string, required

## Query parameters

- `branchGuid` string, uuid
- `branchExternalId` string

## Headers

- `FrontOfficeTenantId` integer, required
- `RequestId` string, uuid, required: The unique request identifier used to correlate request data with log entries and events, formatted as a UUID.
- `RequestOrigin` string, required
- `ExternalIdSource` 'BOLD', required
- `RequestUserExternalId` string

## Response `200`

Successfully retrieved custom setup options by category.

- CustomSetupOption[]
  - `optionId` integer, nullable: The unique identifier for the setup option.
  - `optionName` string: The display name of the setup option.
  - `categoryId` integer, nullable: The unique identifier for the category associated with the option.
  - `categoryName` string: The display name of the option category.
  - `branchGuid` string, uuid: The unique identifier for the Branch associated with the option.
  - `isVisible` boolean: An indication of whether this custom setup option is visible to the current branch.
  - `customSetupOptionProperties` CustomSetupOptionProperty[]
    - `propertyName` string: The name of the option property.
    - `propertyDescription` string: The description of the option property.
    - `defaultValue` string: The default value of the property.
    - `propertyValue` string: The current value of the option property.

## Other responses

- `400`: Bad Request
- `402`: Additional subscription required.
- `403`: Access Denied
- `404`: Not found
- `405`: Unsupported method
- `415`: Unsupported format(s) indicated by the Content-Type header
- `429`: Too many requests
- `500`: An unexpected error occurred
- `502`: Service Unavailable
- `504`: Gateway Timeout

---

[API](https://skmtc.dev/avionte/apis/avionte-back-office-v3-api.md) - [All operations](https://skmtc.dev/avionte/apis/avionte-back-office-v3-api/llms.txt) - [OpenAPI document](https://skmtc.dev/avionte/apis/avionte-back-office-v3-api/revisions/13269bc541c9?raw)