1. Contas
Documentação técnica das API do Messagefy
  • Introdução
  • Começando
  • Guia de Integração
  • Collections Postman
  • OnBoarding
    • OnBoarding para Organizações
  • Me
    • Introdução
    • Sobre
      GET
  • Contas
    • Introdução
    • Criar conta
      POST
    • Listar contas
      GET
    • Buscar por id
      GET
    • Atualizar conta
      PUT
    • Deletar conta
      DELETE
  • API Key
    • Introdução
    • Criar apikey
      POST
    • Listar ApiKeys
      GET
    • Buscar por ID
      GET
    • Atualizar apikey
      PUT
    • Deletar apiKey
      DELETE
  • Administrando Canais
    • Introdução
    • WebHook
      • Criar canal de Webhook
    • Whatsapp
      • Criar canal de Whatsapp
      • Status do Canal Whatsapp
      • Solicitar QRCode
      • Solicitar Pair Code
      • Solicitar Desconectar o número
    • Outbox
      • Listar Mensagens no Outbox do Canal
      • Obter detalhes da Mensagem no Outbox do Canal
      • Reenviar Múltiplas Mensagens no Outbox do Canal
      • Cancelar Mensagem no Outbox do Canal
    • Listar canais
      GET
    • Buscar por id
      GET
    • Atualizar canal
      PUT
    • Deletar canal
      DELETE
    • Transferir canal
      POST
  • Usando o Canal Whatsapp
    • Introdução
    • Contatos e Grupos
      • Solicitar contatos
      • Solicitar informações do contato
      • Solicitar grupos
      • Solicitar presença de contato (online/offline)
      • Solicitar Chats
      • Solicitar informação do grupo
    • Enviando Mensagens
      • Texto, imagem, audio, video, documentos e sticker
      • Enviar contatos
      • Enviar lista de contato
      • Marcar mensagens como lida
    • Excluindo e Editando Mensagens
      • Apagar mensagem para todos
      • Editar mensagem
    • Recuperar Messagens Antigas
  • Recebendo WebHooks
    • Guia Completo de WebHooks
    • Mensagens Recebidas
      • TEXT
      • CONTACT_MESSAGE
      • CONTACTS_MESSAGE
    • Status do canal
    • QRCode gerado retorno
    • Lista de contatos
    • Lista de grupos
    • Mensagem entregue
    • Mensagem lida
    • Download Disponivel
    • Localização e Localização em tempo real
    • Lista de Histórico
    • Ligação recebida e realizada
    • Lista de contatos do grupo
    • Lista de chats
    • Alteração de Grupo
  • Raiz
  • Esquemas
    • Eventos de WebHook
      • Eventos de Conexão
        • PAIR_CODE_GENERATED_RESPONSE: PairCode de conexão
        • INSTANCE_USER_CONNECT_TIMEOUT: Usuário não realizou Login
        • DISCONNECTED: Celular desconectado
        • CONNECTED: Celular conectado
      • Eventos de Mensagens
        • EchoMessage: Eco de Mensagem enviada
      • Eventos de Status de Mensagens
        • MESSAGE_SENT: Mensagem enviada
        • MESSAGE_DELIVERED: Mensagem entregue
        • MESSAGE_READ: Mensagem lida
    • ContatoWhatsapp
    • ContactResponseInfo
    • AccountResponse
    • Organization
    • ResourcePlanResponse
    • ChannelType
    • ChannelStatus
    • Provider
  1. Contas

Listar contas

dev
https://api-dev.messagefy.io
dev
https://api-dev.messagefy.io
GET
/api/v1/admin/account

📄 Paginação da Listagem#

A listagem de dados é paginada para evitar o carregamento de muitos registros de uma só vez e melhorar a performance da API.

🔢 Regras de Paginação#

Por padrão, cada página retorna 10 itens
O parâmetro perPage define a quantidade de itens por página
O valor máximo permitido para perPage é 50 itens
⚠️ Se um valor maior que 50 for informado, o sistema irá limitar automaticamente para 50 itens.

🔧 Parâmetros da Requisição#

ParâmetroTipoObrigatórioDescrição
pagenumberNãoNúmero da página que deseja consultar
perPagenumberNãoQuantidade de itens por página (máx: 50)
namestringNãoFiltro opcional por nome (busca parcial, case-insensitive)
🔎 O parâmetro name realiza uma busca (parcial, case-insensitive) no backend, não diferencia letras maiúsculas de minúsculas.

📌 Exemplo de Requisição#

Requisição

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

Respostas

🟢200Sucesso
application/json
Body

🔴500Erro Interno
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://api-dev.messagefy.io/api/v1/admin/account' \
--header 'api-key: <api-key>' \
--header 'Content-Type: application/json'
Response Response Example
200 - Sucesso
[
  {
    "accountId": "019ada14-fcdc-72a0-93ee-10f1e3258797",
    "name": "Messagefy",
    "description": "Conta principal do Messagefy",
    "createdAt": "2026-01-01T00:00:00",
    "status": {
      "accountStatusId": 2,
      "name": "Ativo",
      "icon": null,
      "description": "Pronto para uso",
      "canManageChildObjects": false,
      "canSendAndReceiveMessage": false
    },
    "organization": {
      "organizationId": "019ada14-fc9f-712e-a6fc-94b5e313a5df",
      "name": "Messagefy",
      "description": "Organização do Messagefy",
      "status": null
    }
  },
  {
    "accountId": "019ada14-fd67-7df3-a9f5-bf764f2f1d89",
    "name": "MessageFy",
    "description": "Conta principal do Messagefy",
    "createdAt": "2026-01-01T00:00:00",
    "status": {
      "accountStatusId": 2,
      "name": "Ativo",
      "icon": null,
      "description": "Pronto para uso",
      "canManageChildObjects": false,
      "canSendAndReceiveMessage": false
    },
    "organization": {
      "organizationId": "019ada14-fc9f-712e-a6fc-94b5e313a5df",
      "name": "Messagefy",
      "description": "Organização do Messagefy",
      "status": null
    }
  },
  {
    "accountId": "019ada25-6d8f-77b0-96f6-7594b7a4fcb4",
    "name": "Suporte",
    "description": "Conta para pós venda",
    "createdAt": "2026-01-01T00:00:00",
    "status": {
      "accountStatusId": 1,
      "name": "Created / Inativo",
      "icon": null,
      "description": "Está cadastrado mas não disponível para utilização",
      "canManageChildObjects": false,
      "canSendAndReceiveMessage": false
    },
    "organization": {
      "organizationId": "019ada14-fc9f-712e-a6fc-94b5e313a5df",
      "name": "Messagefy",
      "description": "Organização do Messagefy",
      "status": null
    }
  }
]
Modificado em 2026-01-26 18:02:18
Página anterior
Criar conta
Próxima página
Buscar por id
Built with