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

# List sub-merchants

> Paginated list of the sub-merchants the caller administers (the admin-portal sub-merchants list). Visibility is enforced by row-level security. Capped at 1000 records per page.



## OpenAPI

````yaml https://cool.jobmojito.com/functions/v1/openapi get /merchant-sub-merchant-list
openapi: 3.1.0
info:
  title: JobMojito API
  version: 1.0.0
  description: >-
    Public API for JobMojito, served by Supabase Edge Functions. Authenticate
    with a Supabase JWT access token via the Authorization header.
servers:
  - url: https://cool.jobmojito.com/functions/v1
    description: Production
security: []
tags:
  - name: Interviews
    description: >-
      Create, configure and manage interview / coaching / assessment
      definitions.
  - name: Results
    description: >-
      Interview results, transcripts, reports, re-attempt requests and
      analytics.
  - name: Candidates
    description: List and manage candidates.
  - name: Knowledge base
    description: Upload documents used to generate knowledge-base interviews.
  - name: Resume & Form verification
    description: Pre-screen candidates from resumes and forms.
  - name: Admin
    description: >-
      Account administration — invite team/coaching users, manage sub-merchants
      and avatar templates.
paths:
  /merchant-sub-merchant-list:
    get:
      tags:
        - Admin
      summary: List sub-merchants
      description: >-
        Paginated list of the sub-merchants the caller administers (the
        admin-portal sub-merchants list). Visibility is enforced by row-level
        security. Capped at 1000 records per page.
      parameters:
        - schema:
            type: string
            format: uuid
            description: >-
              Optional merchant to scope the results to. Honoured only when the
              caller is an admin or a sub-merchant operator; otherwise the
              merchant from the JWT is always used.
            example: 28106cba-1c27-4e53-b149-32113e5e8e31
          required: false
          name: merchant_id
          in: query
        - schema:
            type: string
            enum:
              - name
              - created_at_newest
              - created_at_oldest
            default: created_at_newest
            description: Sort order of the result set.
            example: created_at_newest
          required: false
          name: order_by
          in: query
        - schema:
            type: string
            description: Case-insensitive search on the sub-merchant name.
          required: false
          name: filter_text
          in: query
        - schema:
            type: integer
            minimum: 1
            maximum: 1000
            default: 50
            description: Maximum number of records to return (1–1000).
            example: 50
          required: false
          name: limit
          in: query
        - schema:
            type: integer
            nullable: true
            minimum: 0
            default: 0
            description: Number of records to skip from the start of the result set.
            example: 0
          required: false
          name: offset
          in: query
      responses:
        '200':
          description: A page of sub-merchants with pagination metadata.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MerchantSubMerchantListResponse'
        '401':
          description: Missing or invalid access token.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: Caller is not permitted to read sub-merchants.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '422':
          description: Validation error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Server error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
        - bearerAuth: []
components:
  schemas:
    MerchantSubMerchantListResponse:
      type: object
      properties:
        data:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
                description: Sub-merchant id.
              name:
                type: string
                nullable: true
                description: Sub-merchant name.
              status:
                type: string
                nullable: true
                description: Status.
              contact_person:
                type: string
                nullable: true
                description: Primary contact name.
              contact_email:
                type: string
                nullable: true
                description: Primary contact email.
              billing_country:
                type: string
                nullable: true
                description: Billing country.
              business_type:
                type: string
                nullable: true
                description: Business type.
              image_logo_url:
                type: string
                nullable: true
                description: Logo image URL.
              frontend_domain:
                type: string
                nullable: true
                description: Consumer frontend domain.
              interview_frontend_domain:
                type: string
                nullable: true
                description: Interview frontend domain.
              register_domain:
                type: string
                nullable: true
                description: Registration domain.
              info_notes:
                type: string
                nullable: true
                description: Internal notes.
              merchant_features:
                nullable: true
                description: Enabled feature flags (jsonb).
              interview_subscription_status:
                type: string
                nullable: true
                description: Interview subscription status.
              interview_subscription_type:
                type: string
                nullable: true
                description: Interview subscription type.
              stripe_interview_subscription_start:
                type: string
                nullable: true
                description: Subscription start (ISO 8601).
              consumer_webanalytics:
                type: string
                nullable: true
                description: Consumer web-analytics id.
              interview_webanalytics:
                type: string
                nullable: true
                description: Interview web-analytics id.
              admin_profiles:
                nullable: true
                description: Admin profiles linked to this sub-merchant (jsonb).
              users:
                nullable: true
                description: Users linked to this sub-merchant (jsonb).
              interview_count:
                type: number
                nullable: true
                description: Total interviews run.
              interview_latest:
                type: string
                nullable: true
                description: Most recent interview timestamp (ISO 8601).
              credits_used_30d:
                type: number
                nullable: true
                description: Credits used in the last 30 days.
              credits_used_total:
                type: number
                nullable: true
                description: Total credits used.
              created_at:
                type: string
                nullable: true
                description: Creation timestamp (ISO 8601).
            required:
              - id
            additionalProperties:
              nullable: true
          description: The sub-merchants the caller administers for this page.
        pagination:
          $ref: '#/components/schemas/Pagination'
      required:
        - data
        - pagination
    Error:
      type: object
      properties:
        error:
          type: string
          example: Field is required.
        name:
          type: string
          example: interview_result_id
      required:
        - error
    Pagination:
      type: object
      properties:
        total:
          type: integer
          description: Total matching records across all pages.
          example: 137
        limit:
          type: integer
          description: Page size used for this response.
          example: 50
        offset:
          type: integer
          description: Offset used for this response.
          example: 0
        has_more:
          type: boolean
          description: >-
            True when more records exist beyond this page (offset + returned <
            total).
          example: true
      required:
        - total
        - limit
        - offset
        - has_more
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: 'Supabase JWT access token, passed as `Authorization: Bearer <token>`.'

````