Resume Schema

Overview

Our Resume API uses a clean, predictable JSON schema built specifically for resume data. Send data in this format, and the API will render it into any of our 18 themes.

The schema covers personal info, work experience, education, skills, projects, certifications, languages, awards, publications, references and more.

Why JSON?

JSON is lightweight, widely supported, easy to parse, and perfect for building tools around. Your resume data stays portable forever — store it, transform it, or generate documents from it.

Full example

The canonical resume payload accepted and returned by the API:

{
  "basics": {
    "name": "John Doe",
    "label": "Programmer",
    "image": "",
    "email": "john@gmail.com",
    "phone": "(912) 555-4321",
    "url": "https://johndoe.com",
    "summary": "A summary of John Doe…",
    "location": {
      "address": "2712 Broadway St",
      "postalCode": "CA 94115",
      "city": "San Francisco",
      "countryCode": "US",
      "region": "California"
    },
    "profiles": [{
      "network": "Twitter",
      "username": "john",
      "url": "https://twitter.com/john"
    }]
  },
  "work": [{
    "name": "Company",
    "position": "President",
    "url": "https://company.com",
    "startDate": "2013-01-01",
    "endDate": "2014-01-01",
    "summary": "Description…",
    "highlights": ["Started the company"]
  }],
  "education": [{
    "institution": "University",
    "url": "https://institution.com/",
    "area": "Software Development",
    "studyType": "Bachelor",
    "startDate": "2011-01-01",
    "endDate": "2013-01-01",
    "score": "4.0",
    "courses": ["DB1101 - Basic SQL"]
  }],
  "skills": [{
    "name": "Web Development",
    "level": "Master",
    "keywords": ["HTML", "CSS", "JavaScript"]
  }],
  "projects": [{
    "name": "Project",
    "startDate": "2019-01-01",
    "endDate": "2021-01-01",
    "description": "Description...",
    "highlights": ["Won award at AIHacks 2016"],
    "url": "https://project.com/"
  }],
  "certificates": [{
    "name": "Certificate",
    "date": "2021-11-07",
    "issuer": "Company",
    "url": "https://certificate.com"
  }],
  "awards": [{
    "title": "Award",
    "date": "2014-11-01",
    "awarder": "Company",
    "summary": "There is no spoon."
  }],
  "publications": [{
    "name": "Publication",
    "publisher": "Company",
    "releaseDate": "2014-10-01",
    "url": "https://publication.com",
    "summary": "Description…"
  }],
  "languages": [{
    "language": "English",
    "fluency": "Native speaker"
  }],
  "interests": [{
    "name": "Wildlife",
    "keywords": ["Ferrets", "Unicorns"]
  }],
  "references": [{
    "name": "Jane Doe",
    "reference": "Reference…"
  }],
  "volunteer": [{
    "organization": "Organization",
    "position": "Volunteer",
    "url": "https://organization.com/",
    "startDate": "2012-01-01",
    "endDate": "2013-01-01",
    "summary": "Description…",
    "highlights": ["Awarded 'Volunteer of the Month'"]
  }]
}

basics

Personal information at the top of the resume.

work[]

education[]

skills[]

projects[]

certificates[]

awards[]

publications[]

languages[]

interests[]

references[]

volunteer[]

Same shape as work[] but with organization instead of name.