1. Customers
Way API
  • Raiz
    • Customers
      • Criar conta de cliente
        POST
      • Ver meus dados
        GET
      • Atualizar meus dados
        PATCH
    • Instances
      • Listar instâncias
      • Criar instância
      • Atualizar nome da instância
      • Remover instância
      • Listar chats da instância
      • Conectar instância
      • Desconectar instância
      • Consultar detalhes de grupo
      • Consultar status da instância
    • Messages
      • Enviar mensagem com imagem
      • Enviar mensagem com preview de link
      • Listar mensagens pendentes da fila de envio
      • Limpar mensagens pendentes da fila de envio
      • Enviar mensagem de texto
    • Webhooks
      • Criar ou atualizar webhook
      • Desativar webhook
  • Esquemas
    • AcceptedMessageResponse
    • AudioMessageReceivedContent
    • AudioMessageReceivedWebhookPayload
    • Chat
    • ClearPendingMessagesResponse
    • ConnectInstanceRequest
    • ConnectInstanceResponse
    • ContactMessageReceivedContent
    • ContactMessageReceivedItem
    • ContactMessageReceivedWebhookPayload
    • CreateCustomerRequest
    • CreateCustomerResponse
    • CreateInstanceRequest
    • CreateInstanceResponse
    • CustomerOutput
    • DeleteInstanceResponse
    • DisconnectInstanceResponse
    • DocumentMessageReceivedContent
    • DocumentMessageReceivedWebhookPayload
    • ErrorResponse
    • GetGroupDetailsResponse
    • GetInstanceStatusResponse
    • GifMessageReceivedContent
    • GifMessageReceivedWebhookPayload
    • GroupDetails
    • GroupParticipantUpdateItem
    • GroupParticipantsUpdateMessageReceivedContent
    • GroupParticipantsUpdateMessageReceivedWebhookPayload
    • ImageMessageReceivedContent
    • ImageMessageReceivedWebhookPayload
    • InboundWebhookPayload
    • InboundWebhookPayloadBase
    • IncomingMediaPayload
    • InstanceOutput
    • InstanceWebhookOutput
    • InviteLink
    • JsonContentTypeHeader
    • ListChatsResponse
    • ListInstancesResponse
    • ListPendingMessagesResponse
    • LocationMessageReceivedContent
    • LocationMessageReceivedWebhookPayload
    • MessageFailedWebhookError
    • MessageFailedWebhookPayload
    • MessageReceiptDetails
    • MessageReceiptUpdateMessageReceivedContent
    • MessageReceiptUpdateMessageReceivedWebhookPayload
    • MessageSentWebhookPayload
    • PendingMessageOutput
    • PinMessageInChatMessageReceivedContent
    • PinMessageInChatMessageReceivedWebhookPayload
    • PinMessageReferencedMessage
    • PtvMessageReceivedContent
    • PtvMessageReceivedWebhookPayload
    • ReactionMessageReceivedContent
    • ReactionMessageReceivedWebhookPayload
    • ReactionReferencedMessage
    • ReceiptReferencedMessage
    • SendImageRequest
    • SendLinkRequest
    • SendTextRequest
    • StickerMessageReceivedContent
    • StickerMessageReceivedWebhookPayload
    • TextMessageReceivedContent
    • TextMessageReceivedWebhookPayload
    • UnknownMessageReceivedContent
    • UnknownMessageReceivedWebhookPayload
    • UpdateCustomerRequest
    • UpdateInstanceNameRequest
    • UpdateInstanceNameResponse
    • UpsertWebhookRequest
    • VideoMessageReceivedContent
    • VideoMessageReceivedWebhookPayload
    • WebhookOutput
    • WebhookPayload
  1. Customers

Ver meus dados

Amb. de Desenv.
http://localhost:3000
Amb. de Desenv.
http://localhost:3000
GET
/customers/me
Retorna os dados do cliente autenticado com x-api-key.
Use esta rota para validar sua chave e obter o perfil atual do cliente.

Requisição

Authorization
Adicionar parâmetro em header
x-api-key
Exemplo:
x-api-key: ********************
Parâmetros Header

Respostas

🟢200OK
application/json
Dados do cliente autenticado (GET/PATCH /customers/me). Não expõe apiKey nem passwordHash.
Bodyapplication/json

🟠401Não Autorizado
🟠403Proibido
🟠404Registo Não Encontrado
Request Request Example
Shell
JavaScript
Java
Swift
curl --location 'http://localhost:3000/customers/me' \
--header 'x-api-key: <api-key>'
Response Response Example
200 - Cliente autenticado
{
    "customerId": "018f47ac-7a5b-7cc2-9f9a-9b8d7f6e5d4c",
    "name": "Maria Silva",
    "email": "maria@empresa.com"
}
Modificado em 2026-06-12 15:08:32
Página anterior
Criar conta de cliente
Próxima página
Atualizar meus dados
Built with