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

# Check shared phone number availability

> Checks whether a new shared iMessage number can be assigned to the given phone number under this project. Mirrors the allocation rules used by `POST /projects/:projectId/users`, including reuse of a soft-deleted user's previously assigned number within the same project. Returns `false` only when the project has no soft-deleted slot to reuse and every Cosmos shared number is already assigned globally for this phone. Requires Authorization: Basic base64(projectId:projectSecret).



## OpenAPI

````yaml https://spectrum.photon.codes/openapi/json get /projects/{projectId}/imessage/shared/availability
openapi: 3.1.0
info:
  title: Spectrum Cloud External API
  description: Client-facing API for Spectrum Cloud.
  version: 1.0.0
servers:
  - url: https://spectrum.photon.codes
security: []
tags:
  - name: billing
    description: Billing and subscription operations
  - name: imessage
    description: iMessage platform operations
  - name: lines
    description: Phone line enumeration across platforms
  - name: platforms
    description: Platform management operations
  - name: users
    description: User operations
  - name: voice
    description: Voice platform operations
  - name: webhooks
    description: Webhook registration for receiving Spectrum events
  - name: whatsapp-business
    description: WhatsApp Business platform operations
  - name: slack
    description: Slack platform operations
paths:
  /projects/{projectId}/imessage/shared/availability:
    get:
      tags:
        - imessage
      summary: Check shared phone number availability
      description: >-
        Checks whether a new shared iMessage number can be assigned to the given
        phone number under this project. Mirrors the allocation rules used by
        `POST /projects/:projectId/users`, including reuse of a soft-deleted
        user's previously assigned number within the same project. Returns
        `false` only when the project has no soft-deleted slot to reuse and
        every Cosmos shared number is already assigned globally for this phone.
        Requires Authorization: Basic base64(projectId:projectSecret).
      operationId: getProjectsByProjectIdImessageSharedAvailability
      parameters:
        - name: projectId
          in: path
          required: true
          schema:
            type: string
            format: uuid
            pattern: >-
              ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
        - name: phoneNumber
          in: query
          required: true
          schema:
            type: string
            format: e164
            pattern: ^\+[1-9]\d{6,14}$
      responses:
        '200':
          description: Response for status 200
          content:
            application/json:
              schema:
                type: object
                properties:
                  succeed:
                    type: boolean
                    const: true
                  data:
                    type: object
                    properties:
                      available:
                        type: boolean
                    required:
                      - available
                    additionalProperties: false
                required:
                  - succeed
                  - data
                additionalProperties: false

````