> ## Documentation Index > Fetch the complete documentation index at: https://docs.westhetics.io/llms.txt > Use this file to discover all available pages before exploring further. # Listar eventos > Os eventos dos últimos 30 dias que o app vê, em ordem (`asc`, padrão, para consumir) ou dos mais recentes (`desc`). A alternativa ao webhook para quem prefere consultar. Em `asc`, o evento aparece quando nenhuma gravação mais antiga ainda está em andamento: o cursor nunca pula evento, e um evento pode levar alguns segundos a mais para aparecer. Entrega pelo menos uma vez: ignore o `id` repetido. `webhook.test` nunca aparece aqui. **Escopo:** qualquer app; pelo OAuth, o perfil da pessoa. ## OpenAPI ````yaml /api-reference/openapi.json get /v1/events openapi: 3.1.0 info: title: API da Westhetics version: 1.0.0 description: >- A API pública da Westhetics: pacientes, anamneses, contratos e assinaturas da clínica, com eventos por webhook. Autentique com a chave do app (`Authorization: Bearer wx_…`), criada pela gestora em Integrações, ou com o token OAuth da pessoa. Respostas em JSON, mensagens em pt-BR. Guias em https://docs.westhetics.io. contact: name: Westhetics url: https://docs.westhetics.io email: suporte@westhetics.com.br servers: - url: https://api.westhetics.io description: Produção security: - apiKey: [] - oauth2: [] tags: - name: Conta description: Quem chama e a clínica. - name: Pacientes description: O cadastro da paciente. - name: Anamneses description: Enviar, acompanhar e ler a anamnese. - name: Catálogo description: Procedimentos, prestadores e modelos. - name: Contratos e assinaturas description: Gerar o contrato e os termos e enviar para assinatura. - name: Eventos description: O que aconteceu na clínica, por consulta ou por webhook. - name: Webhooks description: Os endereços que recebem os eventos do app. paths: /v1/events: get: tags: - Eventos summary: Listar eventos description: >- Os eventos dos últimos 30 dias que o app vê, em ordem (`asc`, padrão, para consumir) ou dos mais recentes (`desc`). A alternativa ao webhook para quem prefere consultar. Em `asc`, o evento aparece quando nenhuma gravação mais antiga ainda está em andamento: o cursor nunca pula evento, e um evento pode levar alguns segundos a mais para aparecer. Entrega pelo menos uma vez: ignore o `id` repetido. `webhook.test` nunca aparece aqui. **Escopo:** qualquer app; pelo OAuth, o perfil da pessoa. operationId: listEvents parameters: - name: limit in: query required: false schema: default: 25 description: Itens por página, de 1 a 100. type: integer minimum: 1 maximum: 100 description: Itens por página, de 1 a 100. - name: cursor in: query required: false schema: type: string minLength: 1 maxLength: 400 description: O `nextCursor` da página anterior. description: O `nextCursor` da página anterior. - name: types in: query required: false schema: type: string - name: patientId in: query required: false schema: type: string format: uuid pattern: >- ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$ - name: resourceId in: query required: false schema: type: string format: uuid pattern: >- ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$ - name: order in: query required: false schema: default: asc type: string enum: - asc - desc responses: '200': description: Sucesso. content: application/json: schema: type: object properties: data: type: array items: $ref: '#/components/schemas/Event' meta: $ref: '#/components/schemas/PageMeta' required: - data - meta example: data: - id: 0e9d8c7b-6a5f-4e3d-9c2b-1a0f9e8d7c6b type: signature_request.completed createdAt: '2026-10-15T14:30:00Z' clinicId: 2b7f0a3c-5d1e-4c8a-9f60-1a2b3c4d5e6f actor: type: system id: null data: signatureRequestId: 6f7e8d9c-0b1a-4f2e-9d3c-4b5a69788796 appointmentId: 3c9d1e2f-4a5b-4c7d-8e9f-0a1b2c3d4e5f patientId: f47ac10b-58cc-4372-a567-0e02b2c3d479 protocolNumber: WX-4472-BM documentIds: - d4e5f6a7-b8c9-4123-8ef4-567890123456 meta: limit: 25 nextCursor: null '400': description: O corpo não é JSON, ou falta o que a rota precisa. content: application/json: schema: $ref: '#/components/schemas/Error' '401': description: Sem chave, chave que não confere, revogada ou token vencido. content: application/json: schema: $ref: '#/components/schemas/Error' '403': description: O app não tem o escopo, ou a pessoa não pode pelo perfil. content: application/json: schema: $ref: '#/components/schemas/Error' '422': description: Dado que não passa na regra; `fields` traz a mensagem de cada campo. content: application/json: schema: $ref: '#/components/schemas/Error' '429': description: Passou de 100 chamadas por minuto; veja `Retry-After`. content: application/json: schema: $ref: '#/components/schemas/Error' components: schemas: Event: type: object properties: id: type: string description: O id do evento; é o `webhook-id` da entrega. type: type: string enum: - webhook.test - patient.created - patient.updated - patient.archived - patient.restored - patient.merged - anamnesis.sent - anamnesis.resent - anamnesis.completed - anamnesis.canceled - appointment.documents_generated - appointment.canceled - signature_request.sent - signature_request.resent - signature_request.viewed - signature_request.signed - signature_request.completed - signature_request.declined - signature_request.expired - signature_request.canceled - signature_request.delivery_failed description: >- `webhook.test` só chega no webhook, pelo "Enviar teste"; nunca aparece em `GET /v1/events`. createdAt: type: string description: Data e hora ISO 8601, em UTC. clinicId: type: string actor: type: object properties: type: type: string enum: - user - integration - patient - provider - system id: anyOf: - type: string - type: 'null' required: - type - id additionalProperties: false data: type: object propertyNames: type: string additionalProperties: {} description: Os ids do recurso e o essencial; o resto se lê pela API. required: - id - type - createdAt - clinicId - actor - data additionalProperties: false description: Um evento da clínica (RN-INT-15). PageMeta: type: object properties: limit: type: integer minimum: -9007199254740991 maximum: 9007199254740991 nextCursor: anyOf: - type: string - type: 'null' description: Passe em `cursor` para a próxima página; nulo no fim. required: - limit - nextCursor additionalProperties: false description: A página de uma lista por cursor. Error: type: object properties: error: type: object properties: code: type: string enum: - bad_request - unauthenticated - forbidden - not_found - conflict - validation_failed - rate_limited - unavailable - internal_error message: type: string description: A causa e o caminho, em pt-BR. fields: description: 'No 422: a mensagem de cada campo.' type: object propertyNames: type: string additionalProperties: type: string requestId: type: string required: - code - message - requestId additionalProperties: false required: - error additionalProperties: false description: O envelope de erro. securitySchemes: apiKey: type: http scheme: bearer bearerFormat: wx_<64 hex> description: >- A chave do app de integração, criada em Integrações. Escopos: `patients:read` (Listar, buscar e ler pacientes; os eventos patient.*.); `patients:write` (Criar e editar pacientes. Inclui ler.); `anamneses:read` (Listar e ler anamneses, sem as respostas; os eventos anamnesis.*.); `anamneses:write` (Enviar, reenviar e cancelar anamnese. Inclui ler.); `anamneses:answers` (Ler as respostas da anamnese preenchida. É dado de saúde.); `documents:read` (Atendimentos, documentos, status da assinatura e o PDF; os eventos appointment.* e signature_request.*.); `documents:write` (Gerar contrato e termos e enviar para assinatura, reenviar e cancelar. Inclui ler.); `catalog:read` (Procedimentos, prestadores e modelos de documento da clínica.); `webhooks:write` (Criar, alterar e remover os webhooks do próprio app pela API.) oauth2: type: oauth2 description: >- Token OAuth 2.1 da pessoa (código com PKCE), emitido a um aplicativo conectado. Vale o perfil da pessoa na clínica da conexão, por 12 horas. flows: authorizationCode: authorizationUrl: https://zosqwpksgewzphikvgfz.supabase.co/auth/v1/oauth/authorize tokenUrl: https://zosqwpksgewzphikvgfz.supabase.co/auth/v1/oauth/token refreshUrl: https://zosqwpksgewzphikvgfz.supabase.co/auth/v1/oauth/token scopes: openid: Identidade. email: O e-mail. profile: O nome. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.