---
title: "List active price list options"
method: GET
path: "/companies/{company}/price-lists/options"
tags: ["Price Lists"]
---

# List active price list options

`GET /companies/{company}/price-lists/options`

## Request

- Base URL: `https://api.factuarea.com/v1`
- URL: `https://api.factuarea.com/v1/companies/{company}/price-lists/options`
- Auth: one of:
  - HTTP bearer
  - API key in header `X-API-Key`

Return a compact list of active price lists suitable for selectors.

## Path parameters

- `company` string, uuid, required

## Query parameters

- `search` string
- `limit` integer

## Headers

- `Factuarea-Version` string, date

## Response `200`

- object
  - `data` PriceList[], required
    - `id` string, uuid, required
    - `object` 'price_list', required
    - `name` string, required
    - `status` 'active' | 'inactive', required
    - `currency` string, required
    - `item_count` integer, required
    - `assigned_client_count` integer, required
    - `assigned_draft_count` integer, required
    - `items` PriceListItem[], required
      - `id` string, uuid, required
      - `object` 'price_list_item', required
      - `price_list_id` string, uuid, required
      - `product_id` string, uuid, required
      - `variant_id` string, uuid, nullable, required
      - `presentation_id` string, uuid, nullable, required
      - `configuration_id` string, uuid, nullable, required: The stored commercial combination the entry is priced for. `null` when the entry targets the legacy product/variant/presentation crossing or a selection signature: the three ways of naming a target are mutually exclusive. On a withdrawn entry it is read from the frozen snapshot, never from the live catalog.
      - `selection_signature` string, nullable, required: Canonical 64-hex signature of the normalized selection the entry is priced for, when it targets the selection itself instead of a stored combination. `null` otherwise. On a withdrawn entry it is read from the frozen snapshot, never from the live catalog.
      - `product_name` string, required
      - `variant_name` string, nullable, required
      - `presentation_name` string, nullable, required
      - `unit_price` string, required
      - `currency` string, required
      - `price_unit` string, required
      - `status` 'active' | 'retired', required: Lifecycle of the entry. `retired` means a confirmed catalog deletion withdrew it: it keeps its price as history, is excluded from price resolution, client assignment and every statistic, and is never reactivated.
      - `retirement_reason` 'product_deleted' | 'variant_deleted' | 'presentation_deleted' | 'configuration_deleted' | 'option_group_deleted' | 'option_value_deleted' | 'legacy_orphan' | 'product_replaced' | 'null', nullable, required: Why the entry was withdrawn. `product_replaced` means the product was replaced by another one with a different base unit (`POST /v1/companies/{company}/products/{product}/base-unit-replacement`): the entry keeps its price as history and, when it was transferred, a new entry for the new product carries the converted price. `null` while the entry is active.
      - `retirement_reason_label` string, nullable, required: Human-readable label of `retirement_reason`, in Spanish. `null` while the entry is active.
      - `retired_at` string, date-time, nullable, required
      - `retired_target_snapshot` RetiredPriceListTarget, required: Frozen description of the catalog target a withdrawn price entry pointed at.
        - `product_id` string, uuid, required
        - `product_name` string, required
        - `variant_id` string, uuid, nullable, required
        - `variant_name` string, nullable, required
        - `presentation_id` string, uuid, nullable, required
        - `presentation_name` string, nullable, required
        - `configuration_id` string, uuid, nullable, required
        - `configuration_name` string, nullable, required
        - `selection_signature` string, nullable, required: Canonical 64-hex signature when the entry targeted a normalized selection instead of a stored combination.
        - `options` object[], required
          - `group_id` string, uuid, nullable, required
          - `group_name` string, nullable, required
          - `value_id` string, uuid, required
          - `value_name` string, required
      - `created_at` string, date-time, required
      - `updated_at` string, date-time, required
    - `created_at` string, date-time, required
    - `updated_at` string, date-time, required

## Other responses

- `400`: `parameter_unknown` with `subcode` `retired_active_profile_header`: the retired `X-Active-Profile` header was sent; the company goes in the path. `parameter_invalid_format` on `Factuarea-Version`: the header is not a `YYYY-MM-DD` date. `unsupported_api_version`: the `Factuarea-Version` date is not a supported version.
- `401`: Missing or invalid API key.
- `403`: The request is authenticated but not allowed: the API key lacks the required scope (`insufficient_scope`), the plan does not include the public API or this feature (`addon_not_active`, `feature_not_available_in_plan`), or the module is not available with a test key (`module_not_available_in_sandbox`).
- `404`: The requested resource does not exist or belongs to another company. `profile_not_found`: the company in the path does not exist, is not in the API key scope or belongs to the other environment (live or test).
- `422`: Validation failed. The `error.param` field identifies which input is invalid.
- `429`: Rate limit exceeded. Retry after the duration in `Retry-After`.
- `500`: Unexpected server error.

---

[API](https://skmtc.dev/factuarea/apis/factuarea-public-api.md) · [All operations](https://skmtc.dev/factuarea/apis/factuarea-public-api/llms.txt) · [OpenAPI document](https://skmtc.dev/factuarea/apis/factuarea-public-api/revisions/718e77934422?raw)