> ## Documentation Index > Fetch the complete documentation index at: https://docs.wegly.com.br/llms.txt > Use this file to discover all available pages before exploring further. # Consulta de critério de lead score > Retorna um critério de lead score da empresa da chave, com categoria e opções não removidas. ## OpenAPI ````yaml /openapi.json get /integrations/external/lead-scores/criteria/{id} openapi: 3.0.3 info: title: >- Integração Externa - Leads, Oportunidades, Lead Score, Tarefas, Arquivos, Propostas, Chats, Satisfação e Campos Personalizados version: 1.0.0 description: > Documentação oficial da API externa da Wegly para campos personalizados, leads, oportunidades, critérios de lead score, tarefas, arquivos, propostas, chats e satisfação (`/integrations/external/custom-fields`, `/integrations/external/files`, `/integrations/external/leads`, `/integrations/external/deals`, `/integrations/external/lead-scores`, `/integrations/external/tasks`, `/integrations/external/proposals`, `/integrations/external/chats` e `/integrations/external/satisfaction`). Todas as descrições estão em português e refletem as regras aplicadas pelo serviço. servers: - url: https://api.wegly.com.br description: Ambiente de produção Wegly security: - bearerAuth: [] tags: - name: Campos Personalizados description: >- Consulta dos campos personalizados disponíveis para uso nas integrações externas. - name: Arquivos description: >- Upload e consulta de arquivos vinculados diretamente a leads ou oportunidades. Arquivos de proposta usam as rotas de anexos em Propostas. - name: Leads description: >- Operações de listagem, criação, consulta e atualização de leads via integração externa. - name: Oportunidades description: Operações de criação de oportunidades (deals) via integração externa. - name: Lead Score description: >- Listagem, consulta, criação e atualização de critérios de lead score via integração externa. Não há exclusão pela API pública. - name: Tarefas description: >- Operações de listagem, criação, consulta, atualização e remoção de tarefas vinculadas a leads, oportunidades, entregas, pessoas, organizações ou clientes. - name: Satisfação description: >- Geração de links públicos para formulários de satisfação via integração externa. - name: Propostas description: >- Operações de listagem, criação, consulta, atualização e remoção de propostas via integração externa, incluindo seus anexos (arquivos e documentos da biblioteca). - name: Chats description: >- Operações principais de listagem, criação, consulta e resumo de não lidas de chats via integração externa. paths: /integrations/external/lead-scores/criteria/{id}: get: tags: - Lead Score summary: Consulta de critério de lead score description: > Retorna um critério de lead score da empresa da chave, com categoria e opções não removidas. parameters: - $ref: '#/components/parameters/ScoreCriterionId' responses: '200': description: Critério encontrado. content: application/json: schema: $ref: '#/components/schemas/ExternalScoreCriterion' example: id: 7e8f9a0b-1c2d-4e3f-9a4b-5c6d7e8f9a0b category_id: null category: null target_type: LEAD name: Pediu proposta description: null points: 15 status: 1 options: [] created_at: '2026-11-10T09:30:00.000Z' updated_at: '2026-11-10T09:30:00.000Z' '401': description: >- Chave de integração ausente, inválida, inativa ou expirada, ou domínio de origem não autorizado para a chave. '403': description: >- Permissão `crm/lead-score.read` ausente na chave ou usuário criador da chave inativo. '404': description: Critério inexistente, removido ou de outra empresa. '429': description: Limite de requisições atingido. headers: Retry-After: description: Tempo de espera em segundos, quando enviado. schema: type: integer content: application/json: schema: $ref: '#/components/schemas/ExternalApiError' components: parameters: ScoreCriterionId: name: id in: path required: true description: UUID do critério de lead score. schema: type: string format: uuid schemas: ExternalScoreCriterion: type: object required: - id - category_id - category - target_type - name - description - points - status - options - created_at - updated_at properties: id: type: string format: uuid category_id: type: string format: uuid nullable: true category: allOf: - $ref: '#/components/schemas/ExternalScoreCriterionCategory' nullable: true target_type: $ref: '#/components/schemas/ScoreTargetType' name: type: string maxLength: 120 description: type: string nullable: true points: type: integer minimum: -100 maximum: 100 description: Pontos do critério; valem quando ele não tem opções ativas. status: $ref: '#/components/schemas/ScoreStatus' options: type: array description: >- Opções não removidas (ativas e inativas), ordenadas por `position`. Vazio quando não há. items: $ref: '#/components/schemas/ExternalScoreCriterionOption' created_at: type: string format: date-time updated_at: type: string format: date-time ExternalApiError: type: object properties: statusCode: type: integer message: oneOf: - type: string - type: array items: type: string error: type: string description: >- Formato de erro do HTTP/NestJS; os campos presentes variam conforme a exceção. ExternalScoreCriterionCategory: type: object required: - id - name - color - status properties: id: type: string format: uuid name: type: string color: type: object nullable: true description: >- Cor da categoria, no formato das tags. `null` quando não há cor gravada. required: - background - foreground properties: background: type: string example: '#1E88E5' foreground: type: string example: '#FFFFFF' status: $ref: '#/components/schemas/ScoreStatus' ScoreTargetType: type: string enum: - LEAD - DEAL - BOTH description: >- Tipo de registro do critério: `LEAD` (leads), `DEAL` (oportunidades) ou `BOTH` (os dois). ScoreStatus: type: integer enum: - 0 - 1 description: 'Situação do critério ou da opção: 0 = inativo, 1 = ativo.' ExternalScoreCriterionOption: type: object required: - id - label - description - points - position - status properties: id: type: string format: uuid label: type: string maxLength: 120 description: type: string nullable: true points: type: integer minimum: -100 maximum: 100 description: Pontos aplicados quando a opção é escolhida. position: type: integer minimum: 0 status: $ref: '#/components/schemas/ScoreStatus' securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: API key description: >- Chave de integração com prefixo wegly_, enviada em Authorization: Bearer . Não é JWT. A chave deve estar ativa, não excluída e dentro da validade. Com allowed_domain, Origin (ou Referer na ausência de Origin) precisa informar o hostname permitido. A empresa e as permissões são obtidas pela chave. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.