> ## 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.

# Get receiving configuration

> Returns receiving state and the selected attachment bucket. DNS records are returned on the identity. Message content is retained for 30 days; retention is fixed. Organization quotas control traffic and message size.

<Info>
  Requires the IAM action **`email:GetReceivingConfiguration`**. See [EMAIL permissions](/email/permissions) for the full list, what each one covers, and an example policy.
</Info>


## OpenAPI

````yaml /api-reference/specs/email.yaml get /v1/identities/{identity_id}/receiving
openapi: 3.0.3
info:
  title: Basaltic Email API
  version: 1.0.0
  description: >
    Regional API for sending and receiving email, identities and DNS records,
    templates, configuration sets, IP pools, recipient rules, message content
    and attachments.


    Identities must be verified separately in every region. Create an identity,
    publish its dns_records, then request verification. Only verified identities
    can send or enable receiving.


    Request references accept a UUID, an account-unique name or a CRN of the
    expected resource type. Names are immutable. Malformed references or the
    wrong resource type/region return 400; missing or foreign-account references
    return 404. Resource paths use UUIDs. List filters are exact, account-scoped
    and applied before pagination; missing or foreign references return empty
    results.


    Sent and received message content expires after 30 days. Attachment objects
    follow their bucket lifecycle independently. Use Telemetry for aggregate
    metrics and the diagnostic endpoints for individual events and DMARC report
    records.
  contact:
    name: Basaltic Support
    email: ping@basaltic.sh
  license:
    name: Proprietary
    url: https://basaltic.sh/terms
servers:
  - url: https://email.{region}.basaltic.sh
    description: Regional API endpoint
    variables:
      region:
        default: sa-saopaulo-1
        description: Region code
security:
  - BearerAuth: []
tags:
  - name: Email
    description: Customer-facing email sending (regional).
paths:
  /v1/identities/{identity_id}/receiving:
    get:
      tags:
        - Email
      summary: Get receiving configuration
      description: >-
        Returns receiving state and the selected attachment bucket. DNS records
        are returned on the identity. Message content is retained for 30 days;
        retention is fixed. Organization quotas control traffic and message
        size.
      operationId: getReceivingConfiguration
      parameters:
        - name: identity_id
          in: path
          required: true
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReceivingConfigurationResponse'
        '400':
          description: Invalid request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          description: Caller lacks permission.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Resource not found in this account.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '409':
          description: Conflicting state.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: Quota or rate limit exceeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Internal error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '503':
          description: Dependency unavailable.
          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: Error code identifying the type of error
              example: INVALID_INPUT
            message:
              type: string
              description: Human-readable error message
              example: Invalid request parameters
            params:
              type: object
              additionalProperties: true
              description: >-
                Optional non-sensitive values for interpolation of localized
                errors, keyed by error code. Never present for server errors.
              example:
                instances: 2
                pools: 0
            request_id:
              type: string
              format: uuid
              description: Request ID for debugging
              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: >-
            Display label at response time — the resource's name where it has
            one, otherwise its human label (an invoice number, an account
            display name). Absent when the target is gone. Not a lookup key.
          example: Brazil
  responses:
    Unauthorized:
      description: Authentication required or token invalid
      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: |
        An OAuth 2.0 bearer token, sent as `Authorization: Bearer <token>`.
        This is the recommended way to authenticate.

        Get one by exchanging a service account's access key pair at
        `POST /v1/oauth/token` with `grant_type=client_credentials`. It is the
        standard client-credentials grant, so any OAuth-aware library will
        obtain and refresh it for you.

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

        Tokens last an hour by default. The same access key pair is separately
        your AWS SigV4 credential for the S3-compatible object endpoint, which
        speaks nothing else.

````

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