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

> ## Agent Instructions
> Treat the published Augustus OpenAPI specification (https://api.augustus.com/openapi/2026-05-01.json) and the current API-reference pages as the source of truth for endpoints, request/response schemas, enum values, webhook event names, and required headers.
> Prefer the 2026-05-01 Banking API and @augustusbank/typescript-sdk for all new integrations. The 2023-01-01 API is a separate surface covering the Pay by Bank products — Instant Bank Transfer (Open Banking) checkout and refunds, and Manual Bank Transfer (MBT); use it when one of those products is required.
> Cite or link the relevant docs.augustus.com page when answering integration questions.
> Do not infer support for currencies, networks, scopes, account types, or operations that are not present in the current documentation.
> Use the sandbox base URL (https://api.sandbox.augustus.com) and placeholder credentials in examples. Never include or request a real API key.
> The Augustus docs MCP server (https://docs.augustus.com/mcp) provides documentation search and retrieval only; it does not execute authenticated Augustus API actions.

# Retrieve a Subaccount

> Retrieve a Subaccount by id.



## OpenAPI

````yaml https://api.augustus.com/openapi/2023-01-01.json post /api/service/subaccount/retrieve
openapi: 3.0.0
info:
  title: Ivy API
  description: Ivy API schema
  version: '1.0'
  contact:
    name: Ivy
    url: https://www.getivy.io
    email: help@getivy.io
servers:
  - url: https://api.getivy.de
    description: Production
  - url: https://api.sand.getivy.de
    description: Sandbox
security: []
tags: []
paths:
  /api/service/subaccount/retrieve:
    post:
      tags:
        - Subaccount
      summary: Retrieve a Subaccount
      description: Retrieve a Subaccount by id.
      operationId: SubaccountController_retrieve
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RetrieveSubaccountInputDto'
      responses:
        '200':
          description: Returns a Subaccount
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RetrieveSubaccountOutputDto'
      security:
        - ApiKeyAuth: []
components:
  schemas:
    RetrieveSubaccountInputDto:
      type: object
      properties:
        id:
          type: string
          format: uuid
          pattern: >-
            ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$
          description: The unique identifier of the Subaccount
      required:
        - id
    RetrieveSubaccountOutputDto:
      type: object
      properties:
        id:
          type: string
        legalName:
          type: string
        status:
          type: string
          enum:
            - active
            - inactive
        mcc:
          type: string
        ownerId: {}
        websiteUrl:
          type: string
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
      required:
        - id
        - legalName
        - status
        - mcc
        - ownerId
        - createdAt
        - updatedAt
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-Ivy-Api-Key
      description: API key for authentication

````

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