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

# Get an inbound domain

> Retrieve one inbound domain, including its DNS records and
verification status.




## OpenAPI

````yaml https://www.senderkit.com/openapi.yaml get /v1/inbound/domains/{id}
openapi: 3.1.0
info:
  title: SenderKit Public API
  version: 1.0.0
  description: >
    Public REST API for SenderKit — send transactional messages (email, SMS,

    push, web push), list message history, and read/render templates.


    ## Authentication

    All endpoints require a Bearer API key:

        Authorization: Bearer sk_live_xxx

    The `sk_live_` / `sk_test_` prefix selects the environment (live vs. test).

    The prefix is only a hint for humans; the secret is the full token. Keys are

    created in the dashboard and shown once at creation.


    ## Sends are asynchronous

    `POST /v1/send` enqueues the message and returns `202` with `status:
    "queued"`.

    Delivery happens out of band; poll `GET /v1/messages` to observe progress.


    ## Rate limits

    All endpoints are rate limited per API key. Sends and reads count against

    separate budgets, so listing messages never competes with sending them.

    A `429` response includes a `Retry-After` header (seconds).
servers:
  - url: https://api.senderkit.com
    description: Production
  - url: http://localhost:3000/api
    description: Local development
security:
  - apiKey: []
tags:
  - name: Context
    description: Inspect the workspace and environment an API key operates in.
  - name: Send
    description: Dispatch messages.
  - name: Messages
    description: Read message history and cancel pending sends.
  - name: Templates
    description: Read and render stored templates.
  - name: Inbound
    description: |
      Provision addresses on your workspace's shared receiving domain and read
      mail sent to them. Requires an API key with the `inbound` scope.
paths:
  /v1/inbound/domains/{id}:
    get:
      tags:
        - Inbound
      summary: Get an inbound domain
      description: |
        Retrieve one inbound domain, including its DNS records and
        verification status.
      operationId: getInboundDomain
      parameters:
        - $ref: '#/components/parameters/InboundDomainId'
      responses:
        '200':
          description: The inbound domain.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InboundDomain'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          description: >-
            The API key is missing the required `inbound` scope
            (`insufficient_scope`).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: No inbound domain with that id in this workspace (`not_found`).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          $ref: '#/components/responses/RateLimited'
components:
  parameters:
    InboundDomainId:
      name: id
      in: path
      required: true
      description: |
        Inbound domain ID — the row's UUID, as returned in `InboundDomain.id`.
      schema:
        type: string
        format: uuid
  schemas:
    InboundDomain:
      type: object
      properties:
        id:
          type: string
          format: uuid
          description: Inbound domain ID (the row's UUID — there is no separate public id).
        domain:
          type: string
          example: inbound.acme.com
        kind:
          type: string
          enum:
            - shared
            - custom
          description: |
            `shared` is the workspace's auto-provisioned
            `{slug}.in.senderkit.email` domain, which needs no DNS of its own.
            `custom` is a domain you claimed and must verify by publishing
            `records`.
        status:
          type: string
          enum:
            - pending
            - verified
            - failed
        records:
          type: array
          description: |
            DNS records to publish for this domain to verify. Always empty
            for `shared` domains — the wildcard MX on the shared domain
            already covers them.
          items:
            type: object
            required:
              - type
              - name
              - value
              - purpose
              - check
            properties:
              type:
                type: string
                enum:
                  - TXT
                  - MX
              name:
                type: string
              value:
                type: string
              priority:
                type: integer
                description: Present on `MX` records.
              purpose:
                type: string
                description: Human-readable explanation of what this record does.
              check:
                type: string
                enum:
                  - dkim
                  - inboundMx
                description: |
                  Identifies which mechanism confirms this record is correctly
                  published. For `dkim` records, confirmation comes from the
                  domain's SES identity verification status. For `inboundMx`
                  records, confirmation comes from a live DNS lookup that finds
                  the MX already pointing at SenderKit's receiving endpoint.
        verifiedAt:
          type:
            - string
            - 'null'
          format: date-time
        createdAt:
          type: string
          format: date-time
    Error:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          required:
            - code
            - message
          properties:
            code:
              type: string
              description: Stable machine-readable error code.
              example: invalid_request
            message:
              type: string
            issues:
              type: array
              description: Present on validation failures (Zod issues).
              items:
                type: object
                additionalProperties: true
            limit:
              type: integer
              description: Present on rate-limit errors.
  responses:
    Unauthorized:
      description: Missing, malformed, invalid, or revoked API key.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    RateLimited:
      description: Rate limit exceeded.
      headers:
        Retry-After:
          description: Seconds to wait before retrying.
          schema:
            type: integer
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    apiKey:
      type: http
      scheme: bearer
      description: API key with an `sk_live_` or `sk_test_` prefix.

````