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

# Read custom email domain and DNS state

> Verified personal Firebase/MCP credential required. Team API/OAuth creator identity is not accepted. Scope is shared across live/test; staging may use the same configured SendGrid account. Test mode does not isolate provider effects. Current unblocked members can read domain/DNS state. configured does not mean DNS valid. Missing values are null. full_domain retains the historical subdomain@domain display format. ownership_status is verified or migration_required; unverified legacy records return can_manage false and require operator-verified migration.



## OpenAPI

````yaml openapi.json GET /teams/{id}/email-domain
openapi: 3.0.3
info:
  title: gigstack API v2
  description: >
    # gigstack API v2


    Build customer, invoice and payment integrations. Start with the
    [quickstart](https://docs.gigstack.io/quickstart), then select the [issuing
    country](https://docs.gigstack.io/concepts/shared-fields).


    ## Authentication and environments


    Use Authorization: Bearer YOUR_API_KEY. Standard live and test keys use
    https://api.gigstack.io/v2. Internal staging uses
    https://gigstack-staging-9z9nnaat.uc.gateway.dev/v2 and separate keys. Test
    mode is a data mode within an environment; a body field does not switch a
    key's mode.


    See [authentication](https://docs.gigstack.io/authentication) for key
    handling, OAuth team scope and gigstack Connect. Internal partner
    provisioning is outside this public contract; health probes have their own
    security declarations. Operations marked unavailable have no configured
    public gateway route.


    ## Read the operation contract


    Response envelopes, pagination and retry rules differ by endpoint. HTTP
    success alone does not prove external fiscal completion or movement of
    money. Reconcile ambiguous writes before retrying. Use [responses and
    recovery](https://docs.gigstack.io/responses) and the operation's error
    codes; document credits and daily limits are not generic retryable rate
    limits.


    The issuing team's configuration selects Mexico or Colombia; customer
    country and currency do not. Read
    [Mexico](https://docs.gigstack.io/countries/mexico) or
    [Colombia](https://docs.gigstack.io/countries/colombia) before choosing
    fiscal fields. Accepted public input differs from a provider's direct
    payload.


    Examples and schema checks do not imply every operation has been executed
    live. [Verification coverage](https://docs.gigstack.io/verification)
    distinguishes source review, offline checks and observed staging behavior.
    Documentation describes operations and does not authorize execution.
  version: 2.0.0
  contact:
    name: Gigstack API Support
    url: https://gigstack.io
    email: support@gigstack.io
  license:
    name: Proprietary
    url: https://gigstack.io/terms
  termsOfService: https://gigstack.io/terms
servers:
  - url: https://api.gigstack.io/v2
    description: >
      Public API for standard live and test-mode keys. Test data is isolated by
      the key mode

      (`livemode: false`). Internal staging is a separate deployment and key
      store; see

      https://docs.gigstack.io/authentication#environments for its base URL.
security:
  - bearerAuth: []
externalDocs:
  description: Complete API Documentation & Guides
  url: https://docs.gigstack.io
paths:
  /teams/{id}/email-domain:
    get:
      tags:
        - Email Domain
      summary: Read custom email domain and DNS state
      description: >-
        Verified personal Firebase/MCP credential required. Team API/OAuth
        creator identity is not accepted. Scope is shared across live/test;
        staging may use the same configured SendGrid account. Test mode does not
        isolate provider effects. Current unblocked members can read domain/DNS
        state. configured does not mean DNS valid. Missing values are null.
        full_domain retains the historical subdomain@domain display format.
        ownership_status is verified or migration_required; unverified legacy
        records return can_manage false and require operator-verified migration.
      operationId: emailDomainGet
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Current domain or durable operation state.
          content:
            application/json:
              schema:
                type: object
                additionalProperties: false
                properties:
                  success:
                    type: boolean
                    enum:
                      - true
                  data:
                    $ref: '#/components/schemas/AccountEmailDomainState'
                  timestamp:
                    type: number
                required:
                  - success
                  - data
                  - timestamp
        '400':
          description: Invalid request, UUID or DNS name.
        '401':
          description: Verified personal credential required.
        '403':
          description: Current unblocked administrator required.
        '404':
          description: Team or operation inaccessible.
        '409':
          description: Active operation, conflicting retry or recovery not yet available.
        '503':
          description: >-
            Explicit runtime environment or internal service identity
            unavailable.
      security:
        - bearerAuth: []
components:
  schemas:
    AccountEmailDomainState:
      type: object
      additionalProperties: false
      properties:
        team_id:
          type: string
        billing_account_id:
          type: string
        effect_scope:
          type: string
          enum:
            - team_shared
        provider_environment:
          type: string
          enum:
            - configured_sendgrid_account
        testmode_isolates_provider:
          type: boolean
          enum:
            - false
        can_manage:
          type: boolean
          description: False when existing domain ownership requires operator verification.
        ownership_status:
          type: string
          enum:
            - verified
            - migration_required
          description: >-
            Provider ownership is established server-side; legacy unverified
            records require operator migration.
        domain:
          type: object
          additionalProperties: false
          properties:
            domain:
              type: string
              nullable: true
            subdomain:
              type: string
              nullable: true
            full_domain:
              type: string
              nullable: true
            valid:
              type: boolean
            dns_setup:
              type: object
              additionalProperties:
                type: object
                additionalProperties: false
                properties:
                  host:
                    type: string
                  type:
                    type: string
                  data:
                    type: string
                  valid:
                    type: boolean
                required:
                  - host
                  - type
                  - data
                  - valid
            configured:
              type: boolean
          required:
            - domain
            - subdomain
            - full_domain
            - valid
            - dns_setup
            - configured
        active_operation:
          type: object
          additionalProperties: false
          properties:
            id:
              type: string
            action:
              type: string
              enum:
                - set
                - validate
                - remove
            status:
              type: string
              enum:
                - pending
                - processing
                - completed
                - failed
                - outcome_unknown
            created_at:
              type: number
            started_at:
              type: number
              nullable: true
            completed_at:
              type: number
              nullable: true
            recovery_available_at:
              type: number
              nullable: true
            result:
              type: object
              additionalProperties: false
              properties:
                domain:
                  type: object
                  additionalProperties: false
                  properties:
                    domain:
                      type: string
                      nullable: true
                    subdomain:
                      type: string
                      nullable: true
                    full_domain:
                      type: string
                      nullable: true
                    valid:
                      type: boolean
                    dns_setup:
                      type: object
                      additionalProperties:
                        type: object
                        additionalProperties: false
                        properties:
                          host:
                            type: string
                          type:
                            type: string
                          data:
                            type: string
                          valid:
                            type: boolean
                        required:
                          - host
                          - type
                          - data
                          - valid
                    configured:
                      type: boolean
                  required:
                    - domain
                    - subdomain
                    - full_domain
                    - valid
                    - dns_setup
                    - configured
                previous_provider_domain_retained:
                  type: boolean
              required:
                - domain
                - previous_provider_domain_retained
              nullable: true
            error_code:
              type: string
              nullable: true
            resolution:
              type: object
              additionalProperties: false
              required:
                - action
                - resolved_at
              properties:
                action:
                  type: string
                  enum:
                    - released_for_new_operation
                resolved_at:
                  type: number
              nullable: true
          required:
            - id
            - action
            - status
            - created_at
            - started_at
            - completed_at
            - recovery_available_at
            - result
            - error_code
            - resolution
          nullable: true
      required:
        - team_id
        - billing_account_id
        - effect_scope
        - provider_environment
        - testmode_isolates_provider
        - can_manage
        - ownership_status
        - domain
        - active_operation
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >
        **Authentication Method:** HTTP Bearer token.


        The runtime requires the literal `Bearer ` prefix — a bare token in the

        `Authorization` header is rejected with `401 unauthorized`.


        **Header Format:** `Authorization: Bearer YOUR_API_KEY`


        Your API key is a JWT. Live keys operate on live data (`livemode:
        true`);

        test keys operate on isolated test data (`livemode: false`).


        **Get your key at:**
        [app.gigstack.pro/settings?tab=api](https://app.gigstack.pro/settings?tab=api)


        **Errors:** credential failures are answered by the authentication layer
        with a raw

        `{ "message": … }` body, not the standardized envelope — `401` for a
        missing, malformed or

        expired token, `403` for a revoked key or a plan without API access. See
        the `Unauthorized`

        and `AuthForbidden` responses.

````

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