> ## Documentation Index > Fetch the complete documentation index at: https://docs.cardapioweb.com/llms.txt > Use this file to discover all available pages before exploring further. # Listar opções > Retorna a lista paginada de opções do estabelecimento. ## OpenAPI ````yaml /reference/api-catalogo.json get /api/partner/v1/catalog/options openapi: 3.1.0 info: title: API Catálogo version: '1.0' description: >- A API de catálogo é responsável por fornecer e gerenciar o catálogo completo do estabelecimento incluindo categorias, itens, grupos de complementos e opções. ## Autenticação Todas as requisições devem incluir obrigatoriamente os seguintes headers: - `X-API-KEY`: token do estabelecimento - `X-PARTNER-KEY`: token da integradora A ausência de qualquer um desses headers resultará na rejeição da requisição. ## Rate Limits Para o endpoint `GET /api/partner/v1/catalog`, o limite é de **5 requisições por minuto**. Para os demais endpoints do módulo de Catálogo, o limite é de **100 requisições por minuto**. contact: email: integracao@cardapioweb.com url: https://cardapioweb.com name: Cardápio Web servers: - url: https://integracao.sandbox.cardapioweb.com description: Sandbox - description: Produção url: https://integracao.cardapioweb.com security: - partnerKey: [] apiKey: [] tags: - name: Catálogo Completo description: Consulta do catálogo completo do estabelecimento. - name: Categorias description: Gerenciamento de categorias do cardápio. - name: Itens description: Gerenciamento de itens (produtos) do cardápio. - name: Grupos de Complementos description: Gerenciamento de grupos de complementos (option groups) do cardápio. - name: Opções description: Gerenciamento de opções (subitens/complementos individuais) do cardápio. - name: Imagens description: Upload e remoção de imagens de categorias, itens e opções. paths: /api/partner/v1/catalog/options: get: tags: - Opções summary: Listar opções description: Retorna a lista paginada de opções do estabelecimento. operationId: listOptions parameters: - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PerPage' responses: '200': description: Lista de opções retornada com sucesso. content: application/json: schema: type: object properties: options: type: array items: $ref: '#/components/schemas/Option' meta: $ref: '#/components/schemas/PaginationMeta' example: options: - id: 2883 name: Pequena description: null external_code: null status: ACTIVE image: null cost_price: null active_stock_control: false stock: 0 meta: page: 1 per_page: 30 total: 1 total_pages: 1 '401': $ref: '#/components/responses/Unauthorized' '429': $ref: '#/components/responses/TooManyRequests' components: parameters: Page: name: page in: query schema: type: integer minimum: 1 default: 1 description: Número da página. PerPage: name: per_page in: query required: false schema: type: integer minimum: 1 maximum: 100 description: Quantidade de itens por página. schemas: Option: type: object title: Opção description: Opção que pode ser associada a múltiplos grupos de complementos. properties: id: type: integer description: Identificador único da opção. name: type: string description: Nome da opção. description: type: - 'null' - string description: Descrição da opção. external_code: type: - 'null' - string description: Código externo da opção. status: type: string enum: - ACTIVE - INACTIVE - MISSING description: |- Status da opção. - `ACTIVE`: opção ativa e visível. - `INACTIVE`: opção oculta. - `MISSING`: opção em falta. image: $ref: '#/components/schemas/Image' description: Imagem da opção. cost_price: type: - number - 'null' description: Preço de custo da opção. minimum: 0 active_stock_control: type: boolean description: Indica se o controle de estoque está ativo. stock: type: - number - 'null' description: Quantidade disponível em estoque. PaginationMeta: title: PaginationMeta type: object description: Metadados de paginação. properties: page: type: integer description: Página atual. per_page: type: integer description: Quantidade de itens por página. total: type: integer description: Quantidade total de registros. total_pages: type: integer description: Quantidade total de páginas. Image: title: Image type: - object - 'null' description: Imagem associada a um recurso (categoria, item ou opção). properties: image_url: type: string format: uri description: URL da imagem versão padrão. thumbnail_url: type: string format: uri description: URL da imagem versão reduzida (thumbnail). Unauthorized: type: object title: Unauthorized description: >- Resposta de erro de autenticação. Retornado quando os headers `X-API-KEY` ou `X-PARTNER-KEY` estão ausentes ou são inválidos. examples: - code: 4010 message: Token inválido. properties: code: type: integer description: Código interno de identificação do erro. message: type: string description: Mensagem de resumo do erro. required: - code - message responses: Unauthorized: description: >- Não autorizado. O token no header `X-API-KEY` não foi enviado ou é inválido. content: application/json: schema: $ref: '#/components/schemas/Unauthorized' example: code: 4010 message: Token inválido. TooManyRequests: description: >- Muitas requisições foram feitas em um curto período. Verifique as regras de rate limit na descrição da API. content: {} securitySchemes: partnerKey: name: X-PARTNER-KEY type: apiKey in: header description: >- Token de autenticação da integradora. Para ter esse token, a integradora precisa estar previamente cadastrada em nosso sistema. Deve ser enviado no header `X-PARTNER-KEY`. apiKey: name: X-API-KEY type: apiKey in: header description: Token de autenticação da API. Deve ser enviado no header `X-API-KEY`. ````