JSON Resume API Documentation

Welcome to the JSON Resume API documentation. This comprehensive API provides powerful endpoints for accessing resume data in multiple formats and finding AI-powered job recommendations tailored to individual profiles.

Base URL

Authentication

All endpoints are publicly accessible and do not require authentication. This makes integration simple and straightforward for developers.

Rate Limiting

Please be respectful with API usage. Heavy usage may be rate limited to ensure fair access for all users. For high-volume applications, consider implementing caching strategies.

Resume Endpoints

Get Resume

Retrieve a user's complete resume data in various output formats. This endpoint is the core of the JSON Resume platform, allowing you to access structured resume data and render it in different formats for web display, PDF generation, or data processing.

Endpoint

Parameters

Query Parameters

Advanced: Schema Validation Bypass

For experimental or edge-case resumes that don't conform to the standard JSON Resume schema, you can bypass validation by adding a flag to your resume's meta section:

{
  "meta": {
    "skipValidation": true
  },
  "basics": { ... },
  ...
}

Example Requests

Response

Returns the resume in the requested format. Default format is a styled HTML template. JSON format returns the raw structured data, while PDF generates a downloadable document.

Example JSON Response:

{
  "basics": {
    "name": "Thomas Davis",
    "label": "Web Developer",
    "email": "thomas@jsonresume.org",
    "phone": "(912) 555-4321",
    "website": "https://thomasdavis.github.io",
    "summary": "Full-stack developer with 10+ years experience...",
    "location": {
      "city": "San Francisco",
      "countryCode": "US"
    }
  },
  "work": [
    {
      "company": "Company Name",
      "position": "Senior Developer",
      "startDate": "2020-01-01",
      "summary": "Led development of..."
    }
  ],
  "education": [...],
  "skills": [...]
}

Error Responses

Jobs Endpoints

Get Relevant Jobs (New)

Get AI-powered job recommendations tailored specifically to a user's resume. This endpoint uses advanced machine learning to analyze resume content, extract key skills and experience, and match against a database of current job postings to find the most relevant opportunities.

Endpoint

Parameters

Example Request

Response

Returns an array of up to 500 job recommendations, sorted by relevance score (highest first). Each job includes similarity score, original URL, and full job description content.

[
  {
    "jobId": 5091,
    "score": 0.633673667907715,
    "url": "https://news.ycombinator.com/item?id=44236004",
    "raw": "{\"title\":\"Full Stack Developer\",\"company\":\"ConsentKeys.com\",\"location\":{\"address\":\"\",\"city\":\"\",\"region\":\"\",\"postalCode\":\"\",\"countryCode\":\"\"},\"position\":\"Full Stack Developer\",\"type\":\"Contract (possible CTO conversion)\",\"salary\":\"\",\"date\":\"2024-06\",\"remote\":\"Full\",\"description\":\"ConsentKeys.com is a WolfNYC (VC) backed startup dedicated to protecting people's privacy online...\",\"responsibilities\":[\"Develop and maintain full-stack privacy and security solutions.\",\"Implement verifiable credentials, OIDC, and ZKPs.\"],\"qualifications\":[\"Experience with privacy and security technologies.\",\"Full-stack development experience.\"],\"skills\":[{\"name\":\"Full Stack Development\",\"level\":\"Expert\",\"keywords\":[\"Node.js\",\"React\",\"TypeScript\",\"REST APIs\"]}],\"experience\":\"Senior\",\"application\":\"https://consentkeys.com/careers\"}"
  },
  {
    "jobId": 5295,
    "score": 0.614646508055513,
    "url": "https://news.ycombinator.com/item?id=44163323",
    "raw": "{\"title\":\"Fullstack Web Engineer\",\"company\":\"IPinfo.io\",\"type\":\"Full-time\",\"date\":\"2024-06\",\"description\":\"IPinfo.io is a global leader in IP data solutions, powering over 100 billion requests monthly...\",\"location\":{\"countryCode\":\"US\"},\"remote\":\"Full\",\"salary\":\"\",\"experience\":\"Senior\",\"skills\":[{\"name\":\"Fullstack Development\",\"level\":\"Expert\",\"keywords\":[\"JavaScript\",\"Python\",\"APIs\"]}]}"
  }
]

Response Fields

{
  "resume": {
    "basics": {
      "name": "John Doe",
      "email": "john@example.com",
      "phone": "+1-555-0100",
      "summary": "Experienced software engineer...",
      "location": {
        "city": "San Francisco",
        "region": "CA",
        "country": "US"
      }
    },
    "work": [...],
    "education": [...],
    "skills": [...]
  },
  "theme": "jsonresume-theme-stackoverflow" // optional
}

{
  "score": 85,
  "rating": "Good",
  "summary": "Your resume is well-optimized for ATS with minor improvements needed.",
  "checks": [
    {
      "name": "Contact Information",
      "score": 20,
      "maxScore": 20,
      "passed": true,
      "issues": []
    },
    {
      "name": "Work Experience",
      "score": 16,
      "maxScore": 20,
      "passed": true,
      "issues": [
        {
          "severity": "warning",
          "category": "experience",
          "message": "Work entry #2: Missing job description or highlights",
          "fix": "Complete all required fields for work entry #2"
        }
      ]
    }
    // ... 5 more checks
  ],
  "recommendations": [
    {
      "severity": "warning",
      "category": "experience",
      "message": "Work entry #2: Missing job description or highlights",
      "fix": "Complete all required fields for work entry #2"
    }
    // ... more recommendations
  ]
}

// Fetch your resume
const resumeResponse = await fetch('https://registry.jsonresume.org/username.json');
const resume = await resumeResponse.json();

// Analyze for ATS compatibility
const atsResponse = await fetch('https://registry.jsonresume.org/api/ats', {
  method: 'POST',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({ resume, theme: 'jsonresume-theme-stackoverflow' })
});

const analysis = await atsResponse.json();
console.log(`ATS Score: ${analysis.score}/100 (${analysis.rating})`);
console.log(`Recommendations: ${analysis.recommendations.length}`);

Get Relevant Jobs (Legacy)

Legacy endpoint for getting relevant jobs using query parameters. This endpoint provides the same AI-powered job matching functionality as the new endpoint above, but uses the traditional query parameter approach. Maintained for backward compatibility with existing integrations.

Endpoint

Parameters

Example Request

Response

Returns the same response format as the new jobs endpoint above - an array of job recommendations with relevance scores, URLs, and full job descriptions.

Error Responses