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

# Get a summary of organization data for the authenticated user's organization hierarchy.

> Returns aggregated counts for applications, bank accounts, and external bank accounts within the caller's visible organization hierarchy.



## OpenAPI

````yaml /.tooling/schemas/rest/tags/product-embedded-banking.json get /embedded-banking/v1/organization/summary
openapi: 3.1.0
info:
  title: Tesouro Partner API
  version: '2025-06-23'
  description: The Tesouro REST API, for Tesouro partners to integrate with our solution.
  termsOfService: https://tesouro.com/terms
  contact:
    name: Tesouro team
    url: https://tesouro.com/about/
    email: developers@tesouro.com
servers:
  - url: https://api.sandbox.tesouro.com
    description: Sandbox
security: []
tags:
  - name: Applications
  - name: Bank Account Access
  - name: Bank Accounts
  - name: Beneficial Owners
  - name: Disclosures
  - name: Embedded Banking
  - name: External Bank Accounts
  - name: Identity
  - name: MoneyMovements
  - name: Organization
paths:
  /embedded-banking/v1/organization/summary:
    get:
      tags:
        - Organization
        - Embedded Banking
      summary: >-
        Get a summary of organization data for the authenticated user's
        organization hierarchy.
      description: >-
        Returns aggregated counts for applications, bank accounts, and external
        bank accounts within the caller's visible organization hierarchy.
      operationId: GetOrganizationSummary
      parameters: []
      responses:
        '200':
          description: Returns organization summary.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AdminPortalSummaryResponse'
        '400':
          description: Invalid request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmbedProblemDetails'
        '401':
          description: Authentication required.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '403':
          description: Organization context required.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmbedProblemDetails'
      security:
        - HTTPBearer: []
components:
  schemas:
    AdminPortalSummaryResponse:
      required:
        - applications
        - bankAccounts
        - externalBankAccounts
        - organizations
      type: object
      properties:
        applications:
          $ref: '#/components/schemas/BankAccountApplicationSummary'
          description: Summary of bank account applications by status.
        bankAccounts:
          $ref: '#/components/schemas/BankAccountSummary'
          description: Summary of bank accounts by status.
        externalBankAccounts:
          $ref: '#/components/schemas/ExternalBankAccountSummary'
          description: Summary of external bank accounts by verification status.
        organizations:
          type: array
          items:
            $ref: '#/components/schemas/OrganizationSummary'
          description: >-
            Per-organization details including name, account count, and user
            count.
      description: >-
        Summary response for the Admin Portal endpoint.

        Contains aggregated counts for applications, bank accounts, and external
        bank accounts.
    EmbedProblemDetails:
      type: object
      properties:
        detail:
          type:
            - 'null'
            - string
        errorCode:
          type:
            - 'null'
            - string
          description: >-
            Embed-specific error code for client error handling.

            Stored in the Extensions dictionary to ensure proper JSON
            serialization.
        instance:
          type:
            - 'null'
            - string
        status:
          pattern: ^-?(?:0|[1-9]\d*)$
          type:
            - 'null'
            - integer
            - string
          format: int32
        title:
          type:
            - 'null'
            - string
        type:
          type:
            - 'null'
            - string
      description: |-
        Extended ProblemDetails with Embed-specific error code.
        Follows RFC 7807 with additional error code field.
    ProblemDetails:
      type: object
      properties:
        detail:
          type:
            - 'null'
            - string
        instance:
          type:
            - 'null'
            - string
        status:
          pattern: ^-?(?:0|[1-9]\d*)$
          type:
            - 'null'
            - integer
            - string
          format: int32
        title:
          type:
            - 'null'
            - string
        type:
          type:
            - 'null'
            - string
    BankAccountApplicationSummary:
      type: object
      properties:
        complete:
          pattern: ^-?(?:0|[1-9]\d*)$
          type:
            - integer
            - string
          description: Number of complete applications.
          format: int32
        draft:
          pattern: ^-?(?:0|[1-9]\d*)$
          type:
            - integer
            - string
          description: Number of draft applications (not yet submitted).
          format: int32
        submitted:
          pattern: ^-?(?:0|[1-9]\d*)$
          type:
            - integer
            - string
          description: Number of submitted applications (under review).
          format: int32
        total:
          pattern: ^-?(?:0|[1-9]\d*)$
          type:
            - integer
            - string
          description: Total number of applications.
          format: int32
      description: Summary of bank account applications by status.
    BankAccountSummary:
      type: object
      properties:
        total:
          pattern: ^-?(?:0|[1-9]\d*)$
          type:
            - integer
            - string
          description: Total number of bank accounts.
          format: int32
      description: Summary of bank accounts.
    ExternalBankAccountSummary:
      type: object
      properties:
        failed:
          pattern: ^-?(?:0|[1-9]\d*)$
          type:
            - integer
            - string
          description: Number of external bank accounts with failed verification.
          format: int32
        total:
          pattern: ^-?(?:0|[1-9]\d*)$
          type:
            - integer
            - string
          description: Total number of external bank accounts.
          format: int32
        unverified:
          pattern: ^-?(?:0|[1-9]\d*)$
          type:
            - integer
            - string
          description: Number of external bank accounts not yet verified.
          format: int32
        verified:
          pattern: ^-?(?:0|[1-9]\d*)$
          type:
            - integer
            - string
          description: Number of verified external bank accounts.
          format: int32
      description: Summary of external bank accounts by verification status.
    OrganizationSummary:
      required:
        - organizationId
        - name
        - accountCount
        - userCount
      type: object
      properties:
        accountCount:
          pattern: ^-?(?:0|[1-9]\d*)$
          type:
            - integer
            - string
          description: The number of bank accounts belonging to this organization.
          format: int32
        name:
          type: string
          description: The display name of the organization (organization name).
        organizationId:
          type: string
          description: The unique identifier of the organization.
          format: uuid
        uniqueReference:
          type:
            - 'null'
            - string
          description: >-
            The unique organization reference (FIS Enterprise Customer
            Reference).
        userCount:
          pattern: ^-?(?:0|[1-9]\d*)$
          type:
            - integer
            - string
          description: >-
            The number of users with access to bank accounts in this
            organization.
          format: int32
      description: Summary information for a single organization visible to the caller.
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer

````