GET
/v1/roadmappublicimplementedAPI roadmap
Returns the canonical machine-readable API contract used by the developer roadmap page.
Auth:
noneAPI Reference · v1
Build careers on the Resumez API
A REST API for the career graph, artifacts, scoring, and AI tailoring. Read the example payloads, then switch to Try it to send real requests against the sandbox.
BASE https://api.resumez.ai/v164 of 69 endpoints implemented
Meta
2 endpointsGET
/v1/openapi.jsonpublicimplementedOpenAPI document
Returns the generated OpenAPI 3.1 contract for stable API consumers.
Auth:
noneIdentity
1 endpointGET
/v1/meimplementedCurrent principal
Returns the authenticated user, token kind, and granted scopes.
Auth:
oauth_user_or_clientScopes:profile:readOrganizations
3 endpointsGET
/v1/organizationsimplementedList organizations
Lists shared, deduplicated organizations (employers, schools).
Auth:
oauth_user_or_clientScopes:catalog:readGET
/v1/organizations/{organizationId}implementedGet organization
Returns a single shared organization.
Auth:
oauth_user_or_clientScopes:catalog:readPOST
/v1/organizationsimplementedFind or create organization
Links an existing organization or creates one by natural key (name/domain).
Auth:
oauth_userScopes:catalog:writeSkills
3 endpointsGET
/v1/skillsimplementedList skills
Lists shared skill taxonomy nodes.
Auth:
oauth_user_or_clientScopes:catalog:readGET
/v1/skills/{skillId}implementedGet skill
Returns a single shared skill taxonomy node.
Auth:
oauth_user_or_clientScopes:catalog:readPOST
/v1/skillsimplementedFind or create skill
Links an existing skill or creates one by natural key (name).
Auth:
oauth_userScopes:catalog:writeRoles
2 endpointsGET
/v1/rolesimplementedList roles
Lists normalized role/title taxonomy nodes.
Auth:
oauth_user_or_clientScopes:catalog:readGET
/v1/roles/{roleId}implementedGet role
Returns a single normalized role/title.
Auth:
oauth_user_or_clientScopes:catalog:readCanonical Profile
2 endpointsGET
/v1/profileimplementedGet career profile
Returns the canonical career profile aggregate with links to its collections.
Auth:
oauth_userScopes:profile:readPATCH
/v1/profileimplementedUpdate career profile
Updates top-level profile identity, preferences, and visibility.
Auth:
oauth_userScopes:profile:writeExperiences
6 endpointsGET
/v1/experiencesimplementedList experiences
Lists the caller's work, education, project, and volunteer experiences.
Auth:
oauth_userScopes:profile:readPOST
/v1/experiencesimplementedCreate experience
Adds an experience that references an Organization and Skills.
Auth:
oauth_userScopes:profile:writeGET
/v1/experiences/{experienceId}implementedGet experience
Returns a single experience with organization and skill references.
Auth:
oauth_userScopes:profile:readPATCH
/v1/experiences/{experienceId}implementedUpdate experience
Updates an experience and its references.
Auth:
oauth_userScopes:profile:writeDELETE
/v1/experiences/{experienceId}implementedDelete experience
Removes an experience from the profile.
Auth:
oauth_userScopes:profile:writeGET
/v1/experiences/{experienceId}/achievementsimplementedList experience achievements
Lists achievements composed under a single experience.
Auth:
oauth_userScopes:profile:readEducations
2 endpointsGET
/v1/educationsimplementedList educations
Lists the caller's education records.
Auth:
oauth_userScopes:profile:readPOST
/v1/educationsimplementedCreate education
Adds an education record referencing a school Organization.
Auth:
oauth_userScopes:profile:writeProjects
2 endpointsGET
/v1/projectsimplementedList projects
Lists the caller's projects.
Auth:
oauth_userScopes:profile:readPOST
/v1/projectsimplementedCreate project
Adds a project referencing Skills.
Auth:
oauth_userScopes:profile:writeAchievements
2 endpointsGET
/v1/achievementsimplementedList achievements
Lists quantified achievements that can become resume bullets.
Auth:
oauth_userScopes:profile:readPOST
/v1/achievementsimplementedCreate achievement
Adds a quantified achievement referencing an Experience and Skills.
Auth:
oauth_userScopes:profile:writeSkill Claims
2 endpointsGET
/v1/skill-claimsimplementedList skill claims
Lists the caller's skill claims (proficiency/evidence) referencing shared Skills.
Auth:
oauth_userScopes:profile:readPOST
/v1/skill-claimsimplementedCreate skill claim
Claims a shared Skill with proficiency and evidence.
Auth:
oauth_userScopes:profile:writeArtifacts
5 endpointsGET
/v1/artifactsimplementedList artifacts
Lists generated resumes, cover letters, bios, and recruiter briefs.
Auth:
oauth_userScopes:artifacts:readGET
/v1/artifacts/{artifactId}implementedGet artifact
Returns a single artifact (mutable head).
Auth:
oauth_userScopes:artifacts:readPATCH
/v1/artifacts/{artifactId}implementedUpdate artifact
Edits artifact content or metadata; a content change snapshots a new immutable version.
Auth:
oauth_userScopes:artifacts:writeGET
/v1/artifacts/{artifactId}/versionsimplementedList artifact versions
Lists immutable version snapshots of an artifact.
Auth:
oauth_userScopes:artifacts:readGET
/v1/artifact-versions/{versionId}implementedGet artifact version
Returns a single immutable artifact version (the unit referenced by submissions).
Auth:
oauth_userScopes:artifacts:readGeneration
1 endpointPOST
/v1/artifacts:generateimplementedGenerate artifact
Generates an artifact from the canonical profile and target constraints.
Auth:
oauth_userScopes:ai:generateartifacts:writeExports
1 endpointPOST
/v1/profile:exportimplementedExport profile
Exports the canonical profile as JSON Resume, Markdown, or ATS text.
Auth:
oauth_userScopes:profile:readartifacts:exportJobs
7 endpointsGET
/v1/jobsimplementedList jobs
Lists saved job postings.
Auth:
oauth_userScopes:applications:readPOST
/v1/jobsimplementedCreate job
Saves a job posting referencing an Organization, Skills, and Role.
Auth:
oauth_userScopes:applications:writeGET
/v1/jobs/{jobId}implementedGet job
Returns a single job posting.
Auth:
oauth_userScopes:applications:readPOST
/v1/jobs:parsepartialParse job description
Extracts role, skills, seniority, and keywords from a job description.
Auth:
oauth_user_or_clientScopes:jobs:analyzePOST
/v1/jobs/{jobId}:matchimplementedMatch profile to job
Scores profile fit against a job and highlights strong and missing signals.
Auth:
oauth_userScopes:profile:readjobs:analyzePOST
/v1/jobs/{jobId}:tailorpartialTailor artifacts to job
Drafts tailored resume, cover letter, and recruiter brief for a job.
Auth:
oauth_userScopes:profile:readai:generateartifacts:writePOST
/v1/jobs/{jobId}:gap-analysisimplementedAnalyze profile gaps
Identifies missing evidence, skills, and signals for a target job.
Auth:
oauth_userScopes:profile:readjobs:analyzeApplications
6 endpointsGET
/v1/applicationsimplementedList applications
Lists tracked job applications across the pipeline.
Auth:
oauth_userScopes:applications:readPOST
/v1/applicationsimplementedCreate application
Starts tracking an application for a linked or new Job.
Auth:
oauth_userScopes:applications:writeGET
/v1/applications/{applicationId}implementedGet application
Returns an application with stage, links, and activity.
Auth:
oauth_userScopes:applications:readPOST
/v1/applications/{applicationId}:advanceimplementedAdvance application stage
Moves the application to the next pipeline stage.
Auth:
oauth_userScopes:applications:writePOST
/v1/applications/{applicationId}:withdrawimplementedWithdraw application
Withdraws the application from the pipeline.
Auth:
oauth_userScopes:applications:writeGET
/v1/applications/{applicationId}/eventsimplementedList application events
Returns the append-only activity timeline for an application.
Auth:
oauth_userScopes:applications:readSubmissions
3 endpointsGET
/v1/applications/{applicationId}/submissionsimplementedList submissions
Lists immutable submission records for an application.
Auth:
oauth_userScopes:applications:readPOST
/v1/applications/{applicationId}/submissionsimplementedCreate submission
Records an immutable, idempotent submission referencing artifact versions.
Auth:
oauth_userScopes:applications:writeGET
/v1/submissions/{submissionId}implementedGet submission
Returns a single immutable submission.
Auth:
oauth_userScopes:applications:readInterviews
3 endpointsGET
/v1/interviewsimplementedList interviews
Lists scheduled and past interviews.
Auth:
oauth_userScopes:applications:readPOST
/v1/interviewsimplementedCreate interview
Schedules an interview for an application.
Auth:
oauth_userScopes:applications:writeGET
/v1/interviews/{interviewId}implementedGet interview
Returns a single interview.
Auth:
oauth_userScopes:applications:readOffers
4 endpointsGET
/v1/offersimplementedList offers
Lists offers across applications.
Auth:
oauth_userScopes:applications:readPOST
/v1/offersimplementedCreate offer
Records an offer for an application.
Auth:
oauth_userScopes:applications:writePOST
/v1/offers/{offerId}:acceptimplementedAccept offer
Accepts an offer (state transition).
Auth:
oauth_userScopes:applications:writePOST
/v1/offers/{offerId}:declineimplementedDecline offer
Declines an offer (state transition).
Auth:
oauth_userScopes:applications:writeReminders
2 endpointsGET
/v1/remindersimplementedList reminders
Lists the caller's reminders.
Auth:
oauth_userScopes:applications:readPOST
/v1/remindersimplementedCreate reminder
Creates a time-anchored reminder for a subject.
Auth:
oauth_userScopes:applications:writeContacts
2 endpointsGET
/v1/contactsimplementedList contacts
Lists people (recruiters, hiring managers, referrers).
Auth:
oauth_userScopes:applications:readPOST
/v1/contactsimplementedCreate contact
Adds a contact linked to an Organization.
Auth:
oauth_userScopes:applications:writeNotes
2 endpointsGET
/v1/notesimplementedList notes
Lists the caller's notes, optionally filtered by subject via ?subjectType & ?subjectId.
Auth:
oauth_userScopes:applications:readPOST
/v1/notesimplementedCreate note
Adds a free-text note attached to a polymorphic subject.
Auth:
oauth_userScopes:applications:writeAttachments
2 endpointsGET
/v1/attachmentsimplementedList attachments
Lists the caller's file attachments, optionally filtered by subject.
Auth:
oauth_userScopes:applications:readPOST
/v1/attachmentsimplementedCreate attachment
Records metadata for a stored file (R2 reference) linked to an optional subject.
Auth:
oauth_userScopes:applications:writeOperations
1 endpointGET
/v1/operations/{operationId}implementedGet operation
Returns the status and result references for an async operation.
Auth:
oauth_user_or_clientScopes:operations:readImports
1 endpointPOST
/v1/importsstubbedImport career data
Parses a resume, plaintext, or JSON into reviewable profile changes.
Auth:
oauth_userScopes:profile:importprofile:writeWebhooks
2 endpointsGET
/v1/webhooksstubbedList webhooks
Lists configured webhook endpoints for the developer app.
Auth:
oauth_clientScopes:webhooks:managePOST
/v1/webhooksstubbedCreate webhook
Registers a webhook endpoint for profile, artifact, and pipeline events.
Auth:
oauth_clientScopes:webhooks:manage