Skip to Content
1MSG
ReferenceCampaigns API

Listar campanhas

GET
/api/v1/campaigns

As mais recentes primeiro, de toda a conta. channelId limita a lista a esses canais. Repita o parâmetro ou envie uma lista separada por vírgulas. Sem channelId, vêm todos os canais. limit padrão 50, máximo 100. cursor é o nextCursor da página anterior.

Authorization

bearer
headerAuthorizationBearer <API key>

Chave gerada em Settings → Developer → API key. Os métodos do Inbox precisam do escopo Inbox. Os métodos de Campaigns precisam do escopo Campaigns.

Query Parameters

limit?string

Tamanho da página. Padrão 50, máximo 100.

cursor?string

nextCursor da página anterior. Deixe vazio para a primeira página.

channelId?array<unknown>

id do canal. Repita o parâmetro ou envie uma lista separada por vírgulas. Sem ele, vêm todos os canais.

Response Body

application/json
  1. response
items*array<>

Campanhas desta página, as mais recentes primeiro.

nextCursor*|

Cursor da próxima página, ou null na última página.

Example Request
curl -X GET 'https://api.1msg.io/api/v1/campaigns'
Example Response200
{  "items": [    {      "id": "cm3campaign01",      "name": "April restock",      "channelId": "cm3channel01",      "segmentId": "cm3segment01",      "status": "draft",      "content": {        "mode": "text",        "text": "Hello"      },      "sentAt": "2026-11-01T09:00:00.000Z",      "scheduledAt": "2026-11-01T09:00:00.000Z",      "queuedRemaining": 0,      "sentThisPortion": 0,      "dailyLimit": 1000,      "nextPortionAt": null,      "createdAt": "2026-11-01T09:00:00.000Z",      "updatedAt": "2026-11-01T09:00:00.000Z"    }  ],  "nextCursor": null}