# List all campaigns
## OpenAPI Specification
```yaml
openapi: 3.0.1
info:
title: ''
description: ''
version: 1.0.0
paths:
/campaign/list-all:
get:
summary: List all campaigns
deprecated: false
description: >-
Retrieve a list of campaigns for a specific workspace with optional
filtering capabilities. Results are sorted by creation date with the
newest campaigns first.
operationId: Campaign_campaign/list-campaigns-in-a-workspace
tags:
- Campaign
- Campaign
parameters:
- name: workspace_id
in: query
description: ID of the workspace to fetch campaigns from
required: true
schema:
type: string
description: ID of the workspace to fetch campaigns from
default: ''
examples:
- 6509f7691205283f2a87f98c
- name: campaign_id
in: query
description: Filter by specific campaign ID
required: false
schema:
type: string
description: Filter by specific campaign ID
default: ''
examples:
- ''
- name: parent_camp_id
in: query
description: Filter by parent campaign ID to list all its associated subsequences
required: false
schema:
type: string
- name: status
in: query
description: Filter by campaign status
required: false
schema:
type: string
description: Filter by campaign status
default: ''
enum:
- ACTIVE
- PAUSED
- COMPLETED
- ARCHIVED
examples:
- ACTIVE
- name: campaign_type
in: query
description: >-
When listing all campaigns, filter by campaign type: 'all'
(default), 'parent' (regular campaigns), or 'subseq' (only
subsequence campaigns)
required: false
schema:
type: string
description: >-
Filter by campaign type: 'all' (default), 'parent' (regular
campaigns), or 'subseq' (only subsequence campaigns)
default: all
enum:
- all
- parent
- subseq
examples:
- all
- name: skip
in: query
description: Number of records to skip for pagination
required: false
schema:
type: integer
description: Number of records to skip for pagination
default: '0'
minimum: 0
examples:
- '0'
- name: limit
in: query
description: Maximum number of records to return
required: false
schema:
type: integer
description: Maximum number of records to return
default: '10'
minimum: 1
maximum: 100
examples:
- '10'
- name: X-API-Key
in: header
description: Your PlusVibe.ai account's API Key
required: false
example: ''
schema:
type: string
description: Your PlusVibe.ai account's API Key
default: ''
examples:
- your-api-key
responses:
'200':
description: Successfully retrieved campaigns
content:
application/json:
schema:
type: array
items:
type: object
properties:
id:
type: string
camp_name:
type: string
parent_camp_id:
type: string
campaign_type:
type: string
organization_id:
type: string
workspace_id:
type: string
status:
type: string
created_at:
type: string
modified_at:
type: string
tags:
type: array
items:
type: string
template_id:
type: string
email_accounts:
type: array
items:
type: string
daily_limit:
type: integer
interval_limit_in_min:
type: integer
send_priority:
type: number
send_as_txt:
type: integer
is_emailopened_tracking:
type: integer
is_unsubscribed_link:
type: integer
exclude_ooo:
type: integer
is_acc_based_sending:
type: integer
send_risky_email:
type: integer
unsub_blocklist:
type: integer
other_email_acc:
type: integer
is_esp_match:
type: integer
stop_on_lead_replied:
type: integer
is_pause_on_bouncerate:
type: integer
bounce_rate_limit:
type: integer
is_paused_at_bounced:
type: integer
last_paused_at_bounced:
type: string
schedule:
type: object
properties:
days:
type: array
items:
type: string
from_time:
type: string
to_time:
type: string
tz:
type: string
required:
- days
- from_time
- to_time
- tz
x-apidog-orders:
- days
- from_time
- to_time
- tz
first_wait_time:
type: integer
camp_st_date:
type: string
camp_end_date:
type: string
events:
type: array
items:
type: string
last_lead_sent:
type: string
sequences:
type: array
items:
type: object
properties:
step:
type: integer
wait_time:
type: integer
variations:
type: array
items:
type: object
properties:
variation:
type: string
subject:
type: string
body:
type: string
x-apidog-orders:
- variation
- subject
- body
x-apidog-orders:
- step
- wait_time
- variations
sequence_steps:
type: integer
camp_emails:
type: array
items:
type: string
lead_count:
type: integer
completed_lead_count:
type: integer
lead_contacted_count:
type: integer
sent_count:
type: integer
opened_count:
type: integer
unique_opened_count:
type: integer
replied_count:
type: integer
bounced_count:
type: integer
unsubscribed_count:
type: integer
positive_reply_count:
type: integer
negative_reply_count:
type: integer
neutral_reply_count:
type: integer
email_sent_today:
type: integer
opportunity_val:
type: integer
open_rate:
type: integer
replied_rate:
type: integer
custom_fields:
type: array
items:
type: string
x-apidog-orders:
- id
- camp_name
- parent_camp_id
- campaign_type
- organization_id
- workspace_id
- status
- created_at
- modified_at
- tags
- template_id
- email_accounts
- daily_limit
- interval_limit_in_min
- send_priority
- send_as_txt
- is_emailopened_tracking
- is_unsubscribed_link
- exclude_ooo
- is_acc_based_sending
- send_risky_email
- unsub_blocklist
- other_email_acc
- is_esp_match
- stop_on_lead_replied
- is_pause_on_bouncerate
- bounce_rate_limit
- is_paused_at_bounced
- last_paused_at_bounced
- schedule
- first_wait_time
- camp_st_date
- camp_end_date
- events
- last_lead_sent
- sequences
- sequence_steps
- camp_emails
- lead_count
- completed_lead_count
- lead_contacted_count
- sent_count
- opened_count
- unique_opened_count
- replied_count
- bounced_count
- unsubscribed_count
- positive_reply_count
- negative_reply_count
- neutral_reply_count
- email_sent_today
- opportunity_val
- open_rate
- replied_rate
- custom_fields
example:
- id: 67b5aeac332004b217cfa997
camp_name: Product Demo Campaign
parent_camp_id: ''
campaign_type: parent
organization_id: 6509f7691205283f2a79f98b
workspace_id: 6509f7691205283f2a79f98c
status: COMPLETED
created_at: '2025-02-19T10:13:00.788Z'
modified_at: '2025-03-03T17:39:00.223Z'
tags:
- 66facee0d4198b6a2e461ce1
template_id: ''
email_accounts:
- 6746f785a5ecee09c96240e6
- 67a444ee50b2a05f84141207
daily_limit: 600
interval_limit_in_min: 1
send_priority: 0.25
send_as_txt: 1
is_emailopened_tracking: 0
is_unsubscribed_link: 0
exclude_ooo: 0
is_acc_based_sending: 0
send_risky_email: 0
unsub_blocklist: 0
other_email_acc: 1
is_esp_match: 0
stop_on_lead_replied: 1
is_pause_on_bouncerate: 0
bounce_rate_limit: 5
is_paused_at_bounced: 0
last_paused_at_bounced: ''
schedule:
days:
- Monday
- Tuesday
- Wednesday
- Thursday
- Friday
from_time: '10:00'
to_time: '17:00'
tz: America/New_York
first_wait_time: 3
camp_st_date: ''
camp_end_date: ''
events:
- ''
last_lead_sent: '2025-03-03T17:38:44.179Z'
sequences:
- step: 1
wait_time: 2
variations:
- variation: A
subject: Your product needs evaluation
body: >-
Hello {{first_name}},
I
noticed your company is using similar solutions and
wanted to reach out.
Our
platform offers competitive features at a better
price point.
Would you be
interested in a demo?
Best
regards,
{{sender_first_name}}
sequence_steps: 3
camp_emails:
- ''
lead_count: 432
completed_lead_count: 432
lead_contacted_count: 286
sent_count: 841
opened_count: 0
unique_opened_count: 0
replied_count: 3
bounced_count: 8
unsubscribed_count: 0
positive_reply_count: 2
negative_reply_count: 0
neutral_reply_count: 0
email_sent_today: 0
opportunity_val: 0
open_rate: 0
replied_rate: 1
custom_fields:
- ''
headers: {}
x-apidog-name: OK
'400':
description: Bad request
content:
application/json:
schema:
type: object
properties:
message:
type: string
description: ''
examples:
- Invalid workspace ID format
error:
type: string
description: ''
examples:
- Invalid workspace ID format
x-apidog-orders:
- message
- error
headers: {}
x-apidog-name: Bad Request
security:
- ApiKeyAuth: []
x-apidog:
schemeGroups:
- id: uS5KiuC4wfZHK42AzOfA_
schemeIds:
- ApiKeyAuth
required: true
use:
id: uS5KiuC4wfZHK42AzOfA_
scopes:
uS5KiuC4wfZHK42AzOfA_:
ApiKeyAuth: []
x-apidog-folder: Campaign
x-apidog-status: released
x-run-in-apidog: https://app.apidog.com/web/project/929054/apis/api-17237998-run
components:
schemas: {}
securitySchemes:
ApiKeyAuth:
type: apikey
in: header
name: x-api-key
description: |
API key issued in the PlusVibe dashboard. The server reads it
from the `x-api-key` header and injects it into the request as
the `api_key` query parameter, which is why you will see
`api_key` referenced in validation errors.
apiKey:
type: apikey
in: body
name: api_key
description: API key passed in request body
servers:
- url: https://api.plusvibe.ai/api/v1
description: Prod Env
security:
- ApiKeyAuth: []
x-apidog:
schemeGroups:
- id: uS5KiuC4wfZHK42AzOfA_
schemeIds:
- ApiKeyAuth
required: true
use:
id: uS5KiuC4wfZHK42AzOfA_
scopes:
uS5KiuC4wfZHK42AzOfA_:
ApiKeyAuth: []
```