> ## 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 un dominio

> Restituisce un dominio e le sue caselle. Le password non vengono mai restituite.

Permesso: `infrastructure:read`



## OpenAPI

````yaml openapi/emailx.it.json GET /workspaces/{workspace_id}/domains/{domain_id}
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}/domains/{domain_id}:
    get:
      tags:
        - Domini e caselle
      summary: Leggere un dominio
      description: >-
        Restituisce un dominio e le sue caselle. Le password non vengono mai
        restituite.


        Permesso: `infrastructure:read`
      operationId: get_api_domain
      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: domain_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/DomainDetail'
                required:
                  - data
              example:
                data:
                  id: 1
                  domain: example
                  status: example
                  mailboxes: []
        '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/domains/{domain_id}" \
              -H "Authorization: Bearer $EMAILX_API_KEY"
        - lang: Python
          source: |-
            import os, requests

            response = requests.get(
                "https://app.emailx.ai/api/v1/workspaces/123/domains/{domain_id}",
                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/domains/{domain_id}",
            {
              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:
    DomainDetail:
      type: object
      properties:
        id:
          type: integer
          minimum: 1
        domain:
          type: string
          nullable: true
        provider:
          type: string
          nullable: true
        status:
          type: string
          nullable: true
        order_id:
          type: integer
          nullable: true
        forwarding_email:
          type: string
          nullable: true
        redirect_domain:
          type: string
          nullable: true
        renewal_date:
          type: string
          nullable: true
          format: date-time
        renew_price:
          type: number
          nullable: true
        created_at:
          type: string
          nullable: true
          format: date-time
        mailboxes:
          type: array
          items:
            $ref: '#/components/schemas/ProvisionedMailbox'
      required:
        - id
        - domain
        - status
        - mailboxes
    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
    ProvisionedMailbox:
      type: object
      properties:
        id:
          type: integer
          minimum: 1
        domain_id:
          type: integer
          nullable: true
        email:
          type: string
          nullable: true
        first_name:
          type: string
          nullable: true
        last_name:
          type: string
          nullable: true
        status:
          type: string
          nullable: true
        warmup_started_at:
          type: string
          nullable: true
          format: date-time
        created_at:
          type: string
          nullable: true
          format: date-time
        credentials_available_via_api:
          type: boolean
          enum:
            - false
      required:
        - id
        - email
        - status
        - credentials_available_via_api
  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.