> ## 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 interview definitions

> Paginated list of a merchant's interview definitions (the admin-portal interview list), scoped to the merchant from the JWT or the optional merchant_id override. Capped at 1000 records per page.



## OpenAPI

````yaml https://cool.jobmojito.com/functions/v1/openapi get /merchant-interview-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-interview-list:
    get:
      tags:
        - Interviews
      summary: List interview definitions
      description: >-
        Paginated list of a merchant's interview definitions (the admin-portal
        interview list), scoped to the merchant from the JWT or the optional
        merchant_id override. 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:
              - interview
              - coaching
              - assessment
              - public_avatar
              - persona
            default: interview
            description: Product type of interviews to list.
            example: interview
          required: false
          name: type
          in: query
        - schema:
            type: string
            enum:
              - draft
              - active
              - archived
              - deleted
              - preparing
              - completed
            description: Filter by lifecycle status. Omit to include all statuses.
            example: active
          required: false
          name: status
          in: query
        - schema:
            type: string
            enum:
              - 'true'
              - 'false'
            default: 'false'
            description: >-
              Include interviews shared publicly across merchants
              (coaching/avatars).
            example: 'false'
          required: false
          name: show_public
          in: query
        - schema:
            type: string
            enum:
              - 'true'
              - 'false'
            default: 'false'
            description: Include demo/sample interviews.
            example: 'false'
          required: false
          name: show_demo
          in: query
        - schema:
            type: string
            description: Case-insensitive search on the interview name.
          required: false
          name: filter_text
          in: query
        - schema:
            type: string
            description: Filter by the interview emoji marker.
          required: false
          name: filter_emoji
          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 interview definitions with pagination metadata.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MerchantInterviewListResponse'
        '401':
          description: Missing or invalid access token.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: Caller is not permitted to read this merchant.
          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:
    MerchantInterviewListResponse:
      type: object
      properties:
        data:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
                description: Interview definition id.
              merchant_id:
                type: string
                nullable: true
                description: Owning merchant id.
              name:
                type: string
                nullable: true
                description: Interview name.
              emoji:
                type: string
                nullable: true
                description: Emoji marker.
              type:
                type: string
                nullable: true
                description: Product type (interview/coaching/…).
              type_avatar:
                type: string
                nullable: true
                description: Avatar type used by the interview.
              status:
                type: string
                nullable: true
                description: Lifecycle status.
              visibility:
                type: string
                nullable: true
                description: Visibility (merchant_public/invite/unlisted/…).
              mojito_language_code:
                type: string
                nullable: true
                description: Platform language code.
              speech_language_code:
                type: string
                nullable: true
                description: Speech language code.
              environment:
                type: string
                nullable: true
                description: Environment (production/test/…).
              is_ats:
                type: boolean
                nullable: true
                description: Whether the interview is ATS-integrated.
              is_multi_stage:
                type: boolean
                nullable: true
                description: Whether the interview is multi-stage.
              recording:
                type: string
                nullable: true
                description: Per-answer recording/proctoring mode.
              recording_full_session:
                type: string
                nullable: true
                description: Full-session recording mode.
              billing_single_position:
                type: boolean
                nullable: true
                description: Single-position billing flag.
              billing_single_position_end_at:
                type: string
                nullable: true
                description: Single-position billing end (ISO 8601).
              cover_image_url:
                type: string
                nullable: true
                description: Cover image URL.
              interview_count:
                type: number
                nullable: true
                description: Number of interviews run against this definition.
              interview_last:
                type: string
                nullable: true
                description: Timestamp of the most recent interview (ISO 8601).
              calc_duration:
                type: number
                nullable: true
                description: Calculated duration.
              created_at:
                type: string
                nullable: true
                description: Creation timestamp (ISO 8601).
              updated_at:
                type: string
                nullable: true
                description: Last update timestamp (ISO 8601).
            required:
              - id
            additionalProperties:
              nullable: true
          description: >-
            The merchant's interview definitions for this page, newest-updated
            first.
        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>`.'

````