Documents
List Documents
Lists the authenticated user's documents (resumes, cover letters, portfolios, link-in-bio pages), optionally filtered by type. Soft-deleted documents are excluded.
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
Query Parameters
type?string
Filter documents by type.
Value in
- "RESUME"
- "COVER_LETTER"
- "PORTFOLIO"
- "LINK_IN_BIO"
Response Body
application/json
application/json
application/json
curl -X GET "https://example.com/api/v1/documents"{ "success": true, "message": "Documents fetched successfully", "data": [ { "id": "doc_123", "userId": "user_123", "type": "RESUME", "title": "My Resume", "slug": "my-resume", "tags": [], "content": {}, "metadata": {}, "templateId": "modern", "schemaVersion": 1, "revision": 1, "visibility": "PRIVATE", "lastSyncedAt": "2026-04-20T10:00:00.000Z", "createdAt": "2026-04-01T10:00:00.000Z", "updatedAt": "2026-04-20T10:00:00.000Z", "deletedAt": null } ]}Documents
CRUD for resumes, cover letters, portfolios, and link-in-bio pages.
Create DocumentPOST
Creates a new document. If no `content` is provided for a RESUME or COVER_LETTER, it is auto-seeded from the user's MasterProfile (when one exists). Free-tier users are limited to 1 active document per type; upgrading removes that limit.