> ## 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. # Quem está chamando > Devolve o app (com os escopos) ou a pessoa conectada pelo OAuth, e a clínica. Use para testar a chave. **Escopo:** qualquer app; pelo OAuth, o perfil da pessoa. ## OpenAPI ````yaml /api-reference/openapi.json get /v1/me 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/me: get: tags: - Conta summary: Quem está chamando description: >- Devolve o app (com os escopos) ou a pessoa conectada pelo OAuth, e a clínica. Use para testar a chave. **Escopo:** qualquer app; pelo OAuth, o perfil da pessoa. operationId: getMe parameters: [] responses: '200': description: Sucesso. content: application/json: schema: type: object properties: data: $ref: '#/components/schemas/Me' required: - data example: data: type: integration integration: id: 8d3e2f1a-0b9c-4d7e-a6f5-4e3d2c1b0a99 name: CRM da clínica description: Cadastro e funil de vendas scopes: - patients:write - anamneses:write - documents:write - catalog:read - webhooks:write keyPrefix: 1c0a58f5 createdAt: '2026-10-15T14:30:00Z' user: null role: null clinic: id: 2b7f0a3c-5d1e-4c8a-9f60-1a2b3c4d5e6f name: Clínica Aurora legalName: Aurora Estética Ltda. timezone: America/Sao_Paulo '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' '429': description: Passou de 100 chamadas por minuto; veja `Retry-After`. content: application/json: schema: $ref: '#/components/schemas/Error' components: schemas: Me: type: object properties: type: type: string enum: - integration - user description: 'Quem chama: um app de integração (chave) ou uma pessoa (OAuth).' integration: anyOf: - type: object properties: id: type: string name: type: string description: anyOf: - type: string - type: 'null' scopes: type: array items: type: string enum: - patients:read - patients:write - anamneses:read - anamneses:write - anamneses:answers - documents:read - documents:write - catalog:read - webhooks:write keyPrefix: type: string createdAt: type: string description: Data e hora ISO 8601, em UTC. required: - id - name - description - scopes - keyPrefix - createdAt additionalProperties: false - type: 'null' user: anyOf: - type: object properties: id: type: string name: type: string email: type: string required: - id - name - email additionalProperties: false - type: 'null' role: anyOf: - type: string enum: - receptionist - practitioner - manager - root - type: 'null' clinic: anyOf: - $ref: '#/components/schemas/Clinic' - type: 'null' required: - type - integration - user - role - clinic additionalProperties: false description: Quem está chamando e em que clínica. 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. Clinic: type: object properties: id: type: string name: type: string description: O nome fantasia, ou a razão social. legalName: type: string timezone: type: string required: - id - name - legalName - timezone additionalProperties: false description: A clínica do app ou da conexão. 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.