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

# List document favoriters

> <Note>
  This endpoint requires **Manager** or **Owner** permissions on the requested document.
</Note>

Lists users who have favorited a published document, paginated and sorted by `favoritedAt`.

Use this endpoint when you need to know "who favorited document X" — for example, a content-migration script that preserves favorites when replacing a document needs to call this once per document, rather than iterating every user in the organization.




## OpenAPI

````yaml /api/openapi.yaml get /v1/documents/{identifier}/favorites
openapi: 3.1.0
info:
  title: Omni API
  description: >
    The Omni REST API provides programmatic access to your Omni instance for
    managing users, documents, queries, schedules, and more.  
  version: 1.0.0
  contact:
    name: Omni Support
    url: https://docs.omni.co
servers:
  - url: https://{instance}.omniapp.co/api
    description: Production
    variables:
      instance:
        default: blobsrus
        description: Your production Omni instance subdomain
  - url: https://{instance}.playground.exploreomni.dev/api
    description: Playground
    variables:
      instance:
        default: blobsrus
        description: Your playground Omni instance subdomain
security:
  - bearerAuth: []
  - orgApiKey: []
tags:
  - name: AI
    description: AI-powered query generation
  - name: API Tokens
    description: >-
      Manage API tokens (Organization keys, Personal Access Tokens, MCP OAuth
      grants)
  - name: Connections
    description: Manage database connections
  - name: Connection environments
    description: Manage connection environments database connections
  - name: Content
    description: Unified content retrieval (documents and folders)
  - name: Content migration
    description: Export and import dashboards
  - name: Content validator
    description: Validate content against models and perform find/replace operations
  - name: Dashboard downloads
    description: Download dashboards and tiles as PDF, PNG, XLSX, CSV, or JSON files
  - name: Dashboard filters and controls
    description: Read and update dashboard filter and control default values
  - name: dbt
    description: Manage dbt configuration for connections
  - name: Documents
    description: Create, retrieve, and manage documents
  - name: Document favorites
    description: Favorite and unfavorite documents
  - name: Document labels
    description: Apply and manage labels on documents
  - name: Document permissions
    description: Manage document-level access
  - name: Labels
    description: >
      Manage labels in an organization. Labels can be applied to documents and
      folders to help organize and categorize content.


      **Label types:**

      - **Basic labels**: Can be created and managed by any user

      - **Verified labels**: Indicate curated or officially sanctioned content.
      Admin-only.

      - **Homepage labels**: Appear on the organization homepage. Admin-only.
  - name: Folders
    description: Create and organize content folders
  - name: Folder permissions
    description: Manage folder-level access
  - name: Jobs
    description: Check status of asynchronous jobs
  - name: Models
    description: Create and manage data models
  - name: Model branches
    description: Manage model branches and merge changes
  - name: Model git configuration
    description: Manage git configuration for shared models
  - name: Queries
    description: Execute workbook queries
  - name: Schedules
    description: Create and manage scheduled tasks
  - name: Schedule recipients
    description: Manage schedule recipients
  - name: Schema refresh schedules
    description: Manage automated schema refresh schedules for connections
  - name: Topics
    description: Retrieve topic information from models
  - name: Uploads
    description: Manage file uploads
  - name: Users
    description: Manage users
  - name: User attributes
    description: Manage user attribute definitions
  - name: User groups
    description: Manage user groups
  - name: User model roles
    description: Manage model and connection role assignments for users
  - name: User group model roles
    description: Manage model and connection role assignments for user groups
  - name: Uploads
    description: Manage CSV and spreadsheet uploads
paths:
  /v1/documents/{identifier}/favorites:
    get:
      tags:
        - Document favorites
      summary: List document favoriters
      description: >
        <Note>
          This endpoint requires **Manager** or **Owner** permissions on the requested document.
        </Note>


        Lists users who have favorited a published document, paginated and
        sorted by `favoritedAt`.


        Use this endpoint when you need to know "who favorited document X" — for
        example, a content-migration script that preserves favorites when
        replacing a document needs to call this once per document, rather than
        iterating every user in the organization.
      operationId: listDocumentFavoriters
      parameters:
        - name: identifier
          in: path
          required: true
          schema:
            type: string
          description: Document identifier (either document ID or slug).
        - name: cursor
          in: query
          required: false
          schema:
            type: string
            nullable: true
          description: >-
            Page cursor from a previous response's `nextCursor`. Omit for the
            first page.
        - name: pageSize
          in: query
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 100
            default: 20
          description: Number of items per page (min 1, max 100).
        - name: sortDirection
          in: query
          required: false
          schema:
            type: string
            enum:
              - asc
              - desc
            default: asc
          description: >-
            Sort direction by `favoritedAt`. `asc` returns oldest favorites
            first; `desc` returns newest first.
      responses:
        '200':
          description: Successfully retrieved list of users who favorited the document
          content:
            application/json:
              schema:
                type: object
                properties:
                  pageInfo:
                    $ref: '#/components/schemas/PageInfo'
                  records:
                    type: array
                    items:
                      type: object
                      properties:
                        userId:
                          type: string
                          description: Membership ID of the favoriting user.
                        name:
                          type: string
                          description: User's display name.
                        email:
                          type: string
                          description: User's email address.
                        favoritedAt:
                          type: string
                          format: date-time
                          description: >-
                            ISO 8601 timestamp recording when the user favorited
                            the document.
                      required:
                        - userId
                        - name
                        - email
                        - favoritedAt
                required:
                  - pageInfo
                  - records
              examples:
                basicResponse:
                  summary: Basic request with 2 favoriters
                  value:
                    pageInfo:
                      hasNextPage: false
                      nextCursor: null
                      pageSize: 20
                      totalRecords: 2
                    records:
                      - userId: f1c2a3e4-1111-1111-1111-111111111111
                        name: Blob Ross
                        email: blob.ross@eblobsrus.com
                        favoritedAt: '2026-04-12T10:14:02.000Z'
                      - userId: f1c2a3e4-2222-2222-2222-222222222222
                        name: Blob the Builder
                        email: blob.the.builder@blobsrus.com
                        favoritedAt: '2026-05-01T17:33:21.000Z'
                emptyResponse:
                  summary: Document with no favoriters
                  value:
                    pageInfo:
                      hasNextPage: false
                      nextCursor: null
                      pageSize: 20
                      totalRecords: 0
                    records: []
        '400':
          description: |
            Bad Request. Invalid query parameters.

            Possible causes:
            - Unparseable cursor
            - Out-of-range `pageSize` (must be 1-100)
            - Invalid `sortDirection` (must be `asc` or `desc`)
            - Unknown query parameter
          content:
            application/json:
              schema:
                type: object
                properties:
                  detail:
                    type: string
                  status:
                    type: integer
              examples:
                invalidCursor:
                  summary: Invalid cursor
                  value:
                    detail: 'Invalid cursor: not-a-number'
                    status: 400
                invalidPageSize:
                  summary: Page size out of range
                  value:
                    detail: pageSize must be between 1 and 100
                    status: 400
                unknownParam:
                  summary: Unknown query parameter
                  value:
                    detail: 'Unrecognized key: random_bogus_param'
                    status: 400
        '401':
          description: Missing authentication
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: |
            Forbidden. Possible causes:
            - Caller lacks `MANAGER` permission on the document
            - Used a user-scoped (personal access token) API key
          content:
            application/json:
              schema:
                type: object
                properties:
                  detail:
                    type: string
                  status:
                    type: integer
              examples:
                insufficientPermission:
                  summary: Insufficient permission on document
                  value:
                    detail: You do not have permission to manage document access.
                    status: 403
                userScopedKey:
                  summary: User-scoped API key not allowed
                  value:
                    detail: >-
                      User-scoped API keys are not allowed to list document
                      favoriters
                    status: 403
        '404':
          description: Document not found (or unpublished)
          content:
            application/json:
              schema:
                type: object
                properties:
                  detail:
                    type: string
                  status:
                    type: integer
              examples:
                notFound:
                  summary: Document not found
                  value:
                    detail: Document with identifier "does-not-exist" not found
                    status: 404
        '405':
          $ref: '#/components/responses/MethodNotAllowed'
        '429':
          $ref: '#/components/responses/TooManyRequests'
      security:
        - orgApiKey: []
components:
  schemas:
    PageInfo:
      type: object
      description: Pagination information for paginated responses.
      properties:
        hasNextPage:
          type: boolean
          description: Indicates if there are more records available.
        nextCursor:
          type: string
          nullable: true
          description: Cursor for the next page of results. `null` if no more results.
        pageSize:
          type: integer
          description: Number of records per page.
        totalRecords:
          type: integer
          description: Total number of records matching the query.
    Error:
      type: object
      properties:
        error:
          type: string
          description: HTTP response code for the error
          example: <response_code>
        message:
          type: string
          description: Detailed error description
          example: <error_reason>
  responses:
    MethodNotAllowed:
      description: Method Not Allowed - Invalid HTTP method for this endpoint
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    TooManyRequests:
      description: Too Many Requests - Rate limit exceeded (60 requests/minute)
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >
        Can be either an [Organization API
        Key](/api/authentication#organization-api-keys) or [Personal Access
        Token (PAT)](/api/authentication#personal-access-tokens-pat).


        Include in the `Authorization` header as: `Bearer YOUR_TOKEN`
    orgApiKey:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >
        Requires an [Organization API
        Key](/api/authentication#organization-api-keys). Personal Access Tokens
        (PATs) are not supported for this endpoint.


        Include in the `Authorization` header as: `Bearer ORGANIZATION_API_KEY`

````