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

# List Sub-Merchants

> List organisations onboarded under the calling partner account.



## OpenAPI

````yaml /openapi.yaml get /partners/orgs
openapi: 3.1.0
info:
  contact:
    email: support@boomfi.xyz
    name: API Support
  description: >-
    The BoomFi Merchants API provides a set of endpoints for merchants to manage
    their accounts, transactions, and more. Hosts differ per brand/environment;
    use the brand-specific base URL from the docs.
  title: ZBX Merchants API
  version: '1.0'
servers:
  - url: https://mapi.zbx.boomfi.xyz/v1
    description: Production
security: []
tags:
  - description: Payment links
    name: Paylinks
  - description: Billing plans
    name: Plans
  - description: Subscriptions
    name: Subscriptions
  - description: Customer records
    name: Customers
  - description: Invoices
    name: Invoices
  - description: Payments
    name: Payments
  - description: Organisation events
    name: Events
  - description: Organisation profile and display settings
    name: Organisation
  - description: Webhook and request-signing secrets
    name: Secrets
  - description: Settlement accounts
    name: Accounts
  - name: Bank Address Book
  - description: Managed virtual accounts, balances, pay-in, and payout
    name: Virtual Accounts
  - description: Partner-managed accounts, virtual accounts, pay-in, and payout
    name: Partners
  - description: Partner virtual account automations and run history
    name: Partner Automations
  - description: Partner maintain-balance automations
    name: Partner Balance Monitoring
  - description: Tradeable currencies, instruments, and swap targets
    name: Instruments
  - description: RFQ quotes
    name: Quotes
  - description: RFQ orders and one-click trades
    name: Orders
  - description: Executed trades
    name: Trades
paths:
  /partners/orgs:
    get:
      tags:
        - Partners
      summary: List Sub-Merchants
      description: List organisations onboarded under the calling partner account.
      parameters:
        - description: Page number (default 1)
          in: query
          name: page
          schema:
            type: integer
        - description: Page size (default 20, max 100)
          in: query
          name: page_size
          schema:
            type: integer
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/partners.ListSubMerchantsResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/internal.ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/internal.ErrorResponse'
      security:
        - ApiKeyAuth: []
          ApiNonce: []
          ApiSignature: []
components:
  schemas:
    partners.ListSubMerchantsResponse:
      properties:
        data:
          $ref: '#/components/schemas/partners.ListSubMerchantsData'
      type: object
    internal.ErrorResponse:
      properties:
        error:
          allOf:
            - $ref: '#/components/schemas/internal.ErrorStruct'
          description: Error details including HTTP-style code and message.
      type: object
    partners.ListSubMerchantsData:
      properties:
        items:
          items:
            $ref: '#/components/schemas/partners.ListSubMerchantItem'
          type: array
        next:
          type: integer
        total:
          type: integer
      type: object
    internal.ErrorStruct:
      properties:
        code:
          description: |-
            Error code
            Example: 400
          example: 400
          type: integer
        errors:
          description: List of errors
          items:
            $ref: '#/components/schemas/internal.SingleError'
          type: array
        message:
          description: |-
            Error message
            Example: Insufficient quantity
          example: Insufficient quantity
          type: string
      type: object
    partners.ListSubMerchantItem:
      properties:
        created_at:
          description: When the resource was created (RFC3339).
          type: string
        external_reference:
          type: string
        kyc_status:
          description: >-
            Identity verification state of the merchant with the custody
            provider:

            "pending" until they clear KYC, "accepted" once they have. Empty in

            self-custody environments, which have no such gate.
          type: string
        name:
          description: Display name.
          type: string
        org_id:
          description: Organisation ID that owns this resource.
          type: string
        owner:
          allOf:
            - $ref: '#/components/schemas/onboarding.CreateOrgOwnerResponse'
          description: Owner for this resource.
        partner_id:
          description: >-
            Identifier of the partner organisation, when this org is under a
            partner.
          type: string
        settlement_accounts:
          description: Settlement accounts for this resource.
          items:
            $ref: '#/components/schemas/onboarding.CreateOrgAccountResponse'
          type: array
        verification_url:
          description: >-
            One-time identity verification (KYC/KYB) url. Only set while the
            custody

            provider still needs the merchant to complete verification.
          type: string
      type: object
    internal.SingleError:
      properties:
        domain:
          description: |-
            Domain
            Example: orders
          example: orders
          type: string
        reason:
          description: |-
            Error Reason
            Example: InsufficientQuantity
          example: InsufficientQuantity
          type: string
      type: object
    onboarding.CreateOrgOwnerResponse:
      properties:
        email:
          description: Email address.
          type: string
        name:
          description: Display name.
          type: string
        phone:
          description: Phone number.
          type: string
        user_id:
          description: Identifier of the user associated with this resource.
          type: string
      type: object
    onboarding.CreateOrgAccountResponse:
      properties:
        address:
          description: >-
            On-chain wallet address or postal street address, depending on
            context.
          type: string
        chain_id:
          description: Blockchain chain ID.
          type: integer
        currencies:
          description: Supported currency codes for this account or chain.
          items:
            type: string
          type: array
        id:
          description: Unique resource identifier.
          type: integer
        name:
          description: Display name.
          type: string
        reference:
          description: Merchant-defined reference string.
          type: string
      type: object
  securitySchemes:
    ApiKeyAuth:
      in: header
      name: X-API-KEY
      type: apiKey
    ApiNonce:
      in: header
      name: X-API-Nonce
      type: apiKey
    ApiSignature:
      in: header
      name: X-API-Signature
      type: apiKey

````