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

# Check domain availability

> Check whether a domain or subdomain is available for the store to claim. Requires the READ_DOMAINS scope.

Reports whether the given domain or subdomain is available to claim without reserving anything; 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/check-availability
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/check-availability:
    get:
      tags:
        - Domains
      summary: Check domain availability
      description: >-
        Checks whether the given domain or subdomain is available to be claimed
        by the store. Domains are read-only for apps; this only reports
        availability and does not reserve or register anything (claiming is
        owner-only and 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: checkDomainAvailability
      parameters:
        - name: domain
          in: query
          required: true
          description: >-
            The full domain or subdomain to check (for example
            `mystore.salesive.shop` or `shop.example.com`).
          schema:
            type: string
      responses:
        '200':
          description: Whether the domain is available.
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/EnvelopeBase'
                  - type: object
                    properties:
                      data:
                        $ref: '#/components/schemas/DomainAvailability'
              example:
                status: 200
                success: true
                message: Domain availability checked
                data:
                  domain: mystore.salesive.shop
                  available: true
        '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.
    DomainAvailability:
      type: object
      description: Result of a domain availability check.
      properties:
        domain:
          type: string
          description: The domain that was checked.
        available:
          type: boolean
          description: Whether the domain is available to claim.
    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.

````