Back to Reactive Resume

Reactive Resume Schema Reference

skills/resume-builder/references/schema.md

5.2.597.4 KB
Original Source

Reactive Resume Schema Reference

Generated by pnpm docs:gen from resumeDataSchema. Do not edit this file directly.

Canonical schema: https://rxresu.me/schema.json

Required top-level fields

picture, basics, summary, sections, customSections, and metadata

Union variant shapes

Choose one coherent shape for each union value. Required fields are local to that variant; optional fields remain in the field catalog.

PathType/variantItem schemaRepresentative required shape
customSections[]summarysummaryItemSchema{ id, hidden, content }
customSections[]profilesprofileItemSchema{ id, hidden, icon, network, username }
customSections[]experienceexperienceItemSchema{ id, hidden, company, position, location, period, description }
customSections[]educationeducationItemSchema{ id, hidden, school, degree, area, grade, location, period, description }
customSections[]projectsprojectItemSchema{ id, hidden, name, period, description }
customSections[]skillsskillItemSchema{ id, hidden, icon, name, proficiency }
customSections[]languageslanguageItemSchema{ id, hidden, language, fluency }
customSections[]interestsinterestItemSchema{ id, hidden, icon, name }
customSections[]awardsawardItemSchema{ id, hidden, title, awarder, date, description }
customSections[]certificationscertificationItemSchema{ id, hidden, title, issuer, date, description }
customSections[]publicationspublicationItemSchema{ id, hidden, title, publisher, date, description }
customSections[]volunteervolunteerItemSchema{ id, hidden, organization, location, period, description }
customSections[]referencesreferenceItemSchema{ id, hidden, name, position, phone, description }
customSections[]cover-lettercoverLetterItemSchema{ id, hidden, recipient, content }

Field catalog

PathTypeRequiredConstraints and defaultDescription
pictureobjectyesConfiguration for photograph displayed on the resume
picture.hiddenbooleanyesWhether to hide the picture from the resume.
picture.urlstringyesThe URL to the picture to display on the resume. Prefer local app-served paths (for example /uploads/...) populated via upload.
picture.sizenumberyesminimum: 32; maximum: 512The size of the picture to display on the resume, defined in points (pt).
picture.rotationnumberyesminimum: 0; maximum: 360The rotation of the picture to display on the resume, defined in degrees (°).
picture.aspectRationumberyesminimum: 0.5; maximum: 2.5The aspect ratio of the picture to display on the resume, defined as width / height (e.g. 1.5 for 1.5:1 or 0.5 for 1:2).
picture.borderRadiusnumberyesminimum: 0; maximum: 100The border radius of the picture to display on the resume, defined in points (pt).
picture.borderColorstringyesThe color of the border of the picture to display on the resume, defined as rgba(r, g, b, a).
picture.borderWidthnumberyesminimum: 0The width of the border of the picture to display on the resume, defined in points (pt).
picture.shadowColorstringyesThe color of the shadow of the picture to display on the resume, defined as rgba(r, g, b, a).
picture.shadowWidthnumberyesminimum: 0The width of the shadow of the picture to display on the resume, defined in points (pt).
basicsobjectyesBasic information about the author, such as name, email, phone, location, and website
basics.namestringyesThe full name of the author of the resume.
basics.headlinestringyesThe headline of the author of the resume.
basics.emailstringyesThe email address of the author of the resume.
basics.phonestringyesThe phone number of the author of the resume.
basics.locationstringyesThe location of the author of the resume.
basics.websiteobjectyesThe website of the author of the resume.
basics.website.urlstringyesThe URL to show as a link. Must be a valid URL with a protocol (http:// or https://).
basics.website.labelstringyesThe label to display for the URL. Leave blank to display the URL as-is.
basics.customFieldsarrayyesThe custom fields to display on the resume.
basics.customFields[]object
basics.customFields[].idstringyesThe unique identifier for the custom field. Usually generated as a UUID.
basics.customFields[].iconstringyesThe icon to display for the custom field. Must be a valid icon name from @phosphor-icons/web icon set, or an empty string to hide. Default to '' (empty string) when unsure which icons are available.
basics.customFields[].textstringyesThe text to display for the custom field.
basics.customFields[].linkstringnodefault: ""If the custom field should be a link, the URL to link to.
summaryobjectyesSummary section of the resume, useful for a short bio or introduction
summary.titlestringyesThe title of the summary of the resume.
summary.iconstringnodefault: ""Phosphor icon name to display before the summary section title in the PDF output. Empty string uses the default summary icon; 'none' hides the icon.
summary.columnsintegernominimum: 1; maximum: 6; default: 1The number of columns the summary should span across.
summary.hiddenbooleanyesWhether to hide the summary from the resume.
summary.keepTogetherbooleannodefault: falseIf true, the summary is kept on a single page instead of splitting across a page break.
summary.startOnNewPagebooleannodefault: falseIf true, the summary always begins on a new page.
summary.contentstringyesThe content of the summary of the resume. This should be a HTML-formatted string.
sectionsobjectyesVarious sections of the resume, such as experience, education, projects, etc.
sections.profilesobjectyesThe section to display the profiles of the author.
sections.profiles.titlestringyesThe title of the section.
sections.profiles.iconstringnodefault: ""Phosphor icon name to display before the section title in the PDF output. Empty string uses the default section icon; 'none' hides the icon.
sections.profiles.columnsintegernominimum: 1; maximum: 6; default: 1The number of columns the section should span across.
sections.profiles.hiddenbooleanyesWhether to hide the section from the resume.
sections.profiles.keepTogetherbooleannodefault: falseIf true, the section is kept on a single page instead of splitting across a page break.
sections.profiles.startOnNewPagebooleannodefault: falseIf true, the section always begins on a new page.
sections.profiles.itemsarrayyesThe items to display in the profiles section.
sections.profiles.items[]object
sections.profiles.items[].idstringyesThe unique identifier for the item. Usually generated as a UUID.
sections.profiles.items[].hiddenbooleanyesWhether to hide the item from the resume.
sections.profiles.items[].iconstringyesThe icon to display for the custom field. Must be a valid icon name from @phosphor-icons/web icon set, or an empty string to hide. Default to '' (empty string) when unsure which icons are available.
sections.profiles.items[].iconColorstringnodefault: ""Custom color for the icon, defined as rgba(r, g, b, a). Leave blank to use the template default icon color.
sections.profiles.items[].networkstringyesminLength: 1The name of the network or platform.
sections.profiles.items[].usernamestringyesThe username of the author on the network or platform.
sections.profiles.items[].websiteobjectnodefault: {"url":"","label":"","inlineLink":false}The link to the profile of the author on the network or platform, if any.
sections.profiles.items[].website.urlstringyesThe URL to show as a link. Must be a valid URL with a protocol (http:// or https://).
sections.profiles.items[].website.labelstringyesThe label to display for the URL. Leave blank to display the URL as-is.
sections.profiles.items[].website.inlineLinkbooleannodefault: falseIf true, the website URL is rendered as a hyperlink on the title instead of a separate link at the bottom.
sections.experienceobjectyesThe section to display the experience of the author.
sections.experience.titlestringyesThe title of the section.
sections.experience.iconstringnodefault: ""Phosphor icon name to display before the section title in the PDF output. Empty string uses the default section icon; 'none' hides the icon.
sections.experience.columnsintegernominimum: 1; maximum: 6; default: 1The number of columns the section should span across.
sections.experience.hiddenbooleanyesWhether to hide the section from the resume.
sections.experience.keepTogetherbooleannodefault: falseIf true, the section is kept on a single page instead of splitting across a page break.
sections.experience.startOnNewPagebooleannodefault: falseIf true, the section always begins on a new page.
sections.experience.itemsarrayyesThe items to display in the experience section.
sections.experience.items[]object
sections.experience.items[].idstringyesThe unique identifier for the item. Usually generated as a UUID.
sections.experience.items[].hiddenbooleanyesWhether to hide the item from the resume.
sections.experience.items[].companystringyesminLength: 1The name of the company or organization.
sections.experience.items[].positionstringyesThe position held at the company or organization. Used when there is only a single role. If multiple roles are provided in the 'roles' field, this serves as a summary title or can be left blank.
sections.experience.items[].locationstringyesThe location of the company or organization.
sections.experience.items[].periodstringyesThe overall period of time at the company. When multiple roles are used, this should reflect the total tenure.
sections.experience.items[].websiteobjectnodefault: {"url":"","label":"","inlineLink":false}The website of the company or organization, if any.
sections.experience.items[].website.urlstringyesThe URL to show as a link. Must be a valid URL with a protocol (http:// or https://).
sections.experience.items[].website.labelstringyesThe label to display for the URL. Leave blank to display the URL as-is.
sections.experience.items[].website.inlineLinkbooleannodefault: falseIf true, the website URL is rendered as a hyperlink on the title instead of a separate link at the bottom.
sections.experience.items[].descriptionstringyesThe description of the experience. This should be a HTML-formatted string.
sections.experience.items[].rolesarraynodefault: []List of individual roles held at this company to show career progression.
sections.experience.items[].roles[]object
sections.experience.items[].roles[].idstringyesThe unique identifier for the role. Usually generated as a UUID.
sections.experience.items[].roles[].positionstringyesThe position or job title for this role.
sections.experience.items[].roles[].periodstringyesThe period of time this role was held.
sections.experience.items[].roles[].descriptionstringyesThe description of this specific role. This should be a HTML-formatted string.
sections.educationobjectyesThe section to display the education of the author.
sections.education.titlestringyesThe title of the section.
sections.education.iconstringnodefault: ""Phosphor icon name to display before the section title in the PDF output. Empty string uses the default section icon; 'none' hides the icon.
sections.education.columnsintegernominimum: 1; maximum: 6; default: 1The number of columns the section should span across.
sections.education.hiddenbooleanyesWhether to hide the section from the resume.
sections.education.keepTogetherbooleannodefault: falseIf true, the section is kept on a single page instead of splitting across a page break.
sections.education.startOnNewPagebooleannodefault: falseIf true, the section always begins on a new page.
sections.education.itemsarrayyesThe items to display in the education section.
sections.education.items[]object
sections.education.items[].idstringyesThe unique identifier for the item. Usually generated as a UUID.
sections.education.items[].hiddenbooleanyesWhether to hide the item from the resume.
sections.education.items[].schoolstringyesminLength: 1The name of the school or institution.
sections.education.items[].degreestringyesThe degree or qualification obtained.
sections.education.items[].areastringyesThe area of study or specialization.
sections.education.items[].gradestringyesThe grade or score achieved.
sections.education.items[].locationstringyesThe location of the school or institution.
sections.education.items[].periodstringyesThe period of time the education was obtained over.
sections.education.items[].websiteobjectnodefault: {"url":"","label":"","inlineLink":false}The website of the school or institution, if any.
sections.education.items[].website.urlstringyesThe URL to show as a link. Must be a valid URL with a protocol (http:// or https://).
sections.education.items[].website.labelstringyesThe label to display for the URL. Leave blank to display the URL as-is.
sections.education.items[].website.inlineLinkbooleannodefault: falseIf true, the website URL is rendered as a hyperlink on the title instead of a separate link at the bottom.
sections.education.items[].descriptionstringyesThe description of the education. This should be a HTML-formatted string.
sections.projectsobjectyesThe section to display the projects of the author.
sections.projects.titlestringyesThe title of the section.
sections.projects.iconstringnodefault: ""Phosphor icon name to display before the section title in the PDF output. Empty string uses the default section icon; 'none' hides the icon.
sections.projects.columnsintegernominimum: 1; maximum: 6; default: 1The number of columns the section should span across.
sections.projects.hiddenbooleanyesWhether to hide the section from the resume.
sections.projects.keepTogetherbooleannodefault: falseIf true, the section is kept on a single page instead of splitting across a page break.
sections.projects.startOnNewPagebooleannodefault: falseIf true, the section always begins on a new page.
sections.projects.itemsarrayyesThe items to display in the projects section.
sections.projects.items[]object
sections.projects.items[].idstringyesThe unique identifier for the item. Usually generated as a UUID.
sections.projects.items[].hiddenbooleanyesWhether to hide the item from the resume.
sections.projects.items[].namestringyesminLength: 1The name of the project.
sections.projects.items[].periodstringyesThe period of time the project was worked on.
sections.projects.items[].websiteobjectnodefault: {"url":"","label":"","inlineLink":false}The link to the project, if any.
sections.projects.items[].website.urlstringyesThe URL to show as a link. Must be a valid URL with a protocol (http:// or https://).
sections.projects.items[].website.labelstringyesThe label to display for the URL. Leave blank to display the URL as-is.
sections.projects.items[].website.inlineLinkbooleannodefault: falseIf true, the website URL is rendered as a hyperlink on the title instead of a separate link at the bottom.
sections.projects.items[].descriptionstringyesThe description of the project. This should be a HTML-formatted string.
sections.skillsobjectyesThe section to display the skills of the author.
sections.skills.titlestringyesThe title of the section.
sections.skills.iconstringnodefault: ""Phosphor icon name to display before the section title in the PDF output. Empty string uses the default section icon; 'none' hides the icon.
sections.skills.columnsintegernominimum: 1; maximum: 6; default: 1The number of columns the section should span across.
sections.skills.hiddenbooleanyesWhether to hide the section from the resume.
sections.skills.keepTogetherbooleannodefault: falseIf true, the section is kept on a single page instead of splitting across a page break.
sections.skills.startOnNewPagebooleannodefault: falseIf true, the section always begins on a new page.
sections.skills.itemsarrayyesThe items to display in the skills section.
sections.skills.items[]object
sections.skills.items[].idstringyesThe unique identifier for the item. Usually generated as a UUID.
sections.skills.items[].hiddenbooleanyesWhether to hide the item from the resume.
sections.skills.items[].iconstringyesThe icon to display for the custom field. Must be a valid icon name from @phosphor-icons/web icon set, or an empty string to hide. Default to '' (empty string) when unsure which icons are available.
sections.skills.items[].iconColorstringnodefault: ""Custom color for the icon, defined as rgba(r, g, b, a). Leave blank to use the template default icon color.
sections.skills.items[].namestringyesminLength: 1The name of the skill.
sections.skills.items[].proficiencystringyesThe proficiency level of the skill. Can be any text, such as 'Beginner', 'Intermediate', 'Advanced', etc.
sections.skills.items[].levelnumbernominimum: 0; maximum: 5; default: 0The proficiency level of the skill, defined as a number between 0 and 5. If set to 0, the icons displaying the level will be hidden.
sections.skills.items[].keywordsarraynodefault: []The keywords associated with the skill, if any. These are displayed as tags below the name.
sections.skills.items[].keywords[]string
sections.languagesobjectyesThe section to display the languages of the author.
sections.languages.titlestringyesThe title of the section.
sections.languages.iconstringnodefault: ""Phosphor icon name to display before the section title in the PDF output. Empty string uses the default section icon; 'none' hides the icon.
sections.languages.columnsintegernominimum: 1; maximum: 6; default: 1The number of columns the section should span across.
sections.languages.hiddenbooleanyesWhether to hide the section from the resume.
sections.languages.keepTogetherbooleannodefault: falseIf true, the section is kept on a single page instead of splitting across a page break.
sections.languages.startOnNewPagebooleannodefault: falseIf true, the section always begins on a new page.
sections.languages.itemsarrayyesThe items to display in the languages section.
sections.languages.items[]object
sections.languages.items[].idstringyesThe unique identifier for the item. Usually generated as a UUID.
sections.languages.items[].hiddenbooleanyesWhether to hide the item from the resume.
sections.languages.items[].languagestringyesminLength: 1The name of the language the author knows.
sections.languages.items[].fluencystringyesThe fluency level of the language. Can be any text, such as 'Native', 'Fluent', 'Conversational', etc. or can also be a CEFR level (A1, A2, B1, B2, C1, C2).
sections.languages.items[].levelnumbernominimum: 0; maximum: 5; default: 0The proficiency level of the language, defined as a number between 0 and 5. If set to 0, the icons displaying the level will be hidden.
sections.interestsobjectyesThe section to display the interests of the author.
sections.interests.titlestringyesThe title of the section.
sections.interests.iconstringnodefault: ""Phosphor icon name to display before the section title in the PDF output. Empty string uses the default section icon; 'none' hides the icon.
sections.interests.columnsintegernominimum: 1; maximum: 6; default: 1The number of columns the section should span across.
sections.interests.hiddenbooleanyesWhether to hide the section from the resume.
sections.interests.keepTogetherbooleannodefault: falseIf true, the section is kept on a single page instead of splitting across a page break.
sections.interests.startOnNewPagebooleannodefault: falseIf true, the section always begins on a new page.
sections.interests.itemsarrayyesThe items to display in the interests section.
sections.interests.items[]object
sections.interests.items[].idstringyesThe unique identifier for the item. Usually generated as a UUID.
sections.interests.items[].hiddenbooleanyesWhether to hide the item from the resume.
sections.interests.items[].iconstringyesThe icon to display for the custom field. Must be a valid icon name from @phosphor-icons/web icon set, or an empty string to hide. Default to '' (empty string) when unsure which icons are available.
sections.interests.items[].iconColorstringnodefault: ""Custom color for the icon, defined as rgba(r, g, b, a). Leave blank to use the template default icon color.
sections.interests.items[].namestringyesminLength: 1The name of the interest/hobby.
sections.interests.items[].keywordsarraynodefault: []The keywords associated with the interest/hobby, if any. These are displayed as tags below the name.
sections.interests.items[].keywords[]string
sections.awardsobjectyesThe section to display the awards of the author.
sections.awards.titlestringyesThe title of the section.
sections.awards.iconstringnodefault: ""Phosphor icon name to display before the section title in the PDF output. Empty string uses the default section icon; 'none' hides the icon.
sections.awards.columnsintegernominimum: 1; maximum: 6; default: 1The number of columns the section should span across.
sections.awards.hiddenbooleanyesWhether to hide the section from the resume.
sections.awards.keepTogetherbooleannodefault: falseIf true, the section is kept on a single page instead of splitting across a page break.
sections.awards.startOnNewPagebooleannodefault: falseIf true, the section always begins on a new page.
sections.awards.itemsarrayyesThe items to display in the awards section.
sections.awards.items[]object
sections.awards.items[].idstringyesThe unique identifier for the item. Usually generated as a UUID.
sections.awards.items[].hiddenbooleanyesWhether to hide the item from the resume.
sections.awards.items[].titlestringyesminLength: 1The title of the award.
sections.awards.items[].awarderstringyesThe awarder of the award.
sections.awards.items[].datestringyesThe date when the award was received.
sections.awards.items[].websiteobjectnodefault: {"url":"","label":"","inlineLink":false}The website of the award, if any.
sections.awards.items[].website.urlstringyesThe URL to show as a link. Must be a valid URL with a protocol (http:// or https://).
sections.awards.items[].website.labelstringyesThe label to display for the URL. Leave blank to display the URL as-is.
sections.awards.items[].website.inlineLinkbooleannodefault: falseIf true, the website URL is rendered as a hyperlink on the title instead of a separate link at the bottom.
sections.awards.items[].descriptionstringyesThe description of the award. This should be a HTML-formatted string.
sections.certificationsobjectyesThe section to display the certifications of the author.
sections.certifications.titlestringyesThe title of the section.
sections.certifications.iconstringnodefault: ""Phosphor icon name to display before the section title in the PDF output. Empty string uses the default section icon; 'none' hides the icon.
sections.certifications.columnsintegernominimum: 1; maximum: 6; default: 1The number of columns the section should span across.
sections.certifications.hiddenbooleanyesWhether to hide the section from the resume.
sections.certifications.keepTogetherbooleannodefault: falseIf true, the section is kept on a single page instead of splitting across a page break.
sections.certifications.startOnNewPagebooleannodefault: falseIf true, the section always begins on a new page.
sections.certifications.itemsarrayyesThe items to display in the certifications section.
sections.certifications.items[]object
sections.certifications.items[].idstringyesThe unique identifier for the item. Usually generated as a UUID.
sections.certifications.items[].hiddenbooleanyesWhether to hide the item from the resume.
sections.certifications.items[].titlestringyesminLength: 1The title of the certification.
sections.certifications.items[].issuerstringyesThe issuer of the certification.
sections.certifications.items[].datestringyesThe date when the certification was received.
sections.certifications.items[].websiteobjectnodefault: {"url":"","label":"","inlineLink":false}The website of the certification, if any.
sections.certifications.items[].website.urlstringyesThe URL to show as a link. Must be a valid URL with a protocol (http:// or https://).
sections.certifications.items[].website.labelstringyesThe label to display for the URL. Leave blank to display the URL as-is.
sections.certifications.items[].website.inlineLinkbooleannodefault: falseIf true, the website URL is rendered as a hyperlink on the title instead of a separate link at the bottom.
sections.certifications.items[].descriptionstringyesThe description of the certification. This should be a HTML-formatted string.
sections.publicationsobjectyesThe section to display the publications of the author.
sections.publications.titlestringyesThe title of the section.
sections.publications.iconstringnodefault: ""Phosphor icon name to display before the section title in the PDF output. Empty string uses the default section icon; 'none' hides the icon.
sections.publications.columnsintegernominimum: 1; maximum: 6; default: 1The number of columns the section should span across.
sections.publications.hiddenbooleanyesWhether to hide the section from the resume.
sections.publications.keepTogetherbooleannodefault: falseIf true, the section is kept on a single page instead of splitting across a page break.
sections.publications.startOnNewPagebooleannodefault: falseIf true, the section always begins on a new page.
sections.publications.itemsarrayyesThe items to display in the publications section.
sections.publications.items[]object
sections.publications.items[].idstringyesThe unique identifier for the item. Usually generated as a UUID.
sections.publications.items[].hiddenbooleanyesWhether to hide the item from the resume.
sections.publications.items[].titlestringyesminLength: 1The title of the publication.
sections.publications.items[].publisherstringyesThe publisher of the publication.
sections.publications.items[].datestringyesThe date when the publication was published.
sections.publications.items[].websiteobjectnodefault: {"url":"","label":"","inlineLink":false}The link to the publication, if any.
sections.publications.items[].website.urlstringyesThe URL to show as a link. Must be a valid URL with a protocol (http:// or https://).
sections.publications.items[].website.labelstringyesThe label to display for the URL. Leave blank to display the URL as-is.
sections.publications.items[].website.inlineLinkbooleannodefault: falseIf true, the website URL is rendered as a hyperlink on the title instead of a separate link at the bottom.
sections.publications.items[].descriptionstringyesThe description of the publication. This should be a HTML-formatted string.
sections.volunteerobjectyesThe section to display the volunteer experience of the author.
sections.volunteer.titlestringyesThe title of the section.
sections.volunteer.iconstringnodefault: ""Phosphor icon name to display before the section title in the PDF output. Empty string uses the default section icon; 'none' hides the icon.
sections.volunteer.columnsintegernominimum: 1; maximum: 6; default: 1The number of columns the section should span across.
sections.volunteer.hiddenbooleanyesWhether to hide the section from the resume.
sections.volunteer.keepTogetherbooleannodefault: falseIf true, the section is kept on a single page instead of splitting across a page break.
sections.volunteer.startOnNewPagebooleannodefault: falseIf true, the section always begins on a new page.
sections.volunteer.itemsarrayyesThe items to display in the volunteer section.
sections.volunteer.items[]object
sections.volunteer.items[].idstringyesThe unique identifier for the item. Usually generated as a UUID.
sections.volunteer.items[].hiddenbooleanyesWhether to hide the item from the resume.
sections.volunteer.items[].organizationstringyesminLength: 1The name of the organization or company.
sections.volunteer.items[].locationstringyesThe location of the organization or company.
sections.volunteer.items[].periodstringyesThe period of time the author was volunteered at the organization or company.
sections.volunteer.items[].websiteobjectnodefault: {"url":"","label":"","inlineLink":false}The link to the organization or company, if any.
sections.volunteer.items[].website.urlstringyesThe URL to show as a link. Must be a valid URL with a protocol (http:// or https://).
sections.volunteer.items[].website.labelstringyesThe label to display for the URL. Leave blank to display the URL as-is.
sections.volunteer.items[].website.inlineLinkbooleannodefault: falseIf true, the website URL is rendered as a hyperlink on the title instead of a separate link at the bottom.
sections.volunteer.items[].descriptionstringyesThe description of the volunteer experience. This should be a HTML-formatted string.
sections.referencesobjectyesThe section to display the references of the author.
sections.references.titlestringyesThe title of the section.
sections.references.iconstringnodefault: ""Phosphor icon name to display before the section title in the PDF output. Empty string uses the default section icon; 'none' hides the icon.
sections.references.columnsintegernominimum: 1; maximum: 6; default: 1The number of columns the section should span across.
sections.references.hiddenbooleanyesWhether to hide the section from the resume.
sections.references.keepTogetherbooleannodefault: falseIf true, the section is kept on a single page instead of splitting across a page break.
sections.references.startOnNewPagebooleannodefault: falseIf true, the section always begins on a new page.
sections.references.itemsarrayyesThe items to display in the references section.
sections.references.items[]object
sections.references.items[].idstringyesThe unique identifier for the item. Usually generated as a UUID.
sections.references.items[].hiddenbooleanyesWhether to hide the item from the resume.
sections.references.items[].namestringyesminLength: 1The name of the reference, or a note such as 'Available upon request'.
sections.references.items[].positionstringyesThe position or job title of the reference.
sections.references.items[].websiteobjectnodefault: {"url":"","label":"","inlineLink":false}The website or LinkedIn profile of the reference, if any.
sections.references.items[].website.urlstringyesThe URL to show as a link. Must be a valid URL with a protocol (http:// or https://).
sections.references.items[].website.labelstringyesThe label to display for the URL. Leave blank to display the URL as-is.
sections.references.items[].website.inlineLinkbooleannodefault: falseIf true, the website URL is rendered as a hyperlink on the title instead of a separate link at the bottom.
sections.references.items[].phonestringyesThe phone number of the reference.
sections.references.items[].descriptionstringyesThe description of the reference. Can be used to display a quote, a testimonial, etc. This should be a HTML-formatted string.
customSectionsarrayyesCustom sections of the resume, such as a custom section for notes, etc.
customSections[]object or object or object or object or object or object or object or object or object or object or object or object or object or object
customSections[]object— (type summary, schema summaryItemSchema at customSections[])
customSections[].titlestringyes (type summary, schema summaryItemSchema at customSections[])The title of the section.
customSections[].iconstringno (type summary, schema summaryItemSchema at customSections[])default: ""Phosphor icon name to display before the section title in the PDF output. Empty string uses the default section icon; 'none' hides the icon.
customSections[].columnsintegerno (type summary, schema summaryItemSchema at customSections[])minimum: 1; maximum: 6; default: 1The number of columns the section should span across.
customSections[].hiddenbooleanyes (type summary, schema summaryItemSchema at customSections[])Whether to hide the section from the resume.
customSections[].keepTogetherbooleanno (type summary, schema summaryItemSchema at customSections[])default: falseIf true, the section is kept on a single page instead of splitting across a page break.
customSections[].startOnNewPagebooleanno (type summary, schema summaryItemSchema at customSections[])default: falseIf true, the section always begins on a new page.
customSections[].idstringyes (type summary, schema summaryItemSchema at customSections[])The unique identifier for the custom section. Usually generated as a UUID.
customSections[].typestringyes (type summary, schema summaryItemSchema at customSections[])The type of items this custom section contains. Determines which item schema and form fields to use.
customSections[].itemsarrayyes (type summary, schema summaryItemSchema at customSections[])The items to display in the custom section. Items follow the schema of the section type.
customSections[].items[]object— (type summary, schema summaryItemSchema at customSections[])
customSections[].items[].idstringyes (type summary, schema summaryItemSchema at customSections[])The unique identifier for the item. Usually generated as a UUID.
customSections[].items[].hiddenbooleanyes (type summary, schema summaryItemSchema at customSections[])Whether to hide the item from the resume.
customSections[].items[].contentstringyes (type summary, schema summaryItemSchema at customSections[])The rich text content of the summary item. This should be a HTML-formatted string.
customSections[]object— (type profiles, schema profileItemSchema at customSections[])
customSections[].titlestringyes (type profiles, schema profileItemSchema at customSections[])The title of the section.
customSections[].iconstringno (type profiles, schema profileItemSchema at customSections[])default: ""Phosphor icon name to display before the section title in the PDF output. Empty string uses the default section icon; 'none' hides the icon.
customSections[].columnsintegerno (type profiles, schema profileItemSchema at customSections[])minimum: 1; maximum: 6; default: 1The number of columns the section should span across.
customSections[].hiddenbooleanyes (type profiles, schema profileItemSchema at customSections[])Whether to hide the section from the resume.
customSections[].keepTogetherbooleanno (type profiles, schema profileItemSchema at customSections[])default: falseIf true, the section is kept on a single page instead of splitting across a page break.
customSections[].startOnNewPagebooleanno (type profiles, schema profileItemSchema at customSections[])default: falseIf true, the section always begins on a new page.
customSections[].idstringyes (type profiles, schema profileItemSchema at customSections[])The unique identifier for the custom section. Usually generated as a UUID.
customSections[].typestringyes (type profiles, schema profileItemSchema at customSections[])The type of items this custom section contains. Determines which item schema and form fields to use.
customSections[].itemsarrayyes (type profiles, schema profileItemSchema at customSections[])The items to display in the custom section. Items follow the schema of the section type.
customSections[].items[]object— (type profiles, schema profileItemSchema at customSections[])
customSections[].items[].idstringyes (type profiles, schema profileItemSchema at customSections[])The unique identifier for the item. Usually generated as a UUID.
customSections[].items[].hiddenbooleanyes (type profiles, schema profileItemSchema at customSections[])Whether to hide the item from the resume.
customSections[].items[].iconstringyes (type profiles, schema profileItemSchema at customSections[])The icon to display for the custom field. Must be a valid icon name from @phosphor-icons/web icon set, or an empty string to hide. Default to '' (empty string) when unsure which icons are available.
customSections[].items[].iconColorstringno (type profiles, schema profileItemSchema at customSections[])default: ""Custom color for the icon, defined as rgba(r, g, b, a). Leave blank to use the template default icon color.
customSections[].items[].networkstringyes (type profiles, schema profileItemSchema at customSections[])minLength: 1The name of the network or platform.
customSections[].items[].usernamestringyes (type profiles, schema profileItemSchema at customSections[])The username of the author on the network or platform.
customSections[].items[].websiteobjectno (type profiles, schema profileItemSchema at customSections[])default: {"url":"","label":"","inlineLink":false}The link to the profile of the author on the network or platform, if any.
customSections[].items[].website.urlstringyes (type profiles, schema profileItemSchema at customSections[])The URL to show as a link. Must be a valid URL with a protocol (http:// or https://).
customSections[].items[].website.labelstringyes (type profiles, schema profileItemSchema at customSections[])The label to display for the URL. Leave blank to display the URL as-is.
customSections[].items[].website.inlineLinkbooleanno (type profiles, schema profileItemSchema at customSections[])default: falseIf true, the website URL is rendered as a hyperlink on the title instead of a separate link at the bottom.
customSections[]object— (type experience, schema experienceItemSchema at customSections[])
customSections[].titlestringyes (type experience, schema experienceItemSchema at customSections[])The title of the section.
customSections[].iconstringno (type experience, schema experienceItemSchema at customSections[])default: ""Phosphor icon name to display before the section title in the PDF output. Empty string uses the default section icon; 'none' hides the icon.
customSections[].columnsintegerno (type experience, schema experienceItemSchema at customSections[])minimum: 1; maximum: 6; default: 1The number of columns the section should span across.
customSections[].hiddenbooleanyes (type experience, schema experienceItemSchema at customSections[])Whether to hide the section from the resume.
customSections[].keepTogetherbooleanno (type experience, schema experienceItemSchema at customSections[])default: falseIf true, the section is kept on a single page instead of splitting across a page break.
customSections[].startOnNewPagebooleanno (type experience, schema experienceItemSchema at customSections[])default: falseIf true, the section always begins on a new page.
customSections[].idstringyes (type experience, schema experienceItemSchema at customSections[])The unique identifier for the custom section. Usually generated as a UUID.
customSections[].typestringyes (type experience, schema experienceItemSchema at customSections[])The type of items this custom section contains. Determines which item schema and form fields to use.
customSections[].itemsarrayyes (type experience, schema experienceItemSchema at customSections[])The items to display in the custom section. Items follow the schema of the section type.
customSections[].items[]object— (type experience, schema experienceItemSchema at customSections[])
customSections[].items[].idstringyes (type experience, schema experienceItemSchema at customSections[])The unique identifier for the item. Usually generated as a UUID.
customSections[].items[].hiddenbooleanyes (type experience, schema experienceItemSchema at customSections[])Whether to hide the item from the resume.
customSections[].items[].companystringyes (type experience, schema experienceItemSchema at customSections[])minLength: 1The name of the company or organization.
customSections[].items[].positionstringyes (type experience, schema experienceItemSchema at customSections[])The position held at the company or organization. Used when there is only a single role. If multiple roles are provided in the 'roles' field, this serves as a summary title or can be left blank.
customSections[].items[].locationstringyes (type experience, schema experienceItemSchema at customSections[])The location of the company or organization.
customSections[].items[].periodstringyes (type experience, schema experienceItemSchema at customSections[])The overall period of time at the company. When multiple roles are used, this should reflect the total tenure.
customSections[].items[].websiteobjectno (type experience, schema experienceItemSchema at customSections[])default: {"url":"","label":"","inlineLink":false}The website of the company or organization, if any.
customSections[].items[].website.urlstringyes (type experience, schema experienceItemSchema at customSections[])The URL to show as a link. Must be a valid URL with a protocol (http:// or https://).
customSections[].items[].website.labelstringyes (type experience, schema experienceItemSchema at customSections[])The label to display for the URL. Leave blank to display the URL as-is.
customSections[].items[].website.inlineLinkbooleanno (type experience, schema experienceItemSchema at customSections[])default: falseIf true, the website URL is rendered as a hyperlink on the title instead of a separate link at the bottom.
customSections[].items[].descriptionstringyes (type experience, schema experienceItemSchema at customSections[])The description of the experience. This should be a HTML-formatted string.
customSections[].items[].rolesarrayno (type experience, schema experienceItemSchema at customSections[])default: []List of individual roles held at this company to show career progression.
customSections[].items[].roles[]object— (type experience, schema experienceItemSchema at customSections[])
customSections[].items[].roles[].idstringyes (type experience, schema experienceItemSchema at customSections[])The unique identifier for the role. Usually generated as a UUID.
customSections[].items[].roles[].positionstringyes (type experience, schema experienceItemSchema at customSections[])The position or job title for this role.
customSections[].items[].roles[].periodstringyes (type experience, schema experienceItemSchema at customSections[])The period of time this role was held.
customSections[].items[].roles[].descriptionstringyes (type experience, schema experienceItemSchema at customSections[])The description of this specific role. This should be a HTML-formatted string.
customSections[]object— (type education, schema educationItemSchema at customSections[])
customSections[].titlestringyes (type education, schema educationItemSchema at customSections[])The title of the section.
customSections[].iconstringno (type education, schema educationItemSchema at customSections[])default: ""Phosphor icon name to display before the section title in the PDF output. Empty string uses the default section icon; 'none' hides the icon.
customSections[].columnsintegerno (type education, schema educationItemSchema at customSections[])minimum: 1; maximum: 6; default: 1The number of columns the section should span across.
customSections[].hiddenbooleanyes (type education, schema educationItemSchema at customSections[])Whether to hide the section from the resume.
customSections[].keepTogetherbooleanno (type education, schema educationItemSchema at customSections[])default: falseIf true, the section is kept on a single page instead of splitting across a page break.
customSections[].startOnNewPagebooleanno (type education, schema educationItemSchema at customSections[])default: falseIf true, the section always begins on a new page.
customSections[].idstringyes (type education, schema educationItemSchema at customSections[])The unique identifier for the custom section. Usually generated as a UUID.
customSections[].typestringyes (type education, schema educationItemSchema at customSections[])The type of items this custom section contains. Determines which item schema and form fields to use.
customSections[].itemsarrayyes (type education, schema educationItemSchema at customSections[])The items to display in the custom section. Items follow the schema of the section type.
customSections[].items[]object— (type education, schema educationItemSchema at customSections[])
customSections[].items[].idstringyes (type education, schema educationItemSchema at customSections[])The unique identifier for the item. Usually generated as a UUID.
customSections[].items[].hiddenbooleanyes (type education, schema educationItemSchema at customSections[])Whether to hide the item from the resume.
customSections[].items[].schoolstringyes (type education, schema educationItemSchema at customSections[])minLength: 1The name of the school or institution.
customSections[].items[].degreestringyes (type education, schema educationItemSchema at customSections[])The degree or qualification obtained.
customSections[].items[].areastringyes (type education, schema educationItemSchema at customSections[])The area of study or specialization.
customSections[].items[].gradestringyes (type education, schema educationItemSchema at customSections[])The grade or score achieved.
customSections[].items[].locationstringyes (type education, schema educationItemSchema at customSections[])The location of the school or institution.
customSections[].items[].periodstringyes (type education, schema educationItemSchema at customSections[])The period of time the education was obtained over.
customSections[].items[].websiteobjectno (type education, schema educationItemSchema at customSections[])default: {"url":"","label":"","inlineLink":false}The website of the school or institution, if any.
customSections[].items[].website.urlstringyes (type education, schema educationItemSchema at customSections[])The URL to show as a link. Must be a valid URL with a protocol (http:// or https://).
customSections[].items[].website.labelstringyes (type education, schema educationItemSchema at customSections[])The label to display for the URL. Leave blank to display the URL as-is.
customSections[].items[].website.inlineLinkbooleanno (type education, schema educationItemSchema at customSections[])default: falseIf true, the website URL is rendered as a hyperlink on the title instead of a separate link at the bottom.
customSections[].items[].descriptionstringyes (type education, schema educationItemSchema at customSections[])The description of the education. This should be a HTML-formatted string.
customSections[]object— (type projects, schema projectItemSchema at customSections[])
customSections[].titlestringyes (type projects, schema projectItemSchema at customSections[])The title of the section.
customSections[].iconstringno (type projects, schema projectItemSchema at customSections[])default: ""Phosphor icon name to display before the section title in the PDF output. Empty string uses the default section icon; 'none' hides the icon.
customSections[].columnsintegerno (type projects, schema projectItemSchema at customSections[])minimum: 1; maximum: 6; default: 1The number of columns the section should span across.
customSections[].hiddenbooleanyes (type projects, schema projectItemSchema at customSections[])Whether to hide the section from the resume.
customSections[].keepTogetherbooleanno (type projects, schema projectItemSchema at customSections[])default: falseIf true, the section is kept on a single page instead of splitting across a page break.
customSections[].startOnNewPagebooleanno (type projects, schema projectItemSchema at customSections[])default: falseIf true, the section always begins on a new page.
customSections[].idstringyes (type projects, schema projectItemSchema at customSections[])The unique identifier for the custom section. Usually generated as a UUID.
customSections[].typestringyes (type projects, schema projectItemSchema at customSections[])The type of items this custom section contains. Determines which item schema and form fields to use.
customSections[].itemsarrayyes (type projects, schema projectItemSchema at customSections[])The items to display in the custom section. Items follow the schema of the section type.
customSections[].items[]object— (type projects, schema projectItemSchema at customSections[])
customSections[].items[].idstringyes (type projects, schema projectItemSchema at customSections[])The unique identifier for the item. Usually generated as a UUID.
customSections[].items[].hiddenbooleanyes (type projects, schema projectItemSchema at customSections[])Whether to hide the item from the resume.
customSections[].items[].namestringyes (type projects, schema projectItemSchema at customSections[])minLength: 1The name of the project.
customSections[].items[].periodstringyes (type projects, schema projectItemSchema at customSections[])The period of time the project was worked on.
customSections[].items[].websiteobjectno (type projects, schema projectItemSchema at customSections[])default: {"url":"","label":"","inlineLink":false}The link to the project, if any.
customSections[].items[].website.urlstringyes (type projects, schema projectItemSchema at customSections[])The URL to show as a link. Must be a valid URL with a protocol (http:// or https://).
customSections[].items[].website.labelstringyes (type projects, schema projectItemSchema at customSections[])The label to display for the URL. Leave blank to display the URL as-is.
customSections[].items[].website.inlineLinkbooleanno (type projects, schema projectItemSchema at customSections[])default: falseIf true, the website URL is rendered as a hyperlink on the title instead of a separate link at the bottom.
customSections[].items[].descriptionstringyes (type projects, schema projectItemSchema at customSections[])The description of the project. This should be a HTML-formatted string.
customSections[]object— (type skills, schema skillItemSchema at customSections[])
customSections[].titlestringyes (type skills, schema skillItemSchema at customSections[])The title of the section.
customSections[].iconstringno (type skills, schema skillItemSchema at customSections[])default: ""Phosphor icon name to display before the section title in the PDF output. Empty string uses the default section icon; 'none' hides the icon.
customSections[].columnsintegerno (type skills, schema skillItemSchema at customSections[])minimum: 1; maximum: 6; default: 1The number of columns the section should span across.
customSections[].hiddenbooleanyes (type skills, schema skillItemSchema at customSections[])Whether to hide the section from the resume.
customSections[].keepTogetherbooleanno (type skills, schema skillItemSchema at customSections[])default: falseIf true, the section is kept on a single page instead of splitting across a page break.
customSections[].startOnNewPagebooleanno (type skills, schema skillItemSchema at customSections[])default: falseIf true, the section always begins on a new page.
customSections[].idstringyes (type skills, schema skillItemSchema at customSections[])The unique identifier for the custom section. Usually generated as a UUID.
customSections[].typestringyes (type skills, schema skillItemSchema at customSections[])The type of items this custom section contains. Determines which item schema and form fields to use.
customSections[].itemsarrayyes (type skills, schema skillItemSchema at customSections[])The items to display in the custom section. Items follow the schema of the section type.
customSections[].items[]object— (type skills, schema skillItemSchema at customSections[])
customSections[].items[].idstringyes (type skills, schema skillItemSchema at customSections[])The unique identifier for the item. Usually generated as a UUID.
customSections[].items[].hiddenbooleanyes (type skills, schema skillItemSchema at customSections[])Whether to hide the item from the resume.
customSections[].items[].iconstringyes (type skills, schema skillItemSchema at customSections[])The icon to display for the custom field. Must be a valid icon name from @phosphor-icons/web icon set, or an empty string to hide. Default to '' (empty string) when unsure which icons are available.
customSections[].items[].iconColorstringno (type skills, schema skillItemSchema at customSections[])default: ""Custom color for the icon, defined as rgba(r, g, b, a). Leave blank to use the template default icon color.
customSections[].items[].namestringyes (type skills, schema skillItemSchema at customSections[])minLength: 1The name of the skill.
customSections[].items[].proficiencystringyes (type skills, schema skillItemSchema at customSections[])The proficiency level of the skill. Can be any text, such as 'Beginner', 'Intermediate', 'Advanced', etc.
customSections[].items[].levelnumberno (type skills, schema skillItemSchema at customSections[])minimum: 0; maximum: 5; default: 0The proficiency level of the skill, defined as a number between 0 and 5. If set to 0, the icons displaying the level will be hidden.
customSections[].items[].keywordsarrayno (type skills, schema skillItemSchema at customSections[])default: []The keywords associated with the skill, if any. These are displayed as tags below the name.
customSections[].items[].keywords[]string— (type skills, schema skillItemSchema at customSections[])
customSections[]object— (type languages, schema languageItemSchema at customSections[])
customSections[].titlestringyes (type languages, schema languageItemSchema at customSections[])The title of the section.
customSections[].iconstringno (type languages, schema languageItemSchema at customSections[])default: ""Phosphor icon name to display before the section title in the PDF output. Empty string uses the default section icon; 'none' hides the icon.
customSections[].columnsintegerno (type languages, schema languageItemSchema at customSections[])minimum: 1; maximum: 6; default: 1The number of columns the section should span across.
customSections[].hiddenbooleanyes (type languages, schema languageItemSchema at customSections[])Whether to hide the section from the resume.
customSections[].keepTogetherbooleanno (type languages, schema languageItemSchema at customSections[])default: falseIf true, the section is kept on a single page instead of splitting across a page break.
customSections[].startOnNewPagebooleanno (type languages, schema languageItemSchema at customSections[])default: falseIf true, the section always begins on a new page.
customSections[].idstringyes (type languages, schema languageItemSchema at customSections[])The unique identifier for the custom section. Usually generated as a UUID.
customSections[].typestringyes (type languages, schema languageItemSchema at customSections[])The type of items this custom section contains. Determines which item schema and form fields to use.
customSections[].itemsarrayyes (type languages, schema languageItemSchema at customSections[])The items to display in the custom section. Items follow the schema of the section type.
customSections[].items[]object— (type languages, schema languageItemSchema at customSections[])
customSections[].items[].idstringyes (type languages, schema languageItemSchema at customSections[])The unique identifier for the item. Usually generated as a UUID.
customSections[].items[].hiddenbooleanyes (type languages, schema languageItemSchema at customSections[])Whether to hide the item from the resume.
customSections[].items[].languagestringyes (type languages, schema languageItemSchema at customSections[])minLength: 1The name of the language the author knows.
customSections[].items[].fluencystringyes (type languages, schema languageItemSchema at customSections[])The fluency level of the language. Can be any text, such as 'Native', 'Fluent', 'Conversational', etc. or can also be a CEFR level (A1, A2, B1, B2, C1, C2).
customSections[].items[].levelnumberno (type languages, schema languageItemSchema at customSections[])minimum: 0; maximum: 5; default: 0The proficiency level of the language, defined as a number between 0 and 5. If set to 0, the icons displaying the level will be hidden.
customSections[]object— (type interests, schema interestItemSchema at customSections[])
customSections[].titlestringyes (type interests, schema interestItemSchema at customSections[])The title of the section.
customSections[].iconstringno (type interests, schema interestItemSchema at customSections[])default: ""Phosphor icon name to display before the section title in the PDF output. Empty string uses the default section icon; 'none' hides the icon.
customSections[].columnsintegerno (type interests, schema interestItemSchema at customSections[])minimum: 1; maximum: 6; default: 1The number of columns the section should span across.
customSections[].hiddenbooleanyes (type interests, schema interestItemSchema at customSections[])Whether to hide the section from the resume.
customSections[].keepTogetherbooleanno (type interests, schema interestItemSchema at customSections[])default: falseIf true, the section is kept on a single page instead of splitting across a page break.
customSections[].startOnNewPagebooleanno (type interests, schema interestItemSchema at customSections[])default: falseIf true, the section always begins on a new page.
customSections[].idstringyes (type interests, schema interestItemSchema at customSections[])The unique identifier for the custom section. Usually generated as a UUID.
customSections[].typestringyes (type interests, schema interestItemSchema at customSections[])The type of items this custom section contains. Determines which item schema and form fields to use.
customSections[].itemsarrayyes (type interests, schema interestItemSchema at customSections[])The items to display in the custom section. Items follow the schema of the section type.
customSections[].items[]object— (type interests, schema interestItemSchema at customSections[])
customSections[].items[].idstringyes (type interests, schema interestItemSchema at customSections[])The unique identifier for the item. Usually generated as a UUID.
customSections[].items[].hiddenbooleanyes (type interests, schema interestItemSchema at customSections[])Whether to hide the item from the resume.
customSections[].items[].iconstringyes (type interests, schema interestItemSchema at customSections[])The icon to display for the custom field. Must be a valid icon name from @phosphor-icons/web icon set, or an empty string to hide. Default to '' (empty string) when unsure which icons are available.
customSections[].items[].iconColorstringno (type interests, schema interestItemSchema at customSections[])default: ""Custom color for the icon, defined as rgba(r, g, b, a). Leave blank to use the template default icon color.
customSections[].items[].namestringyes (type interests, schema interestItemSchema at customSections[])minLength: 1The name of the interest/hobby.
customSections[].items[].keywordsarrayno (type interests, schema interestItemSchema at customSections[])default: []The keywords associated with the interest/hobby, if any. These are displayed as tags below the name.
customSections[].items[].keywords[]string— (type interests, schema interestItemSchema at customSections[])
customSections[]object— (type awards, schema awardItemSchema at customSections[])
customSections[].titlestringyes (type awards, schema awardItemSchema at customSections[])The title of the section.
customSections[].iconstringno (type awards, schema awardItemSchema at customSections[])default: ""Phosphor icon name to display before the section title in the PDF output. Empty string uses the default section icon; 'none' hides the icon.
customSections[].columnsintegerno (type awards, schema awardItemSchema at customSections[])minimum: 1; maximum: 6; default: 1The number of columns the section should span across.
customSections[].hiddenbooleanyes (type awards, schema awardItemSchema at customSections[])Whether to hide the section from the resume.
customSections[].keepTogetherbooleanno (type awards, schema awardItemSchema at customSections[])default: falseIf true, the section is kept on a single page instead of splitting across a page break.
customSections[].startOnNewPagebooleanno (type awards, schema awardItemSchema at customSections[])default: falseIf true, the section always begins on a new page.
customSections[].idstringyes (type awards, schema awardItemSchema at customSections[])The unique identifier for the custom section. Usually generated as a UUID.
customSections[].typestringyes (type awards, schema awardItemSchema at customSections[])The type of items this custom section contains. Determines which item schema and form fields to use.
customSections[].itemsarrayyes (type awards, schema awardItemSchema at customSections[])The items to display in the custom section. Items follow the schema of the section type.
customSections[].items[]object— (type awards, schema awardItemSchema at customSections[])
customSections[].items[].idstringyes (type awards, schema awardItemSchema at customSections[])The unique identifier for the item. Usually generated as a UUID.
customSections[].items[].hiddenbooleanyes (type awards, schema awardItemSchema at customSections[])Whether to hide the item from the resume.
customSections[].items[].titlestringyes (type awards, schema awardItemSchema at customSections[])minLength: 1The title of the award.
customSections[].items[].awarderstringyes (type awards, schema awardItemSchema at customSections[])The awarder of the award.
customSections[].items[].datestringyes (type awards, schema awardItemSchema at customSections[])The date when the award was received.
customSections[].items[].websiteobjectno (type awards, schema awardItemSchema at customSections[])default: {"url":"","label":"","inlineLink":false}The website of the award, if any.
customSections[].items[].website.urlstringyes (type awards, schema awardItemSchema at customSections[])The URL to show as a link. Must be a valid URL with a protocol (http:// or https://).
customSections[].items[].website.labelstringyes (type awards, schema awardItemSchema at customSections[])The label to display for the URL. Leave blank to display the URL as-is.
customSections[].items[].website.inlineLinkbooleanno (type awards, schema awardItemSchema at customSections[])default: falseIf true, the website URL is rendered as a hyperlink on the title instead of a separate link at the bottom.
customSections[].items[].descriptionstringyes (type awards, schema awardItemSchema at customSections[])The description of the award. This should be a HTML-formatted string.
customSections[]object— (type certifications, schema certificationItemSchema at customSections[])
customSections[].titlestringyes (type certifications, schema certificationItemSchema at customSections[])The title of the section.
customSections[].iconstringno (type certifications, schema certificationItemSchema at customSections[])default: ""Phosphor icon name to display before the section title in the PDF output. Empty string uses the default section icon; 'none' hides the icon.
customSections[].columnsintegerno (type certifications, schema certificationItemSchema at customSections[])minimum: 1; maximum: 6; default: 1The number of columns the section should span across.
customSections[].hiddenbooleanyes (type certifications, schema certificationItemSchema at customSections[])Whether to hide the section from the resume.
customSections[].keepTogetherbooleanno (type certifications, schema certificationItemSchema at customSections[])default: falseIf true, the section is kept on a single page instead of splitting across a page break.
customSections[].startOnNewPagebooleanno (type certifications, schema certificationItemSchema at customSections[])default: falseIf true, the section always begins on a new page.
customSections[].idstringyes (type certifications, schema certificationItemSchema at customSections[])The unique identifier for the custom section. Usually generated as a UUID.
customSections[].typestringyes (type certifications, schema certificationItemSchema at customSections[])The type of items this custom section contains. Determines which item schema and form fields to use.
customSections[].itemsarrayyes (type certifications, schema certificationItemSchema at customSections[])The items to display in the custom section. Items follow the schema of the section type.
customSections[].items[]object— (type certifications, schema certificationItemSchema at customSections[])
customSections[].items[].idstringyes (type certifications, schema certificationItemSchema at customSections[])The unique identifier for the item. Usually generated as a UUID.
customSections[].items[].hiddenbooleanyes (type certifications, schema certificationItemSchema at customSections[])Whether to hide the item from the resume.
customSections[].items[].titlestringyes (type certifications, schema certificationItemSchema at customSections[])minLength: 1The title of the certification.
customSections[].items[].issuerstringyes (type certifications, schema certificationItemSchema at customSections[])The issuer of the certification.
customSections[].items[].datestringyes (type certifications, schema certificationItemSchema at customSections[])The date when the certification was received.
customSections[].items[].websiteobjectno (type certifications, schema certificationItemSchema at customSections[])default: {"url":"","label":"","inlineLink":false}The website of the certification, if any.
customSections[].items[].website.urlstringyes (type certifications, schema certificationItemSchema at customSections[])The URL to show as a link. Must be a valid URL with a protocol (http:// or https://).
customSections[].items[].website.labelstringyes (type certifications, schema certificationItemSchema at customSections[])The label to display for the URL. Leave blank to display the URL as-is.
customSections[].items[].website.inlineLinkbooleanno (type certifications, schema certificationItemSchema at customSections[])default: falseIf true, the website URL is rendered as a hyperlink on the title instead of a separate link at the bottom.
customSections[].items[].descriptionstringyes (type certifications, schema certificationItemSchema at customSections[])The description of the certification. This should be a HTML-formatted string.
customSections[]object— (type publications, schema publicationItemSchema at customSections[])
customSections[].titlestringyes (type publications, schema publicationItemSchema at customSections[])The title of the section.
customSections[].iconstringno (type publications, schema publicationItemSchema at customSections[])default: ""Phosphor icon name to display before the section title in the PDF output. Empty string uses the default section icon; 'none' hides the icon.
customSections[].columnsintegerno (type publications, schema publicationItemSchema at customSections[])minimum: 1; maximum: 6; default: 1The number of columns the section should span across.
customSections[].hiddenbooleanyes (type publications, schema publicationItemSchema at customSections[])Whether to hide the section from the resume.
customSections[].keepTogetherbooleanno (type publications, schema publicationItemSchema at customSections[])default: falseIf true, the section is kept on a single page instead of splitting across a page break.
customSections[].startOnNewPagebooleanno (type publications, schema publicationItemSchema at customSections[])default: falseIf true, the section always begins on a new page.
customSections[].idstringyes (type publications, schema publicationItemSchema at customSections[])The unique identifier for the custom section. Usually generated as a UUID.
customSections[].typestringyes (type publications, schema publicationItemSchema at customSections[])The type of items this custom section contains. Determines which item schema and form fields to use.
customSections[].itemsarrayyes (type publications, schema publicationItemSchema at customSections[])The items to display in the custom section. Items follow the schema of the section type.
customSections[].items[]object— (type publications, schema publicationItemSchema at customSections[])
customSections[].items[].idstringyes (type publications, schema publicationItemSchema at customSections[])The unique identifier for the item. Usually generated as a UUID.
customSections[].items[].hiddenbooleanyes (type publications, schema publicationItemSchema at customSections[])Whether to hide the item from the resume.
customSections[].items[].titlestringyes (type publications, schema publicationItemSchema at customSections[])minLength: 1The title of the publication.
customSections[].items[].publisherstringyes (type publications, schema publicationItemSchema at customSections[])The publisher of the publication.
customSections[].items[].datestringyes (type publications, schema publicationItemSchema at customSections[])The date when the publication was published.
customSections[].items[].websiteobjectno (type publications, schema publicationItemSchema at customSections[])default: {"url":"","label":"","inlineLink":false}The link to the publication, if any.
customSections[].items[].website.urlstringyes (type publications, schema publicationItemSchema at customSections[])The URL to show as a link. Must be a valid URL with a protocol (http:// or https://).
customSections[].items[].website.labelstringyes (type publications, schema publicationItemSchema at customSections[])The label to display for the URL. Leave blank to display the URL as-is.
customSections[].items[].website.inlineLinkbooleanno (type publications, schema publicationItemSchema at customSections[])default: falseIf true, the website URL is rendered as a hyperlink on the title instead of a separate link at the bottom.
customSections[].items[].descriptionstringyes (type publications, schema publicationItemSchema at customSections[])The description of the publication. This should be a HTML-formatted string.
customSections[]object— (type volunteer, schema volunteerItemSchema at customSections[])
customSections[].titlestringyes (type volunteer, schema volunteerItemSchema at customSections[])The title of the section.
customSections[].iconstringno (type volunteer, schema volunteerItemSchema at customSections[])default: ""Phosphor icon name to display before the section title in the PDF output. Empty string uses the default section icon; 'none' hides the icon.
customSections[].columnsintegerno (type volunteer, schema volunteerItemSchema at customSections[])minimum: 1; maximum: 6; default: 1The number of columns the section should span across.
customSections[].hiddenbooleanyes (type volunteer, schema volunteerItemSchema at customSections[])Whether to hide the section from the resume.
customSections[].keepTogetherbooleanno (type volunteer, schema volunteerItemSchema at customSections[])default: falseIf true, the section is kept on a single page instead of splitting across a page break.
customSections[].startOnNewPagebooleanno (type volunteer, schema volunteerItemSchema at customSections[])default: falseIf true, the section always begins on a new page.
customSections[].idstringyes (type volunteer, schema volunteerItemSchema at customSections[])The unique identifier for the custom section. Usually generated as a UUID.
customSections[].typestringyes (type volunteer, schema volunteerItemSchema at customSections[])The type of items this custom section contains. Determines which item schema and form fields to use.
customSections[].itemsarrayyes (type volunteer, schema volunteerItemSchema at customSections[])The items to display in the custom section. Items follow the schema of the section type.
customSections[].items[]object— (type volunteer, schema volunteerItemSchema at customSections[])
customSections[].items[].idstringyes (type volunteer, schema volunteerItemSchema at customSections[])The unique identifier for the item. Usually generated as a UUID.
customSections[].items[].hiddenbooleanyes (type volunteer, schema volunteerItemSchema at customSections[])Whether to hide the item from the resume.
customSections[].items[].organizationstringyes (type volunteer, schema volunteerItemSchema at customSections[])minLength: 1The name of the organization or company.
customSections[].items[].locationstringyes (type volunteer, schema volunteerItemSchema at customSections[])The location of the organization or company.
customSections[].items[].periodstringyes (type volunteer, schema volunteerItemSchema at customSections[])The period of time the author was volunteered at the organization or company.
customSections[].items[].websiteobjectno (type volunteer, schema volunteerItemSchema at customSections[])default: {"url":"","label":"","inlineLink":false}The link to the organization or company, if any.
customSections[].items[].website.urlstringyes (type volunteer, schema volunteerItemSchema at customSections[])The URL to show as a link. Must be a valid URL with a protocol (http:// or https://).
customSections[].items[].website.labelstringyes (type volunteer, schema volunteerItemSchema at customSections[])The label to display for the URL. Leave blank to display the URL as-is.
customSections[].items[].website.inlineLinkbooleanno (type volunteer, schema volunteerItemSchema at customSections[])default: falseIf true, the website URL is rendered as a hyperlink on the title instead of a separate link at the bottom.
customSections[].items[].descriptionstringyes (type volunteer, schema volunteerItemSchema at customSections[])The description of the volunteer experience. This should be a HTML-formatted string.
customSections[]object— (type references, schema referenceItemSchema at customSections[])
customSections[].titlestringyes (type references, schema referenceItemSchema at customSections[])The title of the section.
customSections[].iconstringno (type references, schema referenceItemSchema at customSections[])default: ""Phosphor icon name to display before the section title in the PDF output. Empty string uses the default section icon; 'none' hides the icon.
customSections[].columnsintegerno (type references, schema referenceItemSchema at customSections[])minimum: 1; maximum: 6; default: 1The number of columns the section should span across.
customSections[].hiddenbooleanyes (type references, schema referenceItemSchema at customSections[])Whether to hide the section from the resume.
customSections[].keepTogetherbooleanno (type references, schema referenceItemSchema at customSections[])default: falseIf true, the section is kept on a single page instead of splitting across a page break.
customSections[].startOnNewPagebooleanno (type references, schema referenceItemSchema at customSections[])default: falseIf true, the section always begins on a new page.
customSections[].idstringyes (type references, schema referenceItemSchema at customSections[])The unique identifier for the custom section. Usually generated as a UUID.
customSections[].typestringyes (type references, schema referenceItemSchema at customSections[])The type of items this custom section contains. Determines which item schema and form fields to use.
customSections[].itemsarrayyes (type references, schema referenceItemSchema at customSections[])The items to display in the custom section. Items follow the schema of the section type.
customSections[].items[]object— (type references, schema referenceItemSchema at customSections[])
customSections[].items[].idstringyes (type references, schema referenceItemSchema at customSections[])The unique identifier for the item. Usually generated as a UUID.
customSections[].items[].hiddenbooleanyes (type references, schema referenceItemSchema at customSections[])Whether to hide the item from the resume.
customSections[].items[].namestringyes (type references, schema referenceItemSchema at customSections[])minLength: 1The name of the reference, or a note such as 'Available upon request'.
customSections[].items[].positionstringyes (type references, schema referenceItemSchema at customSections[])The position or job title of the reference.
customSections[].items[].websiteobjectno (type references, schema referenceItemSchema at customSections[])default: {"url":"","label":"","inlineLink":false}The website or LinkedIn profile of the reference, if any.
customSections[].items[].website.urlstringyes (type references, schema referenceItemSchema at customSections[])The URL to show as a link. Must be a valid URL with a protocol (http:// or https://).
customSections[].items[].website.labelstringyes (type references, schema referenceItemSchema at customSections[])The label to display for the URL. Leave blank to display the URL as-is.
customSections[].items[].website.inlineLinkbooleanno (type references, schema referenceItemSchema at customSections[])default: falseIf true, the website URL is rendered as a hyperlink on the title instead of a separate link at the bottom.
customSections[].items[].phonestringyes (type references, schema referenceItemSchema at customSections[])The phone number of the reference.
customSections[].items[].descriptionstringyes (type references, schema referenceItemSchema at customSections[])The description of the reference. Can be used to display a quote, a testimonial, etc. This should be a HTML-formatted string.
customSections[]object— (type cover-letter, schema coverLetterItemSchema at customSections[])
customSections[].titlestringyes (type cover-letter, schema coverLetterItemSchema at customSections[])The title of the section.
customSections[].iconstringno (type cover-letter, schema coverLetterItemSchema at customSections[])default: ""Phosphor icon name to display before the section title in the PDF output. Empty string uses the default section icon; 'none' hides the icon.
customSections[].columnsintegerno (type cover-letter, schema coverLetterItemSchema at customSections[])minimum: 1; maximum: 6; default: 1The number of columns the section should span across.
customSections[].hiddenbooleanyes (type cover-letter, schema coverLetterItemSchema at customSections[])Whether to hide the section from the resume.
customSections[].keepTogetherbooleanno (type cover-letter, schema coverLetterItemSchema at customSections[])default: falseIf true, the section is kept on a single page instead of splitting across a page break.
customSections[].startOnNewPagebooleanno (type cover-letter, schema coverLetterItemSchema at customSections[])default: falseIf true, the section always begins on a new page.
customSections[].idstringyes (type cover-letter, schema coverLetterItemSchema at customSections[])The unique identifier for the custom section. Usually generated as a UUID.
customSections[].typestringyes (type cover-letter, schema coverLetterItemSchema at customSections[])The type of items this custom section contains. Determines which item schema and form fields to use.
customSections[].itemsarrayyes (type cover-letter, schema coverLetterItemSchema at customSections[])The items to display in the custom section. Items follow the schema of the section type.
customSections[].items[]object— (type cover-letter, schema coverLetterItemSchema at customSections[])
customSections[].items[].idstringyes (type cover-letter, schema coverLetterItemSchema at customSections[])The unique identifier for the item. Usually generated as a UUID.
customSections[].items[].hiddenbooleanyes (type cover-letter, schema coverLetterItemSchema at customSections[])Whether to hide the item from the resume.
customSections[].items[].recipientstringyes (type cover-letter, schema coverLetterItemSchema at customSections[])The recipient's address block as HTML (name, title, company, address, email).
customSections[].items[].contentstringyes (type cover-letter, schema coverLetterItemSchema at customSections[])The cover letter body as HTML (salutation, paragraphs, closing, signature).
metadataobjectyesMetadata for the resume, such as template, layout, typography, etc. This section describes the overall design and appearance of the resume.
metadata.templatestringnoenum: ["azurill","bronzor","chikorita","ditgar","ditto","gengar","glalie","kakuna","lapras","leafish","meowth","onyx","pikachu","rhyhorn","scizor"]; default: "onyx"The template to use for the resume. Determines the overall design and appearance of the resume.
metadata.layoutobjectyesThe layout of the resume. Determines the structure and arrangement of the sections on the resume.
metadata.layout.sidebarWidthnumbernominimum: 10; maximum: 50; default: 35The width of the sidebar column, defined as a percentage of the page width.
metadata.layout.pagesarrayyesThe pages to display in the layout.
metadata.layout.pages[]object
metadata.layout.pages[].fullWidthbooleanyesWhether the layout of the page should be full width. If true, the main column will span the entire width of the page. This means that there should be no items in the sidebar column.
metadata.layout.pages[].mainarrayyesThe items to display in the main column of the page. A string array of section IDs (experience, education, projects, skills, languages, interests, awards, certifications, publications, volunteer, references, profiles, summary or UUIDs for custom sections).
metadata.layout.pages[].main[]string
metadata.layout.pages[].sidebararrayyesThe items to display in the sidebar column of the page. A string array of section IDs (experience, education, projects, skills, languages, interests, awards, certifications, publications, volunteer, references, profiles, summary or UUIDs for custom sections).
metadata.layout.pages[].sidebar[]string
metadata.pageobjectyesThe page settings of the resume. Determines the margins, format, and locale of the resume.
metadata.page.gapXnumberyesminimum: 0The horizontal gap between the sections of the page, defined in points (pt).
metadata.page.gapYnumberyesminimum: 0The vertical gap between the sections of the page, defined in points (pt).
metadata.page.marginXnumbernominimum: 0; maximum: 100; default: 14The horizontal margin of the page, defined in points (pt).
metadata.page.marginYnumbernominimum: 0; maximum: 100; default: 12The vertical margin of the page, defined in points (pt).
metadata.page.formatstringnoenum: ["a4","letter","free-form"]; default: "a4"The format of the page. Can be 'a4', 'letter', or 'free-form'.
metadata.page.localestringnodefault: "en-US"The locale of the page. Used for displaying pre-translated section headings, if not overridden.
metadata.page.hideLinkUnderlinebooleannodefault: falseWhether to hide the underlines of the links.
metadata.page.hideIconsbooleannodefault: falseWhether to hide the item-level icons (skills, profiles, interests).
metadata.page.hideSectionIconsbooleannodefault: trueWhether to hide the section heading icons displayed before section titles.
metadata.designobjectyesThe design settings of the resume. Determines the colors, level designs, and typography of the resume.
metadata.design.levelobjectyes
metadata.design.level.iconstringyesThe icon to display for the custom field. Must be a valid icon name from @phosphor-icons/web icon set, or an empty string to hide. Default to '' (empty string) when unsure which icons are available.
metadata.design.level.typestringyesenum: ["hidden","circle","square","rectangle","rectangle-full","progress-bar","icon"]The type of the level design. 'hidden' will hide the level design, 'circle' will display a circle, 'square' will display a square, 'rectangle' will display a rectangle, 'rectangle-full' will display a full rectangle, 'progress-bar' will display a progress bar, and 'icon' will display an icon. If 'icon' is selected, the icon to display should be specified in the 'icon' field.
metadata.design.colorsobjectyes
metadata.design.colors.primarystringyesThe primary color of the design, defined as rgba(r, g, b, a).
metadata.design.colors.textstringyesThe text color of the design, defined as rgba(r, g, b, a). Usually set to black: rgba(0, 0, 0, 1).
metadata.design.colors.backgroundstringyesThe background color of the design, defined as rgba(r, g, b, a). Usually set to white: rgba(255, 255, 255, 1).
metadata.typographyobjectyesThe typography settings of the resume. Determines the fonts and sizes of the body and headings of the resume.
metadata.typography.bodyobjectyesThe typography for the body of the resume.
metadata.typography.body.fontFamilystringyesThe family of the font to use. Must be a supported resume font.
metadata.typography.body.fontWeightsarraynodefault: ["400"]The weight of the font, defined as a number between 100 and 900. Default to 400 when unsure if the weight is available in the font.
metadata.typography.body.fontWeights[]stringenum: ["100","200","300","400","500","600","700","800","900"]
metadata.typography.body.fontSizenumbernominimum: 6; maximum: 24; default: 11The size of the font to use, defined in points (pt).
metadata.typography.body.lineHeightnumbernominimum: 0.5; maximum: 4; default: 1.5The line height of the font to use, defined as a multiplier of the font size (e.g. 1.5 for 1.5x).
metadata.typography.headingobjectyesThe typography for the headings of the resume.
metadata.typography.heading.fontFamilystringyesThe family of the font to use. Must be a supported resume font.
metadata.typography.heading.fontWeightsarraynodefault: ["400"]The weight of the font, defined as a number between 100 and 900. Default to 400 when unsure if the weight is available in the font.
metadata.typography.heading.fontWeights[]stringenum: ["100","200","300","400","500","600","700","800","900"]
metadata.typography.heading.fontSizenumbernominimum: 6; maximum: 24; default: 11The size of the font to use, defined in points (pt).
metadata.typography.heading.lineHeightnumbernominimum: 0.5; maximum: 4; default: 1.5The line height of the font to use, defined as a multiplier of the font size (e.g. 1.5 for 1.5x).
metadata.notesstringyesPersonal notes for the resume. Can be used to add any additional information or instructions for the resume. These notes are not displayed on the resume, they are only visible to the author of the resume when editing the resume. This should be a HTML-formatted string.
metadata.styleRulesarraynodefault: []Structured style rules that target semantic resume sections and slots for React PDF rendering.
metadata.styleRules[]any
metadata.stylesheetobjectno
metadata.stylesheet.modestringyesenum: ["legacy","semantic"]
metadata.stylesheet.sourceobjectyes
metadata.stylesheet.source.languageVersionintegeryesexclusiveMinimum: 0; maximum: 9007199254740991
metadata.stylesheet.source.textstringyes
metadata.stylesheet.appliedobjectyes
metadata.stylesheet.applied.languageVersionintegeryesexclusiveMinimum: 0; maximum: 9007199254740991
metadata.stylesheet.applied.textstringyes