OMomniapp
Documents

List users who favorited the document

Lists users who have favorited the document, paginated and sorted by favoritedAt. Document-centric counterpart to GET /api/v1/documents?include=onlyFavorites: useful for migration scripts that need to preserve favorites when replacing documents, without iterating every user in the organization.

get/api/v1/documents/{identifier}/favorites

Request

  • Base URL
    https://omniapp.co (the document declares no server; this is the origin it was published from)
  • URL
    https://omniapp.co/api/v1/documents/{identifier}/favorites
  • Auth
    HTTP bearer

Path parameters

identifierstring required

Document identifier (either document ID or identifier slug)

Example:abc123

Query parameters

cursorstring

Cursor for pagination (from previous response nextCursor)

Example:eyJpZCI6IjEyMzQ1In0
pageSizeinteger

Number of results per page (1-100, integer)

Example:20
sortDirection'asc' | 'desc'

Sort direction by favoritedAt (default: asc — oldest first)

Example:desc

Response

Paginated list of users who favorited the document

Changes

No recorded changes to this operation across all 97 revisions of this API.