> ## Documentation Index
> Fetch the complete documentation index at: https://docs.notifique.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# Detalhe do log

> Corpo completo (request/response), `correlationId`, `source`, nome e prefixo da API key. Escopo: **logs:read**.



## OpenAPI

````yaml /es/guides/logs/api-reference/openapi-logs.json get /v1/logs/{id}
openapi: 3.0.3
info:
  title: Notifique API — Logs
  description: >-
    API para **consultar logs** das chamadas à API do workspace. Use para
    auditar uso, debugar erros ou analisar quais endpoints e métodos foram
    chamados, com qual status e em que período.


    **Autenticação:** todas as rotas exigem API Key no header `Authorization:
    Bearer sk_live_xxxxx` ou `x-api-key: sk_live_xxxxx`. Escopo: **logs:read**.
  version: 1.0.0
servers:
  - url: https://api.notifique.dev
    description: Produção
security:
  - BearerAuth: []
  - ApiKeyHeader: []
tags:
  - name: Logs
    description: Listagem de logs de API do workspace
paths:
  /v1/logs/{id}:
    get:
      tags:
        - Logs
      summary: Detalhe do log
      description: >-
        Corpo completo (request/response), `correlationId`, `source`, nome e
        prefixo da API key. Escopo: **logs:read**.
      operationId: getV1LogsById
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Log encontrado.
          content:
            application/json:
              example:
                success: true
                data:
                  id: cllog123...
                  endpoint: /v1/whatsapp/messages
                  method: POST
                  status: 403
                  source: api
                  duration: 42
                  correlationId: corr_01H...
                  requestBody:
                    to: '[REDACTED]'
                  responseBody:
                    success: false
                    code: FORBIDDEN
                  apiKey:
                    name: Bot produção
                    prefix: sk_live_abc1
                  createdAt: '2026-08-14T14:30:00.000Z'
              schema:
                $ref: '#/components/schemas/getV1LogsByIdResponse'
        '401':
          description: API Key ausente ou inválida.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                success: false
                error: Bad Request
                code: VALIDATION_ERROR
                message: Campo inválido ou ausente.
        '403':
          description: Escopo logs:read ausente.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                success: false
                error: Bad Request
                code: VALIDATION_ERROR
                message: Campo inválido ou ausente.
        '404':
          description: Log não encontrado.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                success: false
                code: NOT_FOUND
components:
  schemas:
    getV1LogsByIdResponse:
      type: object
      properties:
        success:
          type: boolean
        data:
          type: object
          properties:
            id:
              type: string
            endpoint:
              type: string
            method:
              type: string
            status:
              type: integer
            source:
              type: string
            duration:
              type: integer
            correlationId:
              type: string
            requestBody:
              type: object
              properties:
                to:
                  type: string
            responseBody:
              type: object
              properties:
                success:
                  type: boolean
                code:
                  type: string
            apiKey:
              type: object
              properties:
                name:
                  type: string
                prefix:
                  type: string
            createdAt:
              type: string
      example:
        success: true
        data:
          id: clxx...
          endpoint: string
          method: string
          status: 1
          source: string
          duration: 1
          correlationId: clxx...
          requestBody:
            to: '5511999999999'
          responseBody:
            success: true
            code: string
          apiKey:
            name: Exemplo
            prefix: string
          createdAt: string
    ErrorResponse:
      type: object
      properties:
        success:
          type: boolean
          example: false
        error:
          type: string
        message:
          type: string
        code:
          type: string
      example:
        success: false
        error: string
        message: string
        code: string
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API Key
      description: 'Authorization: Bearer sk_live_xxxxx'
    ApiKeyHeader:
      type: apiKey
      in: header
      name: x-api-key
      description: 'x-api-key: sk_live_xxxxx'

````