> ## 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 the component style guide

> Everything needed to design a style for one kind of page block (hero, cards, faq, ...): the selectors each block renders, its layout variants, the CSS variables of the brand, and the styles the editor already offers per block type, each with the pages that use it. Read it before save_component_style. Style settings are switched on per company by JobMojito; while they are off this endpoint answers 403.



## OpenAPI

````yaml https://cool.jobmojito.com/functions/v1/openapi get /portal-component-styles
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: Positions
    description: >-
      A position's hiring process: its steps and their settings, meeting slots,
      and copies of positions and interviews.
  - 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: Tasks
    description: >-
      Follow-up tasks for the hiring team, about a candidate, an application or
      a position.
  - name: Document requests
    description: >-
      Ask candidates for documents (certificates, IDs, references), follow them
      up and mark them reviewed.
  - 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.
  - name: Feedback
    description: >-
      Send feature requests to the product team and report technical issues to
      support.
  - name: Integrations
    description: >-
      Ready-made connectors and how their fields map to JobMojito. A company
      sees the same tables under Integrations > Catalogue > Field mapping.


      ### ATS connector (Kombo)


      The applicant tracking system is connected through Kombo's unified ATS
      API. JobMojito keeps a copy of the ATS jobs, applications and candidates,
      links each position to one ATS job, invites applicants who reach the
      trigger stage, and writes the outcome back. Links, notes and attachments
      are written only when the company switched them on
      (merchant.kombo_selected_result_actions); job fields are not copied into
      the position.


      | JobMojito field | Direction | External field | Notes |

      | --- | --- | --- | --- |

      | `merchant.kombo_integration_id, merchant.kombo_integration_tool` | Into
      JobMojito | `integration-created / integration-deleted webhook: data.id,
      data.tool` | Set when the ATS connection is created and cleared when it is
      deleted. |

      | `kombo_jobs.id, kombo_jobs.name` | Into JobMojito | `GET /ats/jobs: id,
      name (fallback title)` | Copied on every full or incremental sync of the
      jobs. |

      | `kombo_jobs.status` | Into JobMojito | `jobs.status,
      jobs.remote_deleted_at` | DRAFT becomes draft, CLOSED or ARCHIVED becomes
      archived, deleted in the ATS becomes deleted. |

      | `kombo_jobs.data` | Into JobMojito | `jobs.* (whole job object)` | Kept
      as received; the position's own fields are not overwritten from it. |

      | `position_def_set.kombo_parameters.kombo_job_id,
      interview_def_set.kombo_parameters.kombo_job_id` | Into JobMojito |
      `jobs.id` | Links a position or interview to one ATS job, chosen by the
      recruiter. |

      | `position_def_set.status, interview_def_set.status` | Into JobMojito |
      `jobs.status (closed, archived, deleted, reopened)` | Closing the job in
      the ATS archives the linked positions and interviews; reopening it
      restores their previous status. |

      | `kombo_parameters.kombo_stage_id` | Into JobMojito | `jobs.stages[].id
      matched against applications.current_stage_id` | An application entering
      this stage triggers the invitation or the pre-screening; applicants
      already in it are invited when the position is published. |

      | `ATS pipeline report (stage names and order)` | Into JobMojito |
      `jobs.stages[].id, name, index` | Read for the ATS pipeline report only. |

      | `kombo_applications.id, kombo_job_id, kombo_candidate_id, data` | Into
      JobMojito | `GET /ats/applications: id, job_id, candidate_id` | Copied on
      application sync; applications of closed or archived jobs are not
      imported. |

      | `kombo_applications.kombo_stage_id` | Into JobMojito |
      `applications.current_stage_id` | A stage change re-runs the invitation
      check for that application. |

      | `kombo_applications.status` | Into JobMojito | `applications.outcome
      (HIRED, DECLINED), remote_deleted_at` | Hired, declined or deleted
      applications are archived and receive no further invitations. |

      | `position_result.outcome, interview_result.outcome` | Into JobMojito |
      `applications.outcome` | Set to hired or declined when the ATS marks the
      linked application, while the outcome is still pending. |

      | `position_result.status, interview_result.status` | Into JobMojito |
      `applications.remote_deleted_at` | An application deleted in the ATS
      archives the linked application in JobMojito if nobody has decided yet. |

      | `kombo_candidates.id, data, status` | Into JobMojito | `GET
      /ats/candidates: candidates.*, remote_deleted_at` | Copied on candidate
      sync; a candidate deleted in the ATS is archived. |

      | `profile_interview.email, profile_interview.email_auth` | Into JobMojito
      | `candidates.email_addresses[0].email_address` | Finds or creates the
      candidate when the application reaches the trigger stage. |

      | `profile_interview.name` | Into JobMojito | `candidates.first_name +
      last_name` | Set when the candidate is created from the ATS. |

      | `profile_interview.phone_number` | Into JobMojito |
      `candidates.phone_numbers[0].phone_number` | Set when the candidate is
      created from the ATS. |

      | `kombo_candidates.profile_interview_id` | Into JobMojito |
      `candidates.id (matched by e-mail)` | Links the ATS candidate to the
      JobMojito candidate on invitation or pre-screening. |

      | `interview_file (type resume)` | Into JobMojito | `GET
      /ats/applications/{id}/attachments, then /ats/candidates/{id}/attachments:
      type CV (fallback OTHER)` | The CV from the ATS is imported when the
      candidate is invited or pre-screened. |

      | `interview_result_pre_screening (AI pre-screening input)` | Into
      JobMojito | `applications.screening_question_answers[] (question.title,
      answer)` | The candidate's answers to the ATS screening questions are part
      of the AI pre-screening. |

      | `interview_result_pre_screening.nationality, residency` | Into JobMojito
      | `candidates.location.country (fallback address.country)` | Taken from
      the ATS candidate during pre-screening. |

      | `kombo_applications.interview_result_id,
      interview_result_pre_screening_id` | Into JobMojito | `applications.id` |
      Set when the candidate's result is linked back to the ATS application. |

      | `kombo_tags, kombo_rejection_reasons, kombo_users, kombo_offers,
      kombo_interviews` | Into JobMojito | `GET /ats/tags,
      /ats/rejection-reasons, /ats/users, /ats/offers, /ats/interviews` | Kept
      in sync so recruiters can pick tags and rejection reasons; the others are
      stored only. |

      | `kombo_parameters.kombo_selected_stage_id (step:
      config.kombo.accept_stage_id)` | From JobMojito | `PUT
      /ats/applications/{id}/stage` | Moves the application when the recruiter
      selects the candidate; the position's stage is used on the last step. |

      | `kombo_parameters.kombo_sync_all_results_stage_id` | From JobMojito |
      `PUT /ats/applications/{id}/stage` | Every processed result is moved to
      this stage, only when sync all results is on. |

      | `kombo_parameters.kombo_rejected_reason_human_id,
      kombo_rejected_reason_ai_id (step: config.kombo.reject_reason_id)` | From
      JobMojito | `POST /ats/applications/{id}/reject { rejection_reason_id,
      note }` | Rejects the application when the recruiter rejects; nothing is
      sent when no reason is configured. |

      | `Rejection note (result link, score, AI feedback)` | From JobMojito |
      `reject.note` | The note sent with the rejection. |

      | `interview_result result link + interview_result.score` | From JobMojito
      | `POST /ats/applications/{id}/result-links { label, url,
      details.attributes }` | Sent when result links are switched on: a signed
      link to the result with its score. |

      | `interview_result note (result link + score)` | From JobMojito | `POST
      /ats/applications/{id}/notes` | Sent when notes are switched on and the
      recruiter has decided, or sync all results is on. |

      | `interview_result.pdf_export_url (interview PDF report)` | From
      JobMojito | `POST /ats/applications/{id}/attachments (type OTHER)` | Sent
      when attachments are switched on; the PDF is generated first if missing. |

      | `interview_result_pre_screening score, recommendation and analysis` |
      From JobMojito | `POST /ats/applications/{id}/notes` | Sent after every AI
      pre-screening and again when the recruiter decides on it. |

      | `Pre-screening PDF report` | From JobMojito | `POST
      /ats/applications/{id}/attachments (type OTHER)` | Uploaded when
      attachments are switched on. |

      | `interview_result.coach_status (progress note)` | From JobMojito | `POST
      /ats/applications/{id}/notes` | A note when the interview fails or the
      answers are collected, only when sync all results is on. |

      | `position_result_step decision and recruiter notes (meeting step)` |
      From JobMojito | `POST notes, PUT stage, POST reject` | Sends '<step>:
      passed / failed' with the recruiter's notes, then moves or rejects. |

      | `human_interview_request reason and outcome` | From JobMojito | `POST
      notes, PUT stage, POST reject` | Notes the request, moves on pass and
      rejects on fail or decline. |

      | `merchant.kombo_tag_assignment.result_weak / result_moderate /
      result_strong / result_exceptional` | From JobMojito | `POST
      /ats/candidates/{id}/tags` | Score tags on result sync: under 4 weak,
      under 7 moderate, under 8.5 strong, up to 10 exceptional. |

      | `merchant.kombo_tag_assignment.interview_selected / interview_rejected`
      | From JobMojito | `POST /ats/candidates/{id}/tags` | Decision tags on a
      recruiter decision; the selected tag only on the last step. |

      | `merchant.kombo_sync (manual sync)` | From JobMojito | `POST
      /force-sync` | Asks Kombo to sync the ATS again when the recruiter presses
      sync. |


      ### Webhooks


      JobMojito POSTs the same JSON payload for the events interview_result (the
      result is final and scored, sent again when a watched field changes),
      interview_collected (the candidate finished, before scoring) and
      interview_failed (failed, abandoned or no speech). Configure the URL,
      events and authentication headers per environment under Integrations >
      Custom integration; failed deliveries are retried and kept in the delivery
      history.


      | JobMojito field | Direction | External field | Notes |

      | --- | --- | --- | --- |

      | `interview_result.id` | From JobMojito | `id` | The result the event is
      about. |

      | `interview_result.question_set_id (interview_def_set.id)` | From
      JobMojito | `interview_id` | The interview definition. |

      | `interview_result.question_set_id (interview_def_set.id)` | From
      JobMojito | `question_set_id` | Same value as interview_id. |

      | `interview_result.status` | From JobMojito | `status` | active for
      interview_result, draft for the other two events. |

      | `interview_result.coach_status` | From JobMojito | `interview_status` |
      completed, failed, abandoned and so on. |

      | `interview_result.processing_status` | From JobMojito |
      `processing_status` | AI processing state. |

      | `interview_result.profile_interview_id` | From JobMojito |
      `profile_interview_id` | The candidate. |

      | `interview_result.profile_id` | From JobMojito | `profile_id` | The
      candidate's portal account, when there is one. |

      | `profile_interview.external_id` | From JobMojito |
      `candidate_external_id` | Your id for the candidate; present when a
      candidate is linked. |

      | `profile_interview.name` | From JobMojito | `candidate_name` | Present
      when a candidate is linked. |

      | `profile_interview.email` | From JobMojito | `candidate_email` | Present
      when a candidate is linked. |

      | `profile_interview.phone_number` | From JobMojito |
      `candidate_phone_number` | Present when a candidate is linked. |

      | `interview_result.recruiter_go_next_round` | From JobMojito |
      `recruiter_go_next_round` | The recruiter's decision; usually empty in
      interview_collected and interview_failed. |

      | `interview_result.ai_analysis` | From JobMojito | `ai_analysis` |
      Candidate-facing analysis, filled in interview_result. |

      | `interview_result.ai_analysis_recruiter` | From JobMojito |
      `ai_analysis_recruiter` | Recruiter-facing analysis, filled in
      interview_result. |

      | `interview_result.ai_analysis_other` | From JobMojito |
      `ai_analysis_other` | Session analyses by name, for example
      strengths_concerns. |

      | `interview_result.ai_analysis_other.strengths_concerns.strengths` | From
      JobMojito | `ai_analysis_recruiter_why_hire` | Deprecated copy kept for
      existing integrations. |

      | `interview_result.ai_analysis_other.strengths_concerns.concerns` | From
      JobMojito | `ai_analysis_recruiter_why_not_hire` | Deprecated copy kept
      for existing integrations. |

      | `interview_result.score_interview_ai` | From JobMojito |
      `ai_analysis_recruiter_score` | Recruiter-facing AI score, filled in
      interview_result. |

      | `interview_result.score` | From JobMojito | `score` | Overall score,
      filled in interview_result. |

      | `interview_result.pdf_export_url` | From JobMojito | `pdf_export_url` |
      When a PDF report is configured, interview_result waits until the PDF
      exists. |

      | `Changed fields of the result` | From JobMojito | `reason` | Which
      watched fields changed; 'manual re-trigger of ...' on a resend from the
      delivery history. |
paths:
  /portal-component-styles:
    get:
      tags:
        - Admin
      summary: Get the component style guide
      description: >-
        Everything needed to design a style for one kind of page block (hero,
        cards, faq, ...): the selectors each block renders, its layout variants,
        the CSS variables of the brand, and the styles the editor already offers
        per block type, each with the pages that use it. Read it before
        save_component_style. Style settings are switched on per company by
        JobMojito; while they are off this endpoint answers 403.
      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
            enum:
              - interview
              - consumer
            description: >-
              `interview` (career and interview portal) or `consumer` (coaching
              portal). Only the interview portal has brands.
            example: interview
          required: true
          name: portal
          in: query
        - schema:
            type: string
            format: uuid
            description: >-
              A sub-brand, from the brands document of get_portal_configuration.
              Leave it out for the main brand, the company's own, whose styles
              every sub-brand page also offers.
          required: false
          name: brand_id
          in: query
      responses:
        '200':
          description: The guide.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ComponentStyleGuide'
        '401':
          description: Missing or invalid access token.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: >-
            Not a merchant, merchant owner or admin token, not this company, or
            the switch is off.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: This brand does not exist.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '422':
          description: Validation error, or a brand on the coaching portal.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Server error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
        - bearerAuth: []
components:
  schemas:
    ComponentStyleGuide:
      type: object
      properties:
        portal:
          type: string
        brand:
          type: object
          nullable: true
          properties:
            id:
              type: string
            name:
              type: string
          required:
            - id
            - name
        file_rule:
          type: string
          description: Which files an agent writes and which it leaves alone.
        how_to:
          type: array
          items:
            type: string
          description: The steps from a design to a live style.
        shared_parts:
          type: array
          items:
            type: object
            properties:
              selector:
                type: string
                description: A selector or CSS variable.
              what:
                type: string
                description: What it is on the page.
            required:
              - selector
              - what
          description: On every block.
        tokens:
          type: array
          items:
            type: object
            properties:
              selector:
                type: string
                description: A selector or CSS variable.
              what:
                type: string
                description: What it is on the page.
            required:
              - selector
              - what
          description: >-
            CSS variables from the style settings; use them with a fallback,
            var(--jm-color-text, currentColor).
        tokens_css:
          type: object
          properties:
            main:
              type: string
            brand:
              type: string
              nullable: true
          required:
            - main
            - brand
          description: >-
            tokens.css as the draft style settings make it, for the main brand
            and the sub-brand.
        components:
          type: array
          items:
            type: object
            properties:
              type:
                type: string
                description: 'The block type: the `type` of a block in page content.'
                example: hero
              summary:
                type: string
              root:
                type: string
                description: The wrapper of every block of this type.
                example: .jm-site .jm-block--hero
              parts:
                type: array
                items:
                  type: object
                  properties:
                    selector:
                      type: string
                      description: A selector or CSS variable.
                    what:
                      type: string
                      description: What it is on the page.
                  required:
                    - selector
                    - what
                description: What the block renders that a style can aim at.
              variants:
                type: array
                items:
                  type: object
                  properties:
                    selector:
                      type: string
                      description: A selector or CSS variable.
                    what:
                      type: string
                      description: What it is on the page.
                  required:
                    - selector
                    - what
                description: Classes the block adds for its own layout choices.
              styles:
                type: array
                items:
                  type: object
                  properties:
                    name:
                      type: string
                      description: The name the editor shows.
                      example: Dark band
                    class:
                      type: string
                      description: The class a block with this style gets.
                      example: jm-style-dark-band
                    file:
                      type: string
                      description: The CSS file that defines it.
                      example: components/hero/dark-band.css
                    line:
                      type: integer
                    brand_id:
                      type: string
                      nullable: true
                      description: The brand whose file it is; null for the main brand.
                    written_by:
                      type: string
                      enum:
                        - agent
                        - company
                      description: >-
                        `agent`: in components/, which save_component_style may
                        change. `company`: in the company's own files, never
                        changed by it.
                    live:
                      type: boolean
                      description: Whether the published stylesheet already has it.
                    pages:
                      type: array
                      items:
                        type: object
                        properties:
                          id:
                            type: string
                            description: The page.
                          slug:
                            type: string
                            description: >-
                              Its address; built-in pages start with "_", the
                              home page is empty.
                            example: life-at-sea
                          title:
                            type: string
                            nullable: true
                            description: Its title in the first language.
                          brand_id:
                            type: string
                            nullable: true
                            description: Its sub-brand; null for the main brand.
                          published:
                            type: boolean
                            description: The published page uses the style.
                          draft:
                            type: boolean
                            description: The draft uses the style.
                        required:
                          - id
                          - slug
                          - title
                          - brand_id
                          - published
                          - draft
                      description: >-
                        The pages with a block that uses it, as draft or
                        published. A main-brand style counts every page; a
                        sub-brand style, that brand's pages.
                  required:
                    - name
                    - class
                    - file
                    - line
                    - brand_id
                    - written_by
                    - live
                    - pages
                description: The styles the editor already offers for this type.
            required:
              - type
              - summary
              - root
              - parts
              - variants
              - styles
      required:
        - portal
        - brand
        - file_rule
        - how_to
        - shared_parts
        - tokens
        - tokens_css
        - components
    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.