---
title: "Lists all of your campaigns and their aggregate statistics."
method: GET
path: "/api/campaigns"
tags: ["Campaigns"]
---

# Lists all of your campaigns and their aggregate statistics.

`GET /api/campaigns`

## Request

- Base URL: `https://api.gmass.co`
- URL: `https://api.gmass.co/api/campaigns`
- Auth: none declared

## Query parameters

- `limit` integer
- `offset` integer

## Response `200`

OK

- Campaign[]
  - `campaignId` integer: The GMass-generated campaign ID number for a campaign.
  - `subject` string
  - `friendlyName` string
  - `stage` integer
  - `creationTime` string, date-time
  - `fromLine` string
  - `statistics` Statistics
    - `recipients` integer
    - `opens` integer
    - `clicks` integer
    - `replies` integer
    - `unsubscribes` integer
    - `bounces` integer
    - `blocks` integer
  - `status` string: Will be set to one of the following: sent, scheduled, error, processing, unknown, cancelled, paused, abpaused
  - `lists` List[]
    - `listAddress` string: The GMass-generated address to represent an email list. Looks like aaabbb-cccc@gmass.co
    - `listSource` ListSource
      - `listSourceSheet` ListSourceSheet
        - `spreadsheetId` string: The "id" value of the Google Sheet. Can be retrieved from the sheets.google.com URL
        - `worksheetId` string: The Google assigned ID of the worksheet within a Google Sheet. The default worksheet usually has an ID of 0.
        - `spreadsheetName` string: The name of the Google Sheet
        - `worksheetName` string: The name of the tab (worksheet) inside the Google Sheet
        - `KeepDuplicates` boolean: Whether duplicates should be kept or filtered out. Set to true or false.
        - `FilterCriteria` string: A string value representing a filter of rows in the Sheet. See https://www.gmass.co/blog/send-mail-merge-to-selected-rows-spreadsheet/
        - `AndOr` string: If FilterCriteria specified, then specify whether the criteria should be joined by a boolean AND or OR. The default is AND. Specify as "And" or "Or".
        - `UpdateSheet` boolean: Whether GMass should update the Sheet with additional columns to track reporting data. Set to true or false.
  - `autoFollowups` AutoFollowup[]: Auto follow-ups associated with this campaign
    - `stage` integer
    - `campaignId` integer
    - `batches` AutoFollowupBatch[]
      - `batchId` integer
      - `status` string
      - `creationTime` string, date-time
      - `estimatedCount` integer

---

[API](https://skmtc.dev/gmass/apis/gmass-api.md) - [All operations](https://skmtc.dev/gmass/apis/gmass-api/llms.txt) - [OpenAPI document](https://skmtc.dev/gmass/apis/gmass-api/revisions/0498e4a9c765?raw)