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

# Shortlisted Creators

> Every creator on the workspace's shortlist, for the Partnership Briefs tab, whatever their citations or metrics in the period: profile, Influence Score and metrics over the trailing month (the last known snapshot, flagged is_stale, when none was captured in it), cited and analysed video counts with up to three thumbnails, the creator's partnership briefs, and whether the creator can be removed from the shortlist. Narrow with brief_status and search_query; counts gives the tab totals under search_query. Sorted by most recently added by default.



## OpenAPI

````yaml https://openapi.shareofmodel.ai/swagger-sos.json get /v1/organizations/{organization_id}/workspaces/{workspace_id}/search/shortlist
openapi: 3.0.3
info:
  title: Share Of Model API
  version: v1
  description: >-
    ## Search



    The Share of Search API provides visibility, presence, and ranking metrics
    for tracked

    search and AI engine sources. Use it to analyse how a project performs
    across keywords,

    thematics, competitors, and ranked URLs over time.


    For the previous version of the API, see the [v1
    documentation](https://api.shareofsearch.jplus.io/docs/v1).
servers:
  - description: Search - Production API
    url: https://api.shareofsearch.jplus.io/
security: []
tags:
  - name: Projects
    description: >-
      Manage analyses (projects) within a workspace. Create new analyses and
      list existing ones.
  - name: Collects
    description: >-
      Access data collection runs and their raw results. List collect runs for
      an analysis, or retrieve the raw data captured during each run: domain
      rankings, brand mentions, keyword insights, and LLM/SERP responses.
  - name: Overview Metrics
    description: >-
      High-level, aggregated metrics that summarise the overall performance of
      an analysis. Use these endpoints to get a quick picture of visibility,
      presence, andranking across all keywords and sources.
  - name: Metrics
    description: >-
      Detailed, per-entity metrics for deep-diving into specific aspects of an
      analysis. Break down performance by domain, brand, keyword, URL, or
      competitor.
  - name: Insights
    description: >-
      Cross-project KPIs aggregated at the workspace or organization level.
      These endpoints consolidate metrics from all active projects within a
      workspace, or across every workspace of an organization, to provide a
      unified view of visibility, mentions, citations, sentiment, and ranking.
  - name: Shopping
    description: >-
      Shopping-specific metrics for analyses that track product listings in
      shopping engines. Measure product visibility, pricing, merchant coverage,
      and share of shelf across all tracked keywords and sources.
  - name: Ads
    description: >-
      Sponsored-ad performance across tracked prompts and engines, including
      coverage, advertiser diversity, brand presence, and share of ad voice.
  - name: Creators
    description: >-
      YouTube creators cited as sources in AI-engine search results, enriched
      with channel metrics and an Influence Score. Browse creators across every
      project in a workspace, narrowed by country, engine, brand, category,
      analysis, and persona filters.
  - name: Video Analyses
    description: >-
      On-demand LLM analysis of an already-cited YouTube video: why it works as
      a citation source, the brands it treats, and an internal creator
      pre-brief. Price a selection before committing to it, trigger the
      analyses, and read the results.
  - name: Creator Briefs
    description: >-
      Partnership briefs written for shortlisted YouTube creators: a markdown
      document with its brand context, saved and edited by the user, with one
      version recorded per save and the diff into each version stored at write
      time.
  - name: CSV Export
    description: >-
      Generic CSV export gateway shared across features. `export_type` selects
      which dataset to export; each feature registers its own export types and
      usecases on the same CsvExportUsecase base rather than duplicating the
      CSV-writing/validation mechanics.
paths:
  /v1/organizations/{organization_id}/workspaces/{workspace_id}/search/shortlist:
    get:
      tags:
        - Creators
      summary: Shortlisted Creators
      description: >-
        Every creator on the workspace's shortlist, for the Partnership Briefs
        tab, whatever their citations or metrics in the period: profile,
        Influence Score and metrics over the trailing month (the last known
        snapshot, flagged is_stale, when none was captured in it), cited and
        analysed video counts with up to three thumbnails, the creator's
        partnership briefs, and whether the creator can be removed from the
        shortlist. Narrow with brief_status and search_query; counts gives the
        tab totals under search_query. Sorted by most recently added by default.
      operationId: list_shortlisted_creators
      parameters:
        - name: organization_id
          in: path
          required: true
          schema:
            type: string
            title: Organization Id
        - name: workspace_id
          in: path
          required: true
          schema:
            type: string
            title: Workspace Id
        - name: page
          in: query
          required: false
          schema:
            type: integer
            minimum: 1
            default: 1
            title: Page
        - name: page_size
          in: query
          required: false
          schema:
            type: integer
            maximum: 100
            minimum: 1
            default: 20
            title: Page Size
        - name: brief_status
          in: query
          required: false
          schema:
            allOf:
              - $ref: '#/components/schemas/ShortlistBriefStatus'
            nullable: true
            description: Keep only the creators with, or without, a partnership brief.
            title: Brief Status
          description: Keep only the creators with, or without, a partnership brief.
        - name: search_query
          in: query
          required: false
          schema:
            type: string
            nullable: true
            description: Case-insensitive substring match on display_name or handle.
            title: Search Query
          description: Case-insensitive substring match on display_name or handle.
        - name: sort_column
          in: query
          required: false
          schema:
            allOf:
              - $ref: '#/components/schemas/ShortlistSortColumn'
            nullable: true
            title: Sort Column
        - name: sort_direction
          in: query
          required: false
          schema:
            allOf:
              - $ref: '#/components/schemas/CreatorSortDirection'
            nullable: true
            title: Sort Direction
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ShortlistedCreatorsResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - HTTPBearer: []
components:
  schemas:
    ShortlistBriefStatus:
      type: string
      enum:
        - with_brief
        - without_brief
      title: ShortlistBriefStatus
    ShortlistSortColumn:
      type: string
      enum:
        - added_at
        - display_name
        - influence_score
      title: ShortlistSortColumn
    CreatorSortDirection:
      type: string
      enum:
        - asc
        - desc
      title: CreatorSortDirection
    ShortlistedCreatorsResponse:
      properties:
        data:
          items:
            $ref: '#/components/schemas/ShortlistedCreatorResponse'
          type: array
          title: Data
          description: Items for the current page.
        pagination:
          allOf:
            - $ref: '#/components/schemas/Pagination'
          description: Pagination metadata.
        counts:
          allOf:
            - $ref: '#/components/schemas/ShortlistCountsResponse'
          description: >-
            Shortlisted creators matching search_query, whatever brief_status:
            the tab counts.
      type: object
      required:
        - data
        - pagination
        - counts
      title: ShortlistedCreatorsResponse
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ShortlistedCreatorResponse:
      properties:
        shortlist_id:
          type: string
          title: Shortlist Id
          description: The DELETE /shortlist/{shortlist_id} path id.
        added_at:
          type: string
          format: date-time
          title: Added At
          description: When the creator was shortlisted.
        added_by:
          type: string
          title: Added By
          description: Id of the user who shortlisted the creator.
        creator:
          $ref: '#/components/schemas/ShortlistedCreatorProfileResponse'
        videos:
          $ref: '#/components/schemas/ShortlistedCreatorVideosResponse'
        briefs:
          items:
            $ref: '#/components/schemas/ShortlistedCreatorBriefResponse'
          type: array
          title: Briefs
          description: >-
            The creator's partnership briefs in the workspace, newest first. At
            most one for now.
        can_remove_from_shortlist:
          type: boolean
          title: Can Remove From Shortlist
          description: >-
            False while the creator has a brief: removing it from the shortlist
            answers 409.
      type: object
      required:
        - shortlist_id
        - added_at
        - added_by
        - creator
        - videos
        - briefs
        - can_remove_from_shortlist
      title: ShortlistedCreatorResponse
    Pagination:
      properties:
        page:
          type: integer
          title: Page
          description: Current page number (1-based).
        page_size:
          type: integer
          title: Page Size
          description: Maximum number of items returned per page.
        total:
          type: integer
          title: Total
          description: Total number of items matching the query, across all pages.
      type: object
      required:
        - page
        - page_size
        - total
      title: Pagination
    ShortlistCountsResponse:
      properties:
        all:
          type: integer
          title: All
        with_brief:
          type: integer
          title: With Brief
        without_brief:
          type: integer
          title: Without Brief
      type: object
      required:
        - all
        - with_brief
        - without_brief
      title: ShortlistCountsResponse
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
    ShortlistedCreatorProfileResponse:
      properties:
        id:
          type: string
          title: Id
        youtube_channel_id:
          type: string
          title: Youtube Channel Id
        display_name:
          type: string
          nullable: true
          title: Display Name
        handle:
          type: string
          nullable: true
          title: Handle
        channel_url:
          type: string
          nullable: true
          title: Channel Url
        thumbnail_url:
          type: string
          nullable: true
          title: Thumbnail Url
        country:
          type: string
          nullable: true
          title: Country
        channel_type:
          type: string
          nullable: true
          title: Channel Type
        channel_attributes:
          items:
            type: string
          type: array
          nullable: true
          title: Channel Attributes
        tier_type:
          allOf:
            - $ref: '#/components/schemas/CreatorTierType'
          nullable: true
          description: >-
            Creator tier derived from subscriber_count. None when it is
            unavailable.
        influence_score:
          allOf:
            - $ref: '#/components/schemas/Metric'
          description: >-
            Influence Score over the trailing month, as the Creator List shows
            it by default; 0 when the creator was not cited in that window.
        subscriber_count:
          allOf:
            - $ref: '#/components/schemas/Metric'
          nullable: true
        channel_video_count:
          allOf:
            - $ref: '#/components/schemas/Metric'
          nullable: true
          description: >-
            Videos on the channel, from the resolved snapshot. Not the Creator
            List's video_count, which counts cited videos.
        last_updated_at:
          type: string
          format: date-time
          nullable: true
          title: Last Updated At
          description: Captured-at timestamp of the resolved metrics snapshot.
        is_stale:
          type: boolean
          title: Is Stale
          description: >-
            True when no snapshot was captured in the trailing month and the
            metrics come from the creator's last known snapshot.
      type: object
      required:
        - id
        - youtube_channel_id
        - influence_score
        - is_stale
      title: ShortlistedCreatorProfileResponse
    ShortlistedCreatorVideosResponse:
      properties:
        total_count:
          type: integer
          title: Total Count
          description: >-
            Distinct videos of the creator cited in the workspace's results, all
            time.
        analyzed_count:
          type: integer
          title: Analyzed Count
          description: Those with a completed analysis in the workspace.
        preview:
          items:
            $ref: '#/components/schemas/ShortlistedCreatorVideoPreviewResponse'
          type: array
          title: Preview
          description: >-
            Up to three of them, analysed first, then most recently cited. The
            rest is total_count minus the preview length.
      type: object
      required:
        - total_count
        - analyzed_count
        - preview
      title: ShortlistedCreatorVideosResponse
    ShortlistedCreatorBriefResponse:
      properties:
        id:
          type: string
          title: Id
        title:
          type: string
          title: Title
        brand:
          type: string
          title: Brand
        country:
          type: string
          title: Country
        category:
          type: string
          title: Category
        current_sequence:
          type: integer
          title: Current Sequence
        created_at:
          type: string
          format: date-time
          title: Created At
        updated_at:
          type: string
          format: date-time
          title: Updated At
      type: object
      required:
        - id
        - title
        - brand
        - country
        - category
        - current_sequence
        - created_at
        - updated_at
      title: ShortlistedCreatorBriefResponse
    CreatorTierType:
      type: string
      enum:
        - Nano
        - Micro
        - Mid-Tier
        - Macro
      title: CreatorTierType
    Metric:
      properties:
        value:
          type: number
          title: Value
          description: Current value for the selected period.
        prev_value:
          type: number
          nullable: true
          title: Prev Value
          description: >-
            Value for the previous comparable period. Null when no comparison
            period is available.
        unit:
          type: string
          nullable: true
          title: Unit
          description: >-
            Unit of the metric (e.g. '%', 'ms'). Null when the value is
            dimensionless.
      type: object
      required:
        - value
      title: Metric
    ShortlistedCreatorVideoPreviewResponse:
      properties:
        creator_video_id:
          type: string
          title: Creator Video Id
        title:
          type: string
          nullable: true
          title: Title
        thumbnail_url:
          type: string
          nullable: true
          title: Thumbnail Url
        video_analysis_id:
          type: string
          nullable: true
          title: Video Analysis Id
          description: The completed analysis of the video in the workspace, if any.
      type: object
      required:
        - creator_video_id
      title: ShortlistedCreatorVideoPreviewResponse
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer

````

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