v4

latestOpenAPI 3.1.02026-08-01207318738.7 KB

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

Path parameters

identifierstring required

Document identifier (either document ID or identifier slug)

Example:abc123

Document identifier (either document ID or identifier slug)

Query parameters

cursorstring

Cursor for pagination (from previous response nextCursor)

Example:eyJpZCI6IjEyMzQ1In0

Cursor for pagination (from previous response nextCursor)

pageSizeinteger

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

Example:20

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

sortDirection'asc' | 'desc'

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

Example:desc

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

Response

Paginated list of users who favorited the document