Campaigns

List campaigns

Cursor-paginate the workspace campaigns (id, name, status, lead count), newest-first and stable under concurrent changes.

Requires one of the following scopes: campaigns:read, campaigns:all, all:read, all:all.

get/v1/campaigns

Request

  • Base URL: https://api.mailbeast.ai
  • URL: https://api.mailbeast.ai/v1/campaigns
  • Auth: HTTP bearer

Query parameters

cursorstring
Example:eyJ0cyI6IjIwMjYtMDctMDJUMDA6MDA6MDAuMDAwWiIsImlkIjoiM2YxYzJiN2UtOWE0ZC00ZTE4LWIyYzEtNmQ4ZjVhMGU3YzkzIn0

Opaque cursor from a previous response’s meta.nextCursor. Omit for the first page. Results are ordered newest-first and stable under concurrent changes.

limitinteger
Example:50
status'draft' | 'scheduled' | 'active' | 'paused' | 'stopped' | 'completed' | 'failed'

Filter by campaign status.

tagsstring
Example:5c9b1e77-2f4a-4c31-9d8e-1a2b3c4d5e6f,7a1d2e88-3b5c-4d62-8e9f-2b3c4d5e6f70

Only campaigns carrying at least ONE of these tag ids (comma-separated). Read the ids from tags[] on any campaign; tags themselves are managed in the dashboard.

Response

Example response

{
  "data": [
    {
      "id": "a7d4e2f1-08b3-4c65-9e7a-1b2c3d4e5f60",
      "name": "Q4 Product Launch Outreach",
      "status": "active",
      "leadsCount": 150,
      "tags": [
        {
          "id": "5c9b1e77-2f4a-4c31-9d8e-1a2b3c4d5e6f",
          "name": "client-acme",
          "color": "#4F46E5"
        }
      ]
    }
  ],
  "meta": {
    "hasMore": true,
    "nextCursor": "eyJ0cyI6IjIwMjYtMDctMDJUMDA6MDA6MDAuMDAwWiIsImlkIjoiM2YxYzJiN2UtOWE0ZC00ZTE4LWIyYzEtNmQ4ZjVhMGU3YzkzIn0"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.