Listar ApiKeys

dev

https://api-dev.messagefy.io

GET

/api/v1/admin/apikey

📄 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)
`accountId`	uuid	Não	Filtro opcional por id da conta

🔎 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 de Consulta

Parâmetros Header

Respostas

🟢200Sucesso

application/json

Body

🟠400Erro na Criação da Conta

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://api-dev.messagefy.io/api/v1/admin/apikey?accountId=019c478a-9f28-7aa7-97fd-8506438ad45d' \
--header 'api-key: <api-key>' \
--header 'Content-Type: application/json'

Response Example

{
    "id": "019c478a-9f28-7aa7-97fd-8506438ad45d",
    "name": "API Key Padrão para Conta",
    "description": "API Key gerada dinamicamente durante a criação da Conta",
    "apiKey": "acc_019c478a-0000-7dad-9999-37ecb67feed1",
    "resourcePlan": {
        "resourcePlanId": "019bd96a-1783-766e-b552-8a6b19f3af99",
        "name": "TESTE",
        "description": "Plano padrão com 20 requisições por 10 SEGUNDOS",
        "limit": 20,
        "seconds": 10
    },
    "account": {
        "accountId": "019c478a-9f0d-7a25-b243-30d0ac375eae",
        "name": "Nova Conta Teste Fermis - 71553 - 71714 - 73325",
        "description": null,
        "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": "019bd96a-1fca-753e-a56c-b85f8eb2b1a2",
            "name": "ChatGuru",
            "description": "Organização do ChatGuru",
            "status": {
                "organizationStatusId": 1,
                "name": "Created / Inativo",
                "icon": null,
                "description": "Está cadastrado mas não disponível para utilização",
                "canManageChildObjects": false,
                "canSendAndReceiveMessage": false
            }
        }
    },
    "organization": {
        "organizationId": "019bd96a-1fca-753e-a56c-b85f8eb2b1a2",
        "name": "ChatGuru",
        "description": "Organização do ChatGuru",
        "status": {
            "organizationStatusId": 1,
            "name": "Created / Inativo",
            "icon": null,
            "description": "Está cadastrado mas não disponível para utilização",

Modificado em 2026-02-10 12:46:34

Listar ApiKeys

📄 Paginação da Listagem#

🔢 Regras de Paginação#