> ## 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.

# Get a custom report definition

> The report's JSON definition, visibility, your access (owner, edit, view) and its version (needed to update it). People who can edit also get the unpublished draft, if any.



## OpenAPI

````yaml https://cool.jobmojito.com/functions/v1/openapi get /report-get
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: Coaching catalogue
    description: >-
      Directories (pages) of the coaching portal catalogue that group coaching
      sessions and carry custom content pages.
  - name: Results
    description: >-
      Interview results, transcripts, reports, re-attempt requests and
      analytics.
  - name: Reports
    description: >-
      Custom reports: read the catalogue of datasets, build a report definition,
      check it, save it and run it.
  - 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:
  /report-get:
    get:
      tags:
        - Reports
      summary: Get a custom report definition
      description: >-
        The report's JSON definition, visibility, your access (owner, edit,
        view) and its version (needed to update it). People who can edit also
        get the unpublished draft, if any.
      parameters:
        - schema:
            type: string
            format: uuid
            description: >-
              Optional merchant to scope to. Admins and sub-merchant operators
              only; other callers always use their token's merchant.
            example: 28106cba-1c27-4e53-b149-32113e5e8e31
          required: false
          name: merchant_id
          in: query
        - schema:
            type: string
            format: uuid
            description: Report id (from list_reports).
          required: true
          name: id
          in: query
      responses:
        '200':
          description: The report.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReportDetail'
        '401':
          description: Missing, expired or invalid access token.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: >-
            Your token or role may not do this (for example a hiring manager
            sharing, or a dataset your account does not include).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: No report with this id, or it is not shared with you.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '422':
          description: >-
            Validation error. The message names the block and field, and lists
            valid ids.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Server error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
        - bearerAuth: []
components:
  schemas:
    ReportDetail:
      type: object
      properties:
        id:
          type: string
          format: uuid
        title:
          type: string
        visibility:
          type: string
          enum:
            - private
            - merchant
            - people
            - template
        access:
          type: string
          enum:
            - owner
            - edit
            - view
        version:
          type: integer
        definition:
          nullable: true
          description: The published ReportDefinition.
        draft_definition:
          nullable: true
          description: Unpublished edits (only for people who can edit), or null.
        admin_url:
          type: string
      required:
        - id
        - title
        - visibility
        - access
        - version
        - admin_url
      additionalProperties:
        nullable: true
    Error:
      type: object
      properties:
        error:
          type: string
          example: Field is required.
        name:
          type: string
          example: interview_result_id
      required:
        - error
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: 'Supabase JWT — `Authorization: Bearer <token>`.'

````

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