Listar contas

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âmetro	Tipo	Obrigatório	Descrição
`page`	number	Não	Número da página que deseja consultar
`perPage`	number	Não	Quantidade de itens por página (máx: 50)
`name`	string	Não	Filtro 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 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 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

Listar contas

📄 Paginação da Listagem#

🔢 Regras de Paginação#