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

# List marketing campaigns

> Returns every authored campaign, newest first, with its lifecycle `status` (`draft`, `scheduled`, `sending`, `sent`, `failed`) and the delivery counters recorded at its last dispatch. This is a BARE ARRAY, not a page envelope — there is no pagination. Use it to find a campaign id before a dry-run or a send.



## OpenAPI

````yaml /openapi.json get /v1/campaigns
openapi: 3.0.3
info:
  title: Solya POS API
  version: 1.0.0
  description: >-
    The Solya POS backend HTTP surface. Every documented operation is
    agent-ready: it carries an `operationId`, an agent-facing `description`, the
    `pos.*` scopes it enforces (`x-required-permissions`) and an `x-agent-tier`.
    Success responses return the payload as raw JSON; failures return the
    `ErrorResponse` envelope (`{ error: { code, message, statusCode } }`).
servers:
  - url: /
    description: The backend, relative to its deployed origin.
security: []
paths:
  /v1/campaigns:
    get:
      tags:
        - Marketing
      summary: List marketing campaigns
      description: >-
        Returns every authored campaign, newest first, with its lifecycle
        `status` (`draft`, `scheduled`, `sending`, `sent`, `failed`) and the
        delivery counters recorded at its last dispatch. This is a BARE ARRAY,
        not a page envelope — there is no pagination. Use it to find a campaign
        id before a dry-run or a send.
      operationId: listCampaigns
      responses:
        '200':
          description: Every campaign with its dispatch state, newest first.
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    id:
                      type: string
                      minLength: 1
                    name:
                      type: string
                      minLength: 1
                    channel:
                      type: string
                      enum:
                        - email
                        - sms
                    segment:
                      type: object
                      properties:
                        tier:
                          type: string
                          minLength: 1
                        minMonetaryCents:
                          type: integer
                          minimum: 0
                          maximum: 9007199254740991
                        segment:
                          type: string
                          enum:
                            - champions
                            - loyal
                            - at_risk
                            - new
                            - lost
                      additionalProperties: false
                    templateId:
                      type: string
                      minLength: 1
                    content:
                      type: object
                      properties:
                        subject:
                          type: string
                          minLength: 1
                        body:
                          type: string
                          minLength: 1
                      required:
                        - body
                      additionalProperties: false
                    couponBatchRef:
                      type: string
                      minLength: 1
                    scheduledAt:
                      type: string
                      format: date-time
                      pattern: >-
                        ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
                    status:
                      type: string
                      enum:
                        - draft
                        - scheduled
                        - sending
                        - sent
                        - failed
                    audienceCount:
                      type: integer
                      minimum: 0
                      maximum: 9007199254740991
                    recipientCount:
                      type: integer
                      minimum: 0
                      maximum: 9007199254740991
                    sentCount:
                      type: integer
                      minimum: 0
                      maximum: 9007199254740991
                    failedCount:
                      type: integer
                      minimum: 0
                      maximum: 9007199254740991
                    createdAt:
                      type: string
                      format: date-time
                      pattern: >-
                        ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
                    updatedAt:
                      type: string
                      format: date-time
                      pattern: >-
                        ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
                  required:
                    - id
                    - name
                    - channel
                    - segment
                    - status
                    - audienceCount
                    - recipientCount
                    - sentCount
                    - failedCount
                    - createdAt
                    - updatedAt
                  additionalProperties: false
                description: Every campaign with its dispatch state, newest first.
                example:
                  - id: cmp-3f8a1c02-9d41-4c7b-8b12-6a0f5d7e2c33
                    name: Soldes été 2026
                    channel: email
                    segment:
                      segment: champions
                      minMonetaryCents: 50000
                    content:
                      subject: Vos soldes en avant-première
                      body: Profitez de -20% ce week-end.
                    couponBatchRef: SUMMER26
                    status: draft
                    audienceCount: 0
                    recipientCount: 0
                    sentCount: 0
                    failedCount: 0
                    createdAt: '2026-07-28T09:00:00.000Z'
                    updatedAt: '2026-07-28T09:00:00.000Z'
        '400':
          description: >-
            The request failed schema validation; `error.fieldErrors` lists the
            fields.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorResponse'
        '401':
          description: No valid credential was presented — send a bearer token.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: The actor is authenticated but lacks the required `pos.*` scope.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: An unexpected server error — safe to retry idempotent requests.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
        - bearerAuth: []
components:
  schemas:
    ValidationErrorResponse:
      type: object
      required:
        - error
      additionalProperties: false
      description: >-
        A `VALIDATION_FAILED` envelope carrying the offending fields in
        `fieldErrors`.
      properties:
        error:
          type: object
          required:
            - code
            - message
            - statusCode
          additionalProperties: false
          properties:
            code:
              type: string
              enum:
                - VALIDATION_FAILED
            message:
              type: string
            statusCode:
              type: integer
            fieldErrors:
              type: array
              description: >-
                One entry per rejected field: the field path and why it was
                rejected.
              items:
                type: object
                required:
                  - field
                  - message
                additionalProperties: false
                properties:
                  field:
                    type: string
                    description: Dot-path of the offending field.
                  message:
                    type: string
                    description: Why the field was rejected.
    ErrorResponse:
      type: object
      required:
        - error
      additionalProperties: false
      description: The uniform failure envelope every non-2xx response returns.
      properties:
        error:
          type: object
          required:
            - code
            - message
            - statusCode
          additionalProperties: false
          properties:
            code:
              type: string
              enum:
                - VALIDATION_FAILED
                - UNAUTHORIZED
                - FORBIDDEN
                - NOT_FOUND
                - CONFLICT
                - BUSINESS_RULE_VIOLATION
                - INTERNAL_ERROR
              description: >-
                Machine-readable kernel `ResultCode` — branch on this, not on
                `message`.
            message:
              type: string
              description: >-
                Human-readable explanation. Safe to surface; never leaks server
                internals.
            statusCode:
              type: integer
              description: >-
                The HTTP status, mirrored into the body so a client need not
                read headers.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        `Authorization: Bearer <token>`. Accepts EITHER a Keycloak access token
        (scopes-in-token) OR an opaque POS session token; both resolve to the
        same `pos.*` scope vocabulary the route guards enforce.

````