> ## Documentation Index > Fetch the complete documentation index at: https://docs.connectadesk.com/llms.txt > Use this file to discover all available pages before exploring further. # Consultar produto ## OpenAPI ````yaml /api-reference/openapi.yaml get /products/{id} openapi: 3.0.3 info: title: Connecta DESK API pública version: 1.0.0 description: > API pública do Connecta DESK, disponível em `/api/v1`. O acesso é feito com um token gerado no módulo de tokens. Cada token tem permissões por **módulo × método**, e toda leitura de lista é paginada. ## Autenticação ``` Authorization: Bearer sk_live_a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6 ``` O token pertence a uma **empresa**, e não a um usuário. A empresa usada é sempre a do token, então enviar `companyId` no corpo não tem efeito. Token ausente, inválido, revogado ou expirado recebe a mesma resposta `401`. ## Ordem de verificação 1. **token** → `401` 2. **empresa ativa** → `403` 3. **API habilitada no plano** → `403 ERR_API_NOT_ENABLED` (não se aplica a on-premise) 4. **rate limit da empresa** → `429` 5. **permissão do token** → `403 ERR_API_FORBIDDEN_SCOPE` ## Ids de usuário Todo id de usuário na API é o id do usuário **nesta empresa**, o mesmo que `GET /users` devolve. Vale para o que a API responde (`user.id`, `assignedTo.id`, `userCreated.id`) e para o que ela aceita (`userId`, `userIds`, `assignedToUserId` e o `{id}` das rotas de usuário). A mesma pessoa pode trabalhar em várias empresas, com nome e perfil diferentes em cada uma, e tem um id diferente em cada empresa. Um id que não pertence a esta empresa responde `404`, com a mesma mensagem de um id inexistente. ## Paginação Todo `GET` de lista é paginado. O `meta` traz apenas `page`, `perPage` e `hasMore`, sem o total de registros. Para percorrer tudo, avance `page` enquanto `hasMore` for `true`. ## Idempotência Opcional em `POST`/`PUT`, pelo header `Idempotency-Key`. Se você repetir a chamada com a mesma chave e o mesmo corpo, recebe a resposta já gravada (com `Idempotent-Replay: true`). Com a mesma chave e um corpo diferente, a resposta é `409`. servers: - url: https://api.connectadesk.com/api/v1 description: Produção security: - apiToken: [] tags: - name: contacts description: Cadastro de contatos, campos extras e origem de marketing. - name: tickets x-displayName: Conversas description: Abertura, transferência, encerramento e qualificação de conversas. - name: messages description: Envio assíncrono e leitura de mensagens. - name: tags description: Tags e vínculo com atendimentos. - name: queues description: Filas de atendimento e seus atendentes. - name: wrapups description: Tipos de qualificação. - name: users description: Atendentes e administradores. - name: schedules description: Mensagens programadas. - name: quick-messages description: Respostas rápidas. - name: campaigns description: Disparos em massa. - name: crm description: Painéis, etapas, cards e indicadores. - name: channels description: Canais (somente leitura). - name: reports description: Relatórios e dashboards. - name: products description: Catálogo de produtos, categorias e desempenho nas vendas. - name: custom-fields description: >- Campos personalizados de contato e de card, e variáveis globais da empresa. - name: profiles description: Perfis de permissões da empresa (somente leitura). - name: webchat description: >- Webchat nativo pelo seu sistema: abrir sessão de um visitante, enviar e ler mensagens. O token precisa do escopo `webchat` (GET e POST). paths: /products/{id}: parameters: - name: id in: path required: true schema: type: integer get: tags: - products summary: Consultar produto responses: '200': description: OK content: application/json: schema: type: object properties: data: $ref: '#/components/schemas/Product' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' components: schemas: Product: type: object properties: id: type: integer name: type: string description: Nome exibido. example: Camiseta preta M sku: type: string nullable: true description: Código único do produto na empresa. example: CAM-PRETA-M price: type: string nullable: true description: Preço do produto, em texto decimal para não perder precisão. example: '1299.90' description: type: string nullable: true description: Descrição do produto. image: type: string nullable: true description: URL da imagem, quando houver. isActive: type: boolean description: >- Produto ativo. Um produto inativo não aparece na busca e não pode ser vinculado a um card. categoryId: type: integer nullable: true description: Categoria a que o produto pertence. example: 5 category: type: object nullable: true description: Dados da categoria, quando houver. allOf: - $ref: '#/components/schemas/ProductCategory' createdAt: type: string format: date-time updatedAt: type: string format: date-time example: id: 305 name: Monitor 27 polegadas 4K sku: MONITOR-27-POLEGADAS-4K price: '1299.90' description: Painel IPS, 60 Hz, entrada HDMI e DisplayPort. image: https://cdn.exemplo.com/products/305.png isActive: true categoryId: 7 category: id: 7 name: Periféricos color: '#0E7490' createdAt: '2026-03-11T14:20:00.000Z' updatedAt: '2026-03-11T14:20:00.000Z' createdAt: '2026-04-02T11:15:00.000Z' updatedAt: '2026-08-18T10:40:00.000Z' ProductCategory: type: object properties: id: type: integer name: type: string description: Nome exibido. example: Vestuário color: type: string nullable: true description: Cor em hexadecimal, com `#`. example: '#6941C6' createdAt: type: string format: date-time updatedAt: type: string format: date-time example: id: 7 name: Periféricos color: '#0E7490' createdAt: '2026-03-11T14:20:00.000Z' updatedAt: '2026-03-11T14:20:00.000Z' Error: type: object required: - error properties: error: type: object required: - code - message properties: code: type: string description: Código fixo do erro, para você tratar cada caso no seu sistema. example: ERR_API_FORBIDDEN_SCOPE message: type: string details: {} responses: Unauthorized: description: Token ausente, inválido, revogado ou expirado. content: application/json: schema: $ref: '#/components/schemas/Error' example: error: code: ERR_API_UNAUTHORIZED message: Token de API ausente ou inválido. Forbidden: description: Empresa inativa, API não habilitada no plano ou permissão insuficiente. content: application/json: schema: $ref: '#/components/schemas/Error' example: error: code: ERR_API_FORBIDDEN_SCOPE message: >- O token não tem permissão para este método neste módulo. A mensagem real nomeia os dois. NotFound: description: >- O recurso não existe ou pertence a outra empresa. Por segurança, a resposta é a mesma nos dois casos. content: application/json: schema: $ref: '#/components/schemas/Error' example: error: code: ERR_API_NOT_FOUND message: Registro não encontrado. securitySchemes: apiToken: type: http scheme: bearer description: Token da API no formato `sk_live_…`. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.