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

# List domains

> Retrieve the store's domains, including the default subdomain and any custom domains. Requires the READ_DOMAINS scope.

Returns the store's domains (default subdomain plus custom domains); domains are read-only for apps. The store is bound to your app token server-side — never send a shop id.


## OpenAPI

````yaml GET /domains
openapi: 3.1.0
info:
  title: Salesive Apps API — Account
  version: 1.0.0
  description: >-
    Read the store's account configuration — domains, staff roles and payout
    methods — and manage its identity verification (KYC) from an installed
    third-party app. Every endpoint authenticates with an installed-app access
    token (prefix `app_`) and requires a specific OAuth scope. The target store
    is bound to the token server-side from the installation — never send a shop
    id. Domains, roles and payouts are read-only for apps: their
    create/update/delete operations are owner-only and are not exposed here.
servers:
  - url: https://api.salesive.com/api/v1
    description: Production
security:
  - AppToken: []
paths:
  /domains:
    get:
      tags:
        - Domains
      summary: List domains
      description: >-
        Returns the store's domains — the default Salesive subdomain plus any
        custom domains. Domains are read-only for apps; adding, changing or
        removing domains is owner-only and is not exposed here. Requires the
        `READ_DOMAINS` scope and returns 403 if the token is missing it. The
        store is bound to the app token server-side from the installation —
        never send a shop id.
      operationId: listDomains
      responses:
        '200':
          description: The store's domains.
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/EnvelopeBase'
                  - type: object
                    properties:
                      data:
                        type: array
                        items:
                          $ref: '#/components/schemas/Domain'
              example:
                status: 200
                success: true
                message: Domains retrieved
                data:
                  - _id: 66b1f0a3c2d4e5f6a7b8c9d0
                    domain: mystore.salesive.shop
                    shop: 6680aabbccddeeff00112200
                    active: true
                    isCustomDomain: false
                    isDefaultDomain: true
                    status: active
                    hasDNS: false
                    canRenew: false
                    expiresAt: null
                  - _id: 66b1f0a3c2d4e5f6a7b8c9d1
                    domain: shop.example.com
                    shop: 6680aabbccddeeff00112200
                    active: true
                    isCustomDomain: true
                    isDefaultDomain: false
                    status: active
                    hasDNS: true
                    canRenew: true
                    expiresAt: '2027-01-15T00:00:00.000Z'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
components:
  schemas:
    EnvelopeBase:
      type: object
      description: >-
        Standard Salesive response envelope. The operation-specific payload is
        carried in `data`.
      required:
        - status
        - success
        - message
      properties:
        status:
          type: integer
          description: HTTP status code, echoed in the body.
        success:
          type: boolean
          description: Whether the request succeeded.
        message:
          type: string
          description: Human-readable result message.
    Domain:
      type: object
      description: >-
        A domain attached to the store — either the default Salesive subdomain
        or a custom domain.
      properties:
        _id:
          type: string
        domain:
          type: string
          description: The fully-qualified domain or subdomain.
        shop:
          type: string
          description: The store id (bound server-side).
        active:
          type: boolean
          description: Whether the domain is currently active.
        isCustomDomain:
          type: boolean
          description: True for a merchant-owned custom domain.
        isDefaultDomain:
          type: boolean
          description: True for the store's default storefront domain.
        status:
          type: string
          description: Domain status (for example `active`).
        hasDNS:
          type: boolean
          description: Whether DNS has been verified for the domain.
        canRenew:
          type: boolean
          description: Whether the domain is eligible for renewal.
        expiresAt:
          type:
            - string
            - 'null'
          format: date-time
          description: Expiry date, if applicable.
    Envelope:
      allOf:
        - $ref: '#/components/schemas/EnvelopeBase'
        - type: object
          properties:
            data:
              description: Operation-specific payload (object, array, or null).
  responses:
    Unauthorized:
      description: Missing or invalid app access token.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Envelope'
          example:
            status: 401
            success: false
            message: Authentication required
            data: null
    Forbidden:
      description: The app token is missing the OAuth scope required for this operation.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Envelope'
          example:
            status: 403
            success: false
            message: Insufficient scope
            data: null
  securitySchemes:
    AppToken:
      type: http
      scheme: bearer
      description: >-
        Installed-app access token (prefix app_), issued by the OAuth install
        flow. The store is bound to the token server-side — never send a shop
        id.

````