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

# Obtener configuración de recepción

> Devuelve el estado de recepción y el bucket de adjuntos seleccionado. Los registros DNS se devuelven en la identidad. El contenido se conserva durante 30 días, sin configuración de retención. Las cuotas de la organización controlan el tráfico y el tamaño de los mensajes.

<Info>
  Requiere la acción IAM **`email:GetReceivingConfiguration`**. Consulte [permisos de Email](/es/email/permissions) for the full list, what each one covers, and an example policy.
</Info>


## OpenAPI

````yaml /es/api-reference/specs/email.yaml get /v1/identities/{identity_id}/receiving
openapi: 3.0.3
info:
  title: API de Basaltic Email
  version: 1.0.0
  description: >
    API regional para enviar y recibir emails, gestionar identidades y registros
    DNS, plantillas, conjuntos de configuración, pools de IPs, reglas de
    destinatario, contenido y adjuntos.


    Las identidades deben verificarse en cada región. Cree una identidad,
    publique sus dns_records y solicite la verificación. Solo las identidades
    verificadas pueden enviar o activar la recepción.


    Las referencias aceptan UUID, nombre único en la cuenta o CRN del tipo
    esperado. Los nombres son inmutables. Las referencias malformadas o de
    tipo/región incorrectos devuelven 400; las inexistentes o de otra cuenta
    devuelven 404. Las rutas de recursos usan UUID. Los filtros son exactos,
    limitados a la cuenta y aplicados antes de paginar; las referencias
    inexistentes o de otro ámbito devuelven resultados vacíos.


    El contenido enviado y recibido expira tras 30 días. Los objetos adjuntos
    siguen el ciclo de vida del bucket de forma independiente. Use Telemetry
    para métricas agregadas y los endpoints de diagnóstico para eventos y
    registros DMARC.
  contact:
    name: Basaltic Support
    email: ping@basaltic.sh
  license:
    name: Proprietary
    url: https://basaltic.sh/terms
servers:
  - url: https://email.{region}.basaltic.sh
    description: Punto final de API regional
    variables:
      region:
        default: sa-saopaulo-1
        description: Código de región
security:
  - BearerAuth: []
tags:
  - name: Email
    description: Envío de emails para clientes (regional).
paths:
  /v1/identities/{identity_id}/receiving:
    get:
      tags:
        - Email
      summary: Obtener configuración de recepción
      description: >-
        Devuelve el estado de recepción y el bucket de adjuntos seleccionado.
        Los registros DNS se devuelven en la identidad. El contenido se conserva
        durante 30 días, sin configuración de retención. Las cuotas de la
        organización controlan el tráfico y el tamaño de los mensajes.
      operationId: getReceivingConfiguration
      parameters:
        - name: identity_id
          in: path
          required: true
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: Suceso
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReceivingConfigurationResponse'
        '400':
          description: Solicitud no válida.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          description: El solicitante no tiene permiso.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Recurso no encontrado en esta cuenta.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '409':
          description: Estado en conflicto.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: Cuota o límite de tasa excedido.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Error interno.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '503':
          description: Dependencia no disponible.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    ReceivingConfigurationResponse:
      type: object
      required:
        - receiving
      properties:
        receiving:
          $ref: '#/components/schemas/ReceivingConfiguration'
    Error:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          required:
            - code
            - message
            - request_id
          properties:
            code:
              type: string
              description: Código de error que identifica el tipo de error
              example: INVALID_INPUT
            message:
              type: string
              description: Mensaje de error legible por el ser humano
              example: Invalid request parameters
            params:
              type: object
              additionalProperties: true
              description: >-
                Valores no sensibles opcionales para la interpolación de errores
                localizados, codificados por código de error. Nunca presente por
                errores del servidor.
              example:
                instances: 2
                pools: 0
            request_id:
              type: string
              format: uuid
              description: Solicitar ID para depuración
              example: 550e8400-e29b-41d4-a716-446655440000
    ReceivingConfiguration:
      type: object
      required:
        - enabled
        - attachments_bucket
      properties:
        enabled:
          type: boolean
        attachments_bucket:
          allOf:
            - $ref: '#/components/schemas/ResourceRef'
          nullable: true
          type: object
    ResourceRef:
      type: object
      required:
        - id
        - crn
      properties:
        id:
          type: string
          format: uuid
          example: 288aa1e9-bbf5-5584-bce9-6a688f06d8a1
        crn:
          type: string
          example: crn:catalog::platform:country/288aa1e9-bbf5-5584-bce9-6a688f06d8a1
        name:
          type: string
          description: >-
            Etiqueta en el momento de la respuesta: el nombre del recurso, si lo
            tiene, o su etiqueta legible (número de factura, nombre de
            visualización de la cuenta). Ausente cuando el destino ya no existe.
            No es una clave de búsqueda.
          example: Brazil
  responses:
    Unauthorized:
      description: Se requiere autenticación o el token no es válido
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: UNAUTHORIZED
              message: Authentication required
              request_id: 550e8400-e29b-41d4-a716-446655440000
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >+
        Un token bearer de OAuth 2.0, enviado como `Authorization: Bearer
        <token>`. Esta es la forma recomendada de autenticación.


        Obtén el token intercambiando el par de claves de acceso de una cuenta
        de servicio en `POST /v1/oauth/token` con
        `grant_type=client_credentials`. Es el flujo estándar de credenciales de
        cliente; las bibliotecas compatibles con OAuth pueden obtener y renovar
        el token por ti.


        ```

        curl -s -u "$KEY_ID:$SECRET" -d grant_type=client_credentials \
          https://iam.basaltic.sh/v1/oauth/token
        ```


        Los tokens duran una hora por defecto. El mismo par de claves de acceso
        también sirve como credencial AWS SigV4 para el endpoint de objetos
        compatible con S3, que solo acepta ese método de autenticación.


````

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