v1

latestOpenAPI 3.1.02026-07-2618690613.4 KB
Document favorites

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.

get/v1/documents/{documentId}/favorites

Path parameters

identifierstring required

Document identifier (either document ID or slug).

Query parameters

cursorstring nullable

Page cursor from a previous response's nextCursor. Omit for the first page.

pageSizeinteger

Number of items per page (min 1, max 100).

sortDirection'asc' | 'desc'

Sort direction by favoritedAt. asc returns oldest favorites first; desc returns newest first.

Response

Successfully retrieved list of users who favorited the document