Listar lotes de envio

Método

GET https://oapi.ogmma.com.br/v1/bulk

Conceituação

Este endpoint retorna uma lista paginada de todos os lotes de envio em massa da sua instituição. Você pode filtrar por status e controlar a paginação dos resultados.

Utilize este endpoint para visualizar o histórico de envios em massa, acompanhar lotes em andamento ou identificar lotes com falhas.

---

Atributos

Header

Atributo	Tipo	Obrigatório	Descrição
Authorization	string	Sim	Bearer {API_KEY} - Chave de autenticação

Query Parameters

Atributo	Tipo	Obrigatório	Descrição
status	string	Não	Filtrar por status: QUEUED, IN_PROGRESS, COMPLETED, PARTIALLY_FAILED, CANCELLED
page	number	Não	Número da página. Padrão: 1
limit	number	Não	Quantidade de itens por página. Padrão: 20. Máximo: 100

---

Request

cURL

curl -X GET "https://oapi.ogmma.com.br/v1/bulk" \
  -H "Authorization: Bearer {API_KEY}"

Node.js

const axios = require('axios');

const response = await axios.get(
  'https://oapi.ogmma.com.br/v1/bulk',
  {
    headers: {
      'Authorization': 'Bearer {API_KEY}'
    }
  }
);

console.log(response.data);

Python

import requests

response = requests.get(
    'https://oapi.ogmma.com.br/v1/bulk',
    headers={
        'Authorization': 'Bearer {API_KEY}'
    }
)

print(response.json())

---

Response

200 - Success

Retorna a lista paginada de lotes.

{
  "data": [
    {
      "batchId": "bulk_6651a3b2c4d5e6f7a8901234",
      "status": "COMPLETED",
      "name": "Campanha Junho 2025",
      "totalRecipients": 500,
      "sent": 492,
      "failed": 8,
      "progress": 100,
      "createdAt": "2025-06-10T15:00:00Z",
      "completedAt": "2025-06-10T15:25:10Z"
    },
    {
      "batchId": "bulk_6651b4c3d5e6f7a8901235",
      "status": "IN_PROGRESS",
      "name": "Promo Julho 2025",
      "totalRecipients": 1000,
      "sent": 450,
      "failed": 2,
      "progress": 45,
      "createdAt": "2025-07-01T10:00:00Z",
      "completedAt": null
    },
    {
      "batchId": "bulk_6651c5d4e6f7a8901236",
      "status": "CANCELLED",
      "name": "Teste Cancelado",
      "totalRecipients": 200,
      "sent": 50,
      "failed": 0,
      "progress": 25,
      "createdAt": "2025-07-02T08:00:00Z",
      "completedAt": null
    }
  ],
  "pagination": {
    "total": 3,
    "limit": 20,
    "offset": 0
  }
}

401 - Unauthorized

Chave de API inválida ou ausente.

{
  "message": "Chave de API inválida ou expirada.",
  "code": "UNAUTHORIZED"
}

429 - Too Many Requests

Limite de requisições excedido.

{
  "message": "Limite de requisições excedido. Tente novamente em alguns segundos.",
  "code": "RATE_LIMIT_EXCEEDED"
}