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

# Leggere le impostazioni della campagna

> Restituisce mittenti, passaggi, pianificazione e lingua, più la revisione da rimandare quando li modifichi.

Permesso: `campaigns:read`



## OpenAPI

````yaml openapi/emailx.it.json GET /workspaces/{workspace_id}/campaigns/{channel}/{campaign_id}/configuration
openapi: 3.0.3
info:
  title: Emailx API
  version: 1.0.0-beta
  description: >-
    Integrazioni Emailx per clienti e agenzie. L’accesso beta è fornito da un
    operatore. La beta v1 supporta importazioni People CSV/XLSX limitate,
    impostazioni salvate dei template email, generazione email selezionata con
    conferma esplicita dei crediti AI, approvazione del messaggio esatto, avvio
    email verificato per l’invio pianificato e risposte inbox confermate
    esplicitamente e legate al contesto salvato, se le capacità dell’host lo
    consentono. Il contesto inbox è limitato e può essere incompleto o non
    aggiornato; non viene recuperato dal provider. Importazioni, attivazione
    verificata e ripresa verificata delle campagne LinkedIn manuali in pausa
    sono flussi separati e gated. Bozze di risposta, knowledge, team, preventivi
    di infrastruttura con checkout ospitato e amministrazione di agenzia hanno
    scope dedicati. Webhook firmati comunicano l’esito delle operazioni
    durevoli. Non supporta invii immediati o addebiti diretti su carta.
servers:
  - url: https://app.emailx.ai/api/v1
    description: Applicazione Emailx · accesso da abilitare
security: []
tags:
  - name: Getting started
  - name: Workspaces
  - name: Contacts
  - name: Templates
  - name: Campaigns
  - name: Inbox
  - name: Senders
  - name: Team
  - name: Analytics
  - name: Imports
  - name: Operations
  - name: Knowledge
  - name: Infrastructure
  - name: Agency
paths:
  /workspaces/{workspace_id}/campaigns/{channel}/{campaign_id}/configuration:
    get:
      tags:
        - Preparare una campagna
      summary: Leggere le impostazioni della campagna
      description: >-
        Restituisce mittenti, passaggi, pianificazione e lingua, più la
        revisione da rimandare quando li modifichi.


        Permesso: `campaigns:read`
      operationId: get_api_campaign_configuration
      parameters:
        - name: workspace_id
          in: path
          required: true
          schema:
            type: integer
            minimum: 1
          description: ID account del workspace Emailx, non ID del collegamento agenzia.
        - name: channel
          in: path
          required: true
          schema:
            type: string
            enum:
              - email
              - linkedin
          description: Identificatore della risorsa.
        - name: campaign_id
          in: path
          required: true
          schema:
            type: integer
            minimum: 1
          description: Identificatore della risorsa.
      responses:
        '200':
          description: Successo
          headers:
            X-Request-Id:
              schema:
                type: string
            Emailx-Api-Version:
              schema:
                type: string
            X-RateLimit-Limit:
              schema:
                type: string
            X-RateLimit-Remaining:
              schema:
                type: string
            X-RateLimit-Reset:
              schema:
                type: string
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/CampaignConfiguration'
                required:
                  - data
              example:
                data:
                  id: 456
                  workspace_id: 123
                  channel: linkedin
                  name: Example Studio outreach
                  campaign_status: draft
                  sender_ids: []
                  revision: >-
                    aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa
                  steps: []
                  schedule:
                    timezone: Europe/Rome
                    active_days:
                      - Mon
                      - Tue
                      - Wed
                      - Thu
                      - Fri
                    time_start: '09:00'
                    time_end: '17:00'
                    daily_connection_limit: 20
                    daily_message_limit: 40
                  reply_owner_subclient_id: null
                  reply_routing: sender
                  language: English
                  audience: null
                  sender_context: null
                  lead_source: manual
                  ai_autopilot_enabled: false
                  editable: true
                  edit_blockers: []
                  approval_status: not_evaluated
                  activation_status: not_requested
        '400':
          description: Errore della richiesta
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Chiave API non valida, scaduta o revocata
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: Scope o permesso di modifica insufficiente
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Risorsa mancante o inaccessibile
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '409':
          description: Conflitto, richiesta concorrente o esito originale incerto
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          headers:
            Retry-After:
              schema:
                type: string
              description: Secondi da attendere, se presenti.
        '413':
          description: Errore della richiesta
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '415':
          description: Errore della richiesta
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: Limite richieste raggiunto; rispettare Retry-After
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          headers:
            Retry-After:
              schema:
                type: string
              description: Secondi da attendere, se presenti.
        '500':
          description: Errore della richiesta
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '503':
          description: >-
            API disabilitata, storage richieste non disponibile o funzione non
            abilitata
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          headers:
            Retry-After:
              schema:
                type: string
              description: Secondi da attendere, se presenti.
      security:
        - BearerAuth: []
      x-codeSamples:
        - lang: cURL
          source: >-
            curl -X GET
            "https://app.emailx.ai/api/v1/workspaces/123/campaigns/linkedin/456/configuration"
            \
              -H "Authorization: Bearer $EMAILX_API_KEY"
        - lang: Python
          source: |-
            import os, requests

            response = requests.get(
                "https://app.emailx.ai/api/v1/workspaces/123/campaigns/linkedin/456/configuration",
                headers={"Authorization": "Bearer " + os.environ["EMAILX_API_KEY"]},
                timeout=30,
            )
            response.raise_for_status()
            print(response.json())
        - lang: JavaScript
          source: >-
            const response = await
            fetch("https://app.emailx.ai/api/v1/workspaces/123/campaigns/linkedin/456/configuration",
            {
              method: "GET",
              headers: { Authorization: `Bearer ${process.env.EMAILX_API_KEY}` },
              signal: AbortSignal.timeout(30000),
            });

            if (!response.ok) throw new Error(`Emailx: ${response.status}`);

            console.log(await response.json());
components:
  schemas:
    CampaignConfiguration:
      type: object
      properties:
        id:
          type: integer
          minimum: 1
        workspace_id:
          type: integer
          minimum: 1
        channel:
          type: string
          enum:
            - email
            - linkedin
        name:
          type: string
        campaign_status:
          type: string
        sender_ids:
          type: array
          items:
            type: integer
            minimum: 1
        revision:
          type: string
          pattern: ^[a-f0-9]{64}$
        steps:
          type: array
          items:
            type: object
            properties:
              id:
                type: integer
                minimum: 1
              label:
                type: string
              template_id:
                type: integer
                minimum: 1
                nullable: true
              type:
                type: string
                nullable: true
              message:
                type: string
                nullable: true
              wait_days:
                type: integer
              has_attachments:
                type: boolean
            required:
              - id
              - label
              - wait_days
        schedule:
          type: object
          properties:
            timezone:
              type: string
              minLength: 1
              maxLength: 100
            active_days:
              type: array
              items:
                type: string
                enum:
                  - Mon
                  - Tue
                  - Wed
                  - Thu
                  - Fri
                  - Sat
                  - Sun
              minItems: 1
              maxItems: 7
              uniqueItems: true
            time_start:
              type: string
              pattern: ^(?:[01][0-9]|2[0-3]):[0-5][0-9]$
            time_end:
              type: string
              pattern: ^(?:[01][0-9]|2[0-3]):[0-5][0-9]$
            daily_volume_per_mailbox:
              type: integer
              nullable: true
            initial_wait_days:
              type: integer
              nullable: true
            daily_connection_limit:
              type: integer
              nullable: true
            daily_message_limit:
              type: integer
              nullable: true
          required:
            - timezone
            - active_days
            - time_start
            - time_end
        reply_owner_subclient_id:
          type: integer
          minimum: 1
          nullable: true
        reply_routing:
          type: string
          nullable: true
        language:
          type: string
          nullable: true
        audience:
          type: string
          nullable: true
        sender_context:
          type: string
          nullable: true
        contact_ids:
          type: array
          items:
            type: integer
            minimum: 1
        lead_source:
          type: string
          nullable: true
        ai_autopilot_enabled:
          type: boolean
        editable:
          type: boolean
        edit_blockers:
          type: array
          items:
            type: string
        approval_status:
          type: string
          enum:
            - not_evaluated
        activation_status:
          type: string
          enum:
            - not_requested
      required:
        - id
        - workspace_id
        - channel
        - name
        - campaign_status
        - sender_ids
        - revision
        - steps
        - schedule
        - reply_owner_subclient_id
        - reply_routing
        - editable
        - edit_blockers
        - approval_status
        - activation_status
    Error:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
            message:
              type: string
            request_id:
              type: string
            details:
              type: object
              additionalProperties: true
          required:
            - code
            - message
            - request_id
      required:
        - error
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: >-
        Chiave ex_test_ o ex_live_ emessa da un operatore Emailx. Non usare
        credenziali provider o cookie di sessione.

````

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