> ## Documentation Index
> Fetch the complete documentation index at: https://help.hoopai.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Bulk Action Campaigns

> Get list of bulk action campaigns for a location



## OpenAPI

````yaml /api-reference/emails/openapi.json get /emails/campaigns/bulk-actions
openapi: 3.0.0
info:
  title: Email API
  description: Documentation for emails API
  version: '1.0'
  contact: {}
servers:
  - url: https://services.leadconnectorhq.com
security: []
tags:
  - name: Emails
    description: Documentation for emails API
  - name: Campaigns
    description: Documentation for emails API
  - name: Templates
    description: Documentation for emails API
  - name: Statistics
    description: Documentation for emails API
paths:
  /emails/campaigns/bulk-actions:
    get:
      tags:
        - Campaigns
      summary: Get Bulk Action Campaigns
      description: Get list of bulk action campaigns for a location
      operationId: fetch-bulk-action-campaigns
      parameters:
        - name: locationId
          required: true
          in: query
          description: Location ID
          schema:
            type: string
            example: ve9EPM428h8vShlRW1KT
        - name: limit
          required: false
          in: query
          description: >-
            Number of campaigns to return. Defaults to 10, minimum is 1, maximum
            is 20
          schema:
            minimum: 1
            maximum: 20
            default: 10
            example: 10
            type: number
        - name: offset
          required: false
          in: query
          description: >-
            Number of campaigns to skip for pagination. Defaults to 0, minimum
            is 0
          schema:
            minimum: 0
            default: 0
            example: 0
            type: number
        - name: dateFrom
          required: false
          in: query
          description: Filter by start date (ISO 8601 format)
          schema:
            example: '2024-01-01T00:00:00.000Z'
            type: string
        - name: dateTo
          required: false
          in: query
          description: Filter by end date (ISO 8601 format)
          schema:
            example: '2024-12-31T23:59:59.999Z'
            type: string
        - name: status
          required: false
          in: query
          description: Filter by status
          schema:
            example: complete
            enum:
              - processing
              - scheduled
              - paused
              - complete
              - cancelled
            type: string
        - name: Version
          in: header
          description: API Version
          required: true
          schema:
            type: string
            enum:
              - '2021-07-28'
            example: '2021-07-28'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetBulkActionCampaignsResponseDto'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestDTO'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedDTO'
        '403':
          description: The token does not have access to this location
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidLocationDTO'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundDTO'
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnprocessableDTO'
      security:
        - Location-Access:
            - emails/schedule.readonly
components:
  schemas:
    GetBulkActionCampaignsResponseDto:
      type: object
      properties:
        campaigns:
          description: List of bulk action campaigns
          type: array
          items:
            $ref: '#/components/schemas/BulkActionCampaignDto'
        total:
          type: number
          description: Total count of bulk action campaigns
          example: 25
      required:
        - campaigns
        - total
    BadRequestDTO:
      type: object
      properties:
        statusCode:
          type: number
          example: 400
        message:
          type: string
          example: Bad Request
      required:
        - statusCode
        - message
    UnauthorizedDTO:
      type: object
      properties:
        statusCode:
          type: number
          example: 401
        message:
          type: string
          example: 'Invalid token: access token is invalid'
        error:
          type: string
          example: Unauthorized
      required:
        - statusCode
        - message
        - error
    InvalidLocationDTO:
      type: object
      properties:
        statusCode:
          type: number
          example: 403
        message:
          type: string
          example: The token does not have access to this location
    NotFoundDTO:
      type: object
      properties:
        statusCode:
          type: number
          example: 404
        message:
          type: string
          example: Not Found
        error:
          type: string
          example: The requested resource was not found
    UnprocessableDTO:
      type: object
      properties:
        statusCode:
          type: number
          example: 422
        message:
          type: array
          items:
            type: string
          example:
            - Unprocessable Entity
        error:
          type: string
          example: Unprocessable Entity
      required:
        - statusCode
        - message
        - error
    BulkActionCampaignDto:
      type: object
      properties:
        id:
          type: string
          description: Campaign ID
          example: OI72xYec4Mho6VBykTvj
        name:
          type: string
          description: Campaign name
          example: Test Mail
        status:
          type: string
          description: Campaign status
          example: complete
          enum:
            - processing
            - scheduled
            - paused
            - complete
            - cancelled
        scheduleType:
          type: string
          description: Schedule type (NOW or SCHEDULED)
          example: NOW
        createdBy:
          type: string
          description: User who created the campaign
          example: John Doe
        deleted:
          type: boolean
          description: Whether the campaign is deleted
          example: false
        createdAt:
          type: string
          description: Created at timestamp
          example: '2025-07-24T11:55:43.598Z'
        updatedAt:
          type: string
          description: Last updated timestamp
          example: '2026-02-09T04:49:12.322Z'
        completedAt:
          type: string
          description: Processing completion timestamp
          example: '2025-07-24T11:55:48.000Z'
        emailMetadata:
          $ref: '#/components/schemas/BulkActionCampaignEmailDetailsDto'
      required:
        - id
        - name
        - status
        - scheduleType
        - createdBy
        - deleted
        - createdAt
        - updatedAt
    BulkActionCampaignEmailDetailsDto:
      type: object
      properties:
        subject:
          type: string
          description: Email subject line
          example: Welcome to our platform
        from:
          type: string
          description: Sender (name and email)
          example: John Doe <john@example.com>
        name:
          type: string
          description: Sender name
          example: John Doe
        templateId:
          type: string
          description: Email template ID
          example: 6790aeb53c8d1288f555f92b

````