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

# Retrieve a sub-account

> Returns the sub-account identified by `id`.



## OpenAPI

````yaml https://wavix.github.io/wavix-openapi/wavix-api.yaml get /v1/sub-organizations/{id}
openapi: 3.1.0
info:
  title: Wavix APIs
  description: >-
    Wavix provides robust APIs that let you integrate voice and text messaging
    features directly into your app. Send text, place calls, and access detailed
    reports  programmatically.
  termsOfService: https://wavix.com/terms-and-conditions
  license:
    name: MIT
    identifier: MIT
  contact:
    name: Wavix
    url: https://wavix.com
    email: support@wavix.com
  version: '1.0'
servers:
  - url: https://api.wavix.com
    description: https://api.wavix.com
    variables: {}
security:
  - bearerAuth: []
tags:
  - name: SIP trunks
    description: SIP trunks
  - name: Buy
    description: Numbers
  - name: Cart
    description: Numbers
  - name: My numbers
    description: Numbers
  - name: Billing
    description: Billing, transactions, and invoices
  - name: Profile
    description: Account profile and customer information
  - name: CDRs
    description: Call detail records and call history
  - name: Speech Analytics
    description: Call transcription and speech analytics
  - name: SMS and MMS
    description: Messaging
  - name: Number Validator
    description: Phone number validation
  - name: Link shortener
    description: Short link and click metrics
  - name: 2FA
    description: Two-factor authentication
  - name: 10DLC
    description: 10DLC Campaigns and Brands
  - name: API Keys
    description: API key management
  - name: Call webhooks
    description: Webhook configuration for call events
  - name: Call control
    description: Programmable Voice
  - name: Call streaming
    description: Real-time call audio streaming over WebSocket
  - name: Call recording
    description: Call recording
  - name: Sub-accounts
    description: Sub-account management
  - name: Voice campaigns
    description: Outbound voice campaigns
  - name: Wavix Embeddable
    description: WebRTC embeddable widget
paths:
  /v1/sub-organizations/{id}:
    get:
      tags:
        - Sub-accounts
      summary: Retrieve a sub-account
      description: Returns the sub-account identified by `id`.
      operationId: sub_accounts_get
      parameters:
        - name: id
          in: path
          description: The unique ID of the sub-account.
          required: true
          style: simple
          explode: false
          schema:
            type: integer
            format: int32
            example: 123
      responses:
        '200':
          headers: {}
          description: Returns the sub-account.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SubOrganizationResponse'
              examples:
                success:
                  summary: Successful response
                  value:
                    id: 123
                    created_at: '2023-06-15T10:30:00Z'
                    name: My sub-account
                    api_key: abc123def456
                    master_organization: 456
                    status: enabled
                    default_destinations:
                      sms_endpoint: https://examples.com/sms
                      dlr_endpoint: https://examples.com/dlr
        '401':
          $ref: '#/components/responses/UnauthorizedErrorResponse'
        '403':
          $ref: '#/components/responses/ForbiddenErrorResponse'
        '404':
          $ref: '#/components/responses/NotFoundErrorResponse'
      deprecated: false
      security:
        - bearerAuth:
            - subaccounts:read
components:
  schemas:
    SubOrganizationResponse:
      title: SubOrganizationResponse
      required:
        - id
        - created_at
        - name
        - api_key
        - master_organization
        - status
        - default_destinations
      type: object
      description: Sub-account details including API key and webhook configurations.
      additionalProperties: false
      properties:
        id:
          type: integer
          format: int32
          description: Sub-account ID.
          example: 123
        created_at:
          type: string
          format: date-time
          description: Date and time the sub-account was created in ISO 8601 format.
          example: '2023-06-15T10:30:00Z'
        name:
          type: string
          description: Sub-account name.
          example: My sub-account
        api_key:
          type: string
          description: Sub-account API key.
          example: abc123def456
        master_organization:
          type: integer
          format: int32
          description: Master account ID.
          example: 456
        status:
          type: string
          description: >-
            Status of the subaccount. One of `enabled` (the subaccount is active
            and can be used) or `disabled` (the subaccount is suspended).
          enum:
            - enabled
            - disabled
          example: enabled
        default_destinations:
          type: object
          additionalProperties: false
          description: Default webhook URLs for inbound messages and delivery reports.
          required:
            - sms_endpoint
            - dlr_endpoint
          properties:
            sms_endpoint:
              type: string
              format: uri
              description: Inbound messages webhook URL.
              example: https://examples.com/sms
            dlr_endpoint:
              type: string
              format: uri
              description: Delivery report webhook URL.
              example: https://examples.com/dlr
      example:
        id: 123
        created_at: '2023-06-15T10:30:00Z'
        name: My sub-account
        api_key: abc123def456
        master_organization: 456
        status: enabled
        default_destinations:
          sms_endpoint: https://examples.com/sms
          dlr_endpoint: https://examples.com/dlr
    UnauthorizedErrorResponse:
      title: UnauthorizedErrorResponse
      type: object
      properties:
        success:
          type: boolean
          description: >-
            Indicates whether the request was successful. Always `false` for
            this error.
          example: false
        error:
          type: boolean
          description: >-
            Indicates that the response represents an error. Always `true` for
            this error.
          example: true
        message:
          type: string
          description: >-
            Human-readable description stating that authentication is missing or
            invalid.
          example: Unauthorized
    ForbiddenErrorResponse:
      title: ForbiddenErrorResponse
      type: object
      properties:
        success:
          type: boolean
          description: >-
            Indicates whether the request was successful. Always `false` for
            this error.
          example: false
        message:
          type: string
          description: Human-readable description of why access is forbidden.
          example: The service is not provisioned for your account.
    NotFoundErrorResponse:
      title: NotFoundErrorResponse
      type: object
      properties:
        success:
          type: boolean
          description: >-
            Indicates whether the request was successful. Always `false` for
            this error.
          example: false
        message:
          type: string
          description: >-
            Human-readable description stating that no resource matches the
            given ID.
          example: Record not found
  responses:
    UnauthorizedErrorResponse:
      description: Unauthorized
      headers: {}
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/UnauthorizedErrorResponse'
    ForbiddenErrorResponse:
      description: Request failed. The feature is disabled for your account.
      headers: {}
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ForbiddenErrorResponse'
    NotFoundErrorResponse:
      description: Request failed. An object with the specified ID is not found.
      headers: {}
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/NotFoundErrorResponse'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >
        Wavix API key. Pass as `Authorization: Bearer <api_key>`. Keys support
        per-resource scopes (none / read / write). See [Restricted keys and
        scopes](https://docs.wavix.com/api-reference/authentication#restricted-keys-and-scopes).

````