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

# Campaign workspace projection



## OpenAPI

````yaml /openapi/buyer.yaml get /api/v2/buyer/campaigns/{id}/workspace
openapi: 3.1.0
info:
  title: Semicola Exchange buyer API
  version: 2.0.0
  description: >-
    Buyer endpoints: advertisers, storefronts and connections, product
    discovery, campaigns, proposals, media buys, creatives and reporting. Every
    write accepts an Idempotency-Key header.
servers:
  - url: https://api.semicola.com
security:
  - bearerAuth: []
  - sessionCookie: []
tags:
  - name: Advertisers
  - name: Storefronts
  - name: Product Discovery
  - name: Campaigns
  - name: Media Buys
  - name: Creatives
  - name: Reporting
  - name: Event Sources
  - name: Webhooks
  - name: Tasks
  - name: Audit Logs
paths:
  /api/v2/buyer/campaigns/{id}/workspace:
    get:
      tags:
        - Campaigns
      summary: Campaign workspace projection
      operationId: getBuyerCampaignsByIdWorkspace
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
            minLength: 1
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    anyOf:
                      - type: object
                        properties:
                          campaignId:
                            type: string
                          name:
                            type: string
                          status:
                            type: string
                            enum:
                              - DRAFT
                              - ACTIVE
                              - PAUSED
                              - COMPLETED
                              - CANCELED
                              - ARCHIVED
                          management:
                            type: string
                            enum:
                              - managed
                              - tracked
                          advertiserName:
                            type: string
                          flight:
                            type: object
                            properties:
                              startAt:
                                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|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
                              endAt:
                                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|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
                            required:
                              - startAt
                              - endAt
                            additionalProperties: false
                          revision:
                            type: integer
                            minimum: 0
                            maximum: 9007199254740991
                          kpis:
                            type: object
                            properties:
                              spend:
                                type: object
                                properties:
                                  amount:
                                    type: string
                                    pattern: ^-?\d+(\.\d{1,6})?$
                                  currency:
                                    type: string
                                    pattern: ^[A-Z]{3}$
                                required:
                                  - amount
                                  - currency
                                additionalProperties: false
                              budget:
                                type: object
                                properties:
                                  amount:
                                    type: string
                                    pattern: ^-?\d+(\.\d{1,6})?$
                                  currency:
                                    type: string
                                    pattern: ^[A-Z]{3}$
                                required:
                                  - amount
                                  - currency
                                additionalProperties: false
                              pacingPct:
                                type:
                                  - number
                                  - 'null'
                            required:
                              - spend
                              - budget
                              - pacingPct
                            additionalProperties: false
                          outcome:
                            type: object
                            properties:
                              metric:
                                type: string
                              current:
                                type:
                                  - number
                                  - 'null'
                              target:
                                type:
                                  - number
                                  - 'null'
                              status:
                                type: string
                                enum:
                                  - working
                                  - at_risk
                                  - met
                                  - unavailable
                            required:
                              - metric
                              - current
                              - target
                              - status
                            additionalProperties: false
                          mediaBuys:
                            type: array
                            items:
                              type: object
                              properties:
                                mediaBuyId:
                                  type: string
                                packageIds:
                                  type: array
                                  items:
                                    type: string
                                seller:
                                  type: object
                                  properties:
                                    sellerId:
                                      type: integer
                                      exclusiveMinimum: 0
                                      maximum: 9007199254740991
                                    name:
                                      type: string
                                    logoUrl:
                                      type:
                                        - string
                                        - 'null'
                                  required:
                                    - sellerId
                                    - name
                                    - logoUrl
                                  additionalProperties: false
                                status:
                                  type: string
                                  enum:
                                    - DRAFT
                                    - PENDING_APPROVAL
                                    - INPUT_REQUIRED
                                    - ACTIVE
                                    - PAUSED
                                    - COMPLETED
                                    - CANCELED
                                    - FAILED
                                    - REJECTED
                                    - ARCHIVED
                                flight:
                                  type: object
                                  properties:
                                    startAt:
                                      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|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
                                    endAt:
                                      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|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
                                  required:
                                    - startAt
                                    - endAt
                                  additionalProperties: false
                                budget:
                                  type: object
                                  properties:
                                    amount:
                                      type: string
                                      pattern: ^-?\d+(\.\d{1,6})?$
                                    currency:
                                      type: string
                                      pattern: ^[A-Z]{3}$
                                  required:
                                    - amount
                                    - currency
                                  additionalProperties: false
                                spent:
                                  type: object
                                  properties:
                                    amount:
                                      type: string
                                      pattern: ^-?\d+(\.\d{1,6})?$
                                    currency:
                                      type: string
                                      pattern: ^[A-Z]{3}$
                                  required:
                                    - amount
                                    - currency
                                  additionalProperties: false
                                progressPct:
                                  anyOf:
                                    - type: number
                                      minimum: 0
                                      maximum: 100
                                    - type: 'null'
                                pendingReason:
                                  type:
                                    - string
                                    - 'null'
                              required:
                                - mediaBuyId
                                - packageIds
                                - seller
                                - status
                                - flight
                                - budget
                                - spent
                                - progressPct
                                - pendingReason
                              additionalProperties: false
                          creatives:
                            type: object
                            properties:
                              ready:
                                type: integer
                                minimum: 0
                                maximum: 9007199254740991
                              total:
                                type: integer
                                minimum: 0
                                maximum: 9007199254740991
                              items:
                                type: array
                                items:
                                  type: object
                                  properties:
                                    creativeId:
                                      type: string
                                    name:
                                      type: string
                                    status:
                                      type: string
                                      enum:
                                        - ready
                                        - in_review
                                        - rejected
                                  required:
                                    - creativeId
                                    - name
                                    - status
                                  additionalProperties: false
                            required:
                              - ready
                              - total
                              - items
                            additionalProperties: false
                          controls:
                            type: array
                            items:
                              type: object
                              properties:
                                key:
                                  type: string
                                  enum:
                                    - inventory_selection
                                    - rebriefing
                                    - exclusions
                                    - brand_safety
                                label:
                                  type: string
                                value:
                                  type: string
                                overridden:
                                  type: boolean
                              required:
                                - key
                                - label
                                - value
                                - overridden
                              additionalProperties: false
                          recentActivity:
                            type: array
                            items:
                              type: object
                              properties:
                                id:
                                  type: string
                                actorKind:
                                  type: string
                                  enum:
                                    - user
                                    - agent
                                    - automation
                                    - buyer_agent
                                    - system
                                actorLabel:
                                  type: string
                                description:
                                  type: string
                                at:
                                  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|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
                              required:
                                - id
                                - actorKind
                                - actorLabel
                                - description
                                - at
                              additionalProperties: false
                          actions:
                            type: object
                            properties:
                              canPause:
                                type: boolean
                              canReactivate:
                                type: boolean
                              canGoLive:
                                type: boolean
                            required:
                              - canPause
                              - canReactivate
                              - canGoLive
                            additionalProperties: false
                        required:
                          - campaignId
                          - name
                          - status
                          - management
                          - advertiserName
                          - flight
                          - revision
                          - kpis
                          - outcome
                          - mediaBuys
                          - creatives
                          - controls
                          - recentActivity
                          - actions
                        additionalProperties: false
                      - type: 'null'
                  error:
                    anyOf:
                      - type: object
                        properties:
                          code:
                            type: string
                          message:
                            type: string
                          field:
                            type: string
                          details: {}
                        required:
                          - code
                          - message
                        additionalProperties: false
                      - type: 'null'
                required:
                  - data
                  - error
                additionalProperties: false
        default:
          description: >-
            Error envelope `{data: null, error: {code, message, field?,
            details?}}`.
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: API key or OAuth access token.
    sessionCookie:
      type: apiKey
      in: cookie
      name: sc_session

````