Shares
List Share Links For Document
Returns the (at most one) share link for a document, offset-paginated for shape consistency with other list endpoints.
X-API-Key<token>
Your personal API key — vw_ followed by 64 hex characters. The same key is also accepted
as Authorization: Bearer vw_....
In: header
Path Parameters
documentId*string
Query Parameters
limit?integer
Range
1 <= value <= 50Default
20offset?integer
Range
0 <= valueDefault
0Response Body
application/json
application/json
curl -X GET "https://example.com/api/v1/shares/documents/string"{ "success": true, "message": "string", "data": { "items": [ { "id": "string", "userId": "string", "documentId": "string", "slug": "string", "token": "string", "username": "string", "documentSlug": "string", "publicPath": "string", "snapshot": {}, "hasPassword": true, "expiresAt": "2019-08-24T14:15:22Z", "viewCount": 0, "lastViewedAt": "2019-08-24T14:15:22Z", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z" } ], "total": 0, "limit": 0, "offset": 0, "page": 0, "pageSize": 0, "totalPages": 0, "hasMore": true, "pagination": { "mode": "offset", "nextOffset": 0, "nextCursor": "string" } }}List Shared Document IDsGET
Given a comma-separated list of document IDs, returns which of them currently have an active (non-expired) share link. Useful for badging a document list in the UI.
Revoke Share LinkDELETE
Deletes the share link, immediately breaking its public URL. `data` is `null` on success. Requires the `resume:write` scope when called with an API key.