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

# Campaign activity

> Requires `read:campaigns`. Paginated delivery activity (status/channel filters). No provider ids or full message bodies.



## OpenAPI

````yaml /api-reference/openapi.json get /api/v1/marketing/campaigns/{id}/activity
openapi: 3.0.0
info:
  title: Car Storage Software API
  version: 1.1.0
  description: >-
    Team-scoped REST API for Car Storage Software. Authenticate with a team API
    key (`Authorization: Bearer <key>` or `x-api-key: <key>`) created under
    Settings → Integrations → API. Keys carry granular `read:*` / `write:*`
    scopes; read never implies write.
servers:
  - url: https://www.carstoragesoftware.com
security: []
paths:
  /api/v1/marketing/campaigns/{id}/activity:
    get:
      tags:
        - Marketing
      summary: Campaign activity
      description: >-
        Requires `read:campaigns`. Paginated delivery activity (status/channel
        filters). No provider ids or full message bodies.
      parameters:
        - schema:
            type: string
            format: uuid
          required: true
          name: id
          in: path
        - schema:
            type: integer
            minimum: 1
            default: 1
          required: false
          name: page
          in: query
        - schema:
            type: integer
            minimum: 1
            maximum: 200
            default: 50
          required: false
          name: limit
          in: query
        - schema:
            type: string
            format: date-time
          required: false
          name: updatedAfter
          in: query
        - schema:
            type: string
          required: false
          name: ids
          in: query
        - schema:
            type: string
          required: false
          name: status
          in: query
        - schema:
            type: string
          required: false
          name: channel
          in: query
      responses:
        '200':
          description: Campaign activity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V1CampaignActivityResponse'
        '401':
          description: Missing, invalid, revoked, or expired API key.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '403':
          description: API key missing required scope, or API disabled for team.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '404':
          description: Resource not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '422':
          description: Request validation failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
      security:
        - ApiKeyAuth: []
components:
  schemas:
    V1CampaignActivityResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/V1CampaignActivityItem'
        page:
          type: integer
          minimum: 1
        limit:
          type: integer
          minimum: 1
          maximum: 200
        total:
          type: integer
          minimum: 0
      required:
        - data
        - page
        - limit
        - total
    ApiError:
      type: object
      properties:
        error:
          type: string
        code:
          type: string
        details:
          nullable: true
      required:
        - error
    V1CampaignActivityItem:
      type: object
      properties:
        id:
          type: string
          format: uuid
        channel:
          type: string
        status:
          type: string
        customerId:
          type: string
          nullable: true
          format: uuid
        customerName:
          type: string
          nullable: true
        recipientAddress:
          type: string
          nullable: true
        scheduledFor:
          type: string
          nullable: true
          format: date-time
        sentAt:
          type: string
          nullable: true
          format: date-time
        deliveredAt:
          type: string
          nullable: true
          format: date-time
        openCount:
          type: integer
        clickCount:
          type: integer
        error:
          type: string
          nullable: true
        stepId:
          type: string
          nullable: true
          format: uuid
        stepName:
          type: string
          nullable: true
        createdAt:
          type: string
          nullable: true
          format: date-time
      required:
        - id
        - channel
        - status
        - customerId
        - customerName
        - recipientAddress
        - scheduledFor
        - sentAt
        - deliveredAt
        - openCount
        - clickCount
        - error
        - stepId
        - stepName
        - createdAt
  securitySchemes:
    ApiKeyAuth:
      type: http
      scheme: bearer
      bearerFormat: API Key
      description: >-
        Team API key from Settings → Integrations. Use `Authorization: Bearer
        <key>` or `x-api-key`.

````

## Related topics

- [Create a campaign](/docs/marketing-events/create-a-campaign.md)
- [Resume campaign](/docs/api-reference/marketing/resume-campaign.md)
- [Pause campaign](/docs/api-reference/marketing/pause-campaign.md)
- [Get campaign](/docs/api-reference/marketing/get-campaign.md)
- [Duplicate campaign](/docs/api-reference/marketing/duplicate-campaign.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.