Schema Reference

This section defines all data entities used across our API. Understanding these schemas is crucial for correctly interacting with the API.

Organization

An organization may represent a company, institution or anyone using the FlashApply API.

{
  "id": "example_string",
  "name": "example_string",
  "email": "example_string",
  "phone": "example_string",
  "isApproved": true,
  "website": "example_string",
  "createdAt": "2025-07-26T12:00:00Z",
  "updatedAt": "2025-07-26T12:00:00Z",
  "domain": {
    "name": "example_string",
    "verified": true,
    "requestedAt": "2025-07-26T12:00:00Z"
  },
  "locations": [
    {
      "id": "example_string",
      "name": "example_string",
      "about": "example_string",
      "country": "example_string",
      "region": "example_string",
      "city": "example_string"
    }
  ],
  "settings": {
    "logoUrl": "example_string",
    "webhook": {
      "enabled": true,
      "url": "example_string",
      "events": [
        "resume.parsed"
      ]
    }
  }
}

Fields

Field	Type	Required	Description
id	string	Yes	Unique identifier for the organization
name	string	Yes	The organization name
email	string	Yes	The organization email address
phone	string	Yes	The organization phone number
isApproved	boolean	Yes	Indicates whether the organization has been approved
website	string	Yes	The organization website URL
createdAt	string date-time	No	Timestamp when the organization was created
updatedAt	string date-time	No	Timestamp when the organization was last updated
domain	object DomainVerification	Yes	Domain verification metadata
locations	array OrganizationLocation	Yes	List of physical or operational locations for the organization
settings	object OrganizationSettings	Yes	Organization specific settings

Organization Location

Represents a physical or operational location associated with an organization.

{
  "id": "example_string",
  "name": "example_string",
  "about": "example_string",
  "country": "example_string",
  "region": "example_string",
  "city": "example_string"
}

Fields

Field	Type	Required	Description
id	string	Yes	Unique identifier for the location
name	string	Yes	Name of the location (must be unique within the organization)
about	string	Yes	Brief description of the location
country	string	Yes	Country where the location is based
region	string	Yes	Region or state of the location
city	string	Yes	City of the location

Domain Verification

Represents the domain verification status for an organization, including the domain name and verification status.

{
  "name": "example_string",
  "verified": true,
  "requestedAt": "2025-07-26T12:00:00Z"
}

Fields

Field	Type	Required	Description
name	string	Yes	Domain name linked to the organization (e.g., example.com)
verified	boolean	Yes	Whether the domain has been successfully verified
requestedAt	string date-time	No	Unix timestamp indicating when verification was requested

Organization Settings

Represents organization specific settings and configurations.

{
  "logoUrl": "example_string",
  "webhook": {
    "enabled": true,
    "url": "example_string",
    "events": [
      "resume.parsed"
    ]
  }
}

Fields

Field	Type	Required	Description
logoUrl	string	No	URL to the organization's logo used for display purposes
webhook	object Webhook	No	Webhook configuration for receiving event notifications

Member

Represents a member within an organization, such as an admin, recruiters or employees.

{
  "id": "example_string",
  "createdAt": "2025-07-26T12:00:00Z",
  "updatedAt": "2025-07-26T12:00:00Z",
  "firstName": "example_string",
  "lastName": "example_string",
  "email": "example_string",
  "organizationId": "example_string",
  "locations": [
    {
      "locationId": "example_string",
      "role": [
        "admin",
        "editor",
        "viewer"
      ]
    }
  ],
  "isPrimary": true,
  "isActive": true,
  "settings": {
    "defaultLocationId": "example_string",
    "profilePictureUrl": "example_string"
  }
}

Fields

Field	Type	Required	Description
id	string	Yes	Unique identifier for the member
createdAt	string date-time	Yes	Timestamp when the member was created
updatedAt	string date-time	Yes	Timestamp when the member was last updated
firstName	string	Yes	Member's first name
lastName	string	Yes	Member's last name
email	string	Yes	Member's email address
organizationId	string	Yes	ID of the organization this member belongs to
locations	array MemberLocation	Yes	List of locations the member is assigned to, along with their role at each location
isPrimary	boolean	Yes	Indicates whether the member is the primary organization holder or main contact for the organization
isActive	boolean	No	Indicates whether the member is currently active within the organization
settings	object MemberSettings	Yes	Member-specific settings such as profile picture and default location

Member Location

Represents the role a member of an organization holds at a specific organization location.

{
  "locationId": "example_string",
  "role": [
    "admin",
    "editor",
    "viewer"
  ]
}

Fields

Field	Type	Required	Description
locationId	string	Yes	ID of the location the org's member is assigned to
role	string MemberRoles	Yes	Role assigned to the org's memeber at the specified location

Member Roles

Defines the allowed roles that an org's member can hold within a location.

[
  "admin",
  "editor",
  "viewer"
]

Fields

Field	Required	Description
admin	No	Has full administrative access across the organization, including managing other members, locations, and settings.
editor	No	Can create, update, and delete resources such as jobs and candidates, but cannot manage other members or organization settings.
viewer	No	Has read-only access to data across assigned locations.

Member Settings

Represents customizable settings for an org's member, such as login preferences and profile configuration.

{
  "defaultLocationId": "example_string",
  "profilePictureUrl": "example_string"
}

Fields

Field	Type	Required	Description
defaultLocationId	string	No	ID of the default location selected by the org's member when signing in
profilePictureUrl	string	No	URL to the org's member profile picture for use in dashboards

Candidate

Represents a candidate added or managed by an organization. Includes basic contact details and online profiles.

{
  "id": "example_string",
  "createdAt": "2025-07-26T12:00:00Z",
  "updatedAt": "2025-07-26T12:00:00Z",
  "organizationId": "example_string",
  "memberId": "example_string",
  "name": "example_string",
  "firstName": "example_string",
  "lastName": "example_string",
  "email": "example_string",
  "phone": "example_string",
  "profiles": [
    {
      "__id": "example_string",
      "network": "example_string",
      "username": "example_string",
      "url": "example_string"
    }
  ]
}

Fields

Field	Type	Required	Description
id	string	Yes	Unique identifier for the candidate
createdAt	string date-time	Yes	Timestamp when the candidate was created
updatedAt	string date-time	Yes	Timestamp when the candidate was last updated
organizationId	string	Yes	ID of the organization that owns the candidate record
memberId	string	Yes	ID of the org's member who added or owns the candidate
name	string	Yes	Full name of the candidate
firstName	string	No	First name of the candidate (optional override of parsed name)
lastName	string	No	Last name of the candidate (optional override of parsed name)
email	string	Yes	Email address of the candidate
phone	string	No	Phone number of the candidate
profiles	array CandidateProfile	Yes	List of public or social profiles associated with the candidate

Candidate Profile

Represents a public or social profile associated with a candidate (e.g., LinkedIn, GitHub).

{
  "__id": "example_string",
  "network": "example_string",
  "username": "example_string",
  "url": "example_string"
}

Fields

Field	Type	Required	Description
__id	string	Yes	Unique identifier for the profile entry
network	string	Yes	Name of the platform or network (e.g., LinkedIn, GitHub)
username	string	Yes	Username or handle used on the platform
url	string	Yes	Direct URL to the candidate's profile on the platform

Webhook

Represents the webhook configuration used by an organization to receive event notifications.

{
  "enabled": true,
  "url": "example_string",
  "events": [
    "resume.parsed"
  ]
}

Fields

Field	Type	Required	Description
enabled	boolean	Yes	Whether the webhook is currently active
url	string	Yes	Target URL where webhook events will be delivered
events	array	Yes	List of subscribed events. Supported: ["resume.parsed"]

Webhook Events

Lists all the supported webhook events that can be subscribed to in your webhook configuration.

[
  "resume.parsed",
  "job.posted",
  "candidate.applied"
]

Fields

Field	Required	Description
resume.parsed	No	Triggered when a resume has been successfully parsed.
job.posted	No	Triggered when a new job is posted.
candidate.applied	No	Triggered when a candidate applies to a job.

Job

Represents a structured job within the system, including metadata, parsed content, and posting details.

{
  "id": "example_string",
  "createdAt": "2025-07-26T12:00:00Z",
  "updatedAt": "2025-07-26T12:00:00Z",
  "organizationId": "example_string",
  "memberId": "example_string",
  "locationId": "example_string",
  "rawText": "example_string",
  "parseStatus": "example_string",
  "title": "example_string",
  "postedAt": "2025-07-26T12:00:00Z",
  "jobUrl": "example_string",
  "jobId": "example_string",
  "applicationDeadline": "example_string",
  "applicationInstructions": "example_string",
  "industry": "example_string",
  "tags": [],
  "languageRequirements": [],
  "company": {
    "name": "example_string",
    "about": "example_string"
  },
  "location": [
    {
      "country": "example_string",
      "region": "example_string",
      "city": "example_string",
      "fullAddress": "example_string"
    }
  ],
  "employmentType": [
    "Full Time",
    "Part Time",
    "Contract",
    "Internship"
  ],
  "experienceLevel": [
    "Entry Level",
    "Mid Level",
    "Mid-Senior Level",
    "Senior Level",
    "Executive"
  ],
  "educationLevel": [
    [
      "Bachelors",
      "Masters",
      "Doctorate"
    ]
  ],
  "salaryRange": {
    "currencyCode": "example_string",
    "currencySymbol": "example_string",
    "text": "example_string",
    "low": 123,
    "high": 123
  },
  "remoteWorkOption": [
    "Onsite",
    "Hybrid",
    "Remote Anywhere (Global)",
    "Remote Nationwide (Country)",
    "Remote Regional/State"
  ],
  "description": "example_string",
  "requirements": [],
  "responsibilities": [],
  "benefits": [],
  "department": [],
  "skills": [],
  "mustHaveSkills": [],
  "minimumRequirements": [],
  "niceToHaveSkills": [],
  "preferredQualifications": []
}

Fields

Field	Type	Required	Description
id	string	Yes	Unique identifier for the job
createdAt	string date-time	Yes	Timestamp when the job was created
updatedAt	string date-time	Yes	Timestamp when the job was last updated
organizationId	string	Yes	ID of the organization that owns the job
memberId	string	Yes	ID of the org's member who added or imported the job
locationId	string	Yes	ID of the primary organization location associated with the job
rawText	string	Yes	Original raw text of the job post
parseStatus	string	Yes	Current parse status (e.g., 'pending', 'success', 'error')
title	string	Yes	Job title
postedAt	string date-time	No	ISO timestamp of when the job was originally posted
jobUrl	string	No	URL of the original job posting
jobId	string	No	Original job identifier from the source system
applicationDeadline	string	No	Application deadline if provided
applicationInstructions	string	No	Instructions for how to apply
industry	string	No	Industry of the job
tags	array	No	Custom tags or keywords associated with the job
languageRequirements	array	No	Languages required for the job
company	object Company	Yes	Information about the company offering the job
location	array JobLocation	Yes	List of job locations
employmentType	string EmploymentTypes	No	Type of employment (e.g., full-time, contract)
experienceLevel	string ExperienceLevels	No	Required experience level (e.g., entry-level, senior)
educationLevel	array EducationLevels	No	Minimum education levels required or preferred for the job. See Education Levels.
salaryRange	object SalaryRange	No	Compensation details for the job
remoteWorkOption	string RemoteWorkOptions	No	Describes the remote work policy for the job. See Remote Work Options.
description	string	Yes	Detailed job description
requirements	array	Yes	List of job requirements
responsibilities	array	Yes	List of key responsibilities
benefits	array	Yes	List of job benefits
department	array	No	Department(s) the job belongs to
skills	array	No	General skills required for the role
mustHaveSkills	array	No	Critical must-have skills
minimumRequirements	array	No	Minimum qualifications or baseline requirements
niceToHaveSkills	array	No	Nice-to-have or optional skills
preferredQualifications	array	No	Preferred qualifications or bonuses

Employment Types

Defines the allowed employment types for a job post.

[
  "Full Time",
  "Part Time",
  "Contract",
  "Internship"
]

Fields

Field	Required	Description
Full Time	No	Standard full-time employment
Part Time	No	Part-time or reduced-hour employment
Contract	No	Contract-based or temporary employment
Internship	No	Internship or training program role

Experience Levels

Defines the level of experience required for a job post.

[
  "Entry Level",
  "Mid Level",
  "Mid-Senior Level",
  "Senior Level",
  "Executive"
]

Fields

Field	Required	Description
Entry Level	No	Typically for candidates with less than 1 year of experience
Mid Level	No	Requires 1 to 4 years of professional experience
Mid-Senior Level	No	Requires substantial experience, typically 4–7 years
Senior Level	No	Senior-level roles with significant responsibilities
Executive	No	Executive or leadership-level roles (Director, VP, C-Level)

Education Levels

Specifies the minimum education level required or preferred for a job.

[
  "Bachelors",
  "Masters",
  "Doctorate"
]

Fields

Field	Required	Description
Bachelors	No	Bachelor's degree or equivalent qualification
Masters	No	Master's degree or equivalent qualification
Doctorate	No	Doctorate or PhD-level qualification

Remote Work Options

Specifies the available remote work arrangements for a job post.

[
  "Onsite",
  "Hybrid",
  "Remote Anywhere (Global)",
  "Remote Nationwide (Country)",
  "Remote Regional/State"
]

Fields

Field	Required	Description
Onsite	No	The role requires employees to work on location at the company office.
Hybrid	No	A mix of onsite and remote work — employees split their time between both.
Remote Anywhere (Global)	No	Employees can work from anywhere globally. No geographic restrictions apply.
Remote Nationwide (Country)	No	Employees can work remotely from anywhere within the company’s home country.
Remote Regional/State	No	Employees can work remotely from a specific region or state within the country.

Company

Represents basic company information associated with a job post.

{
  "name": "example_string",
  "about": "example_string"
}

Fields

Field	Type	Required	Description
name	string	Yes	Name of the company offering the job
about	string	No	Short description or summary about the company

Salary Range

Represents the compensation range for a job, including currency and value.

{
  "currencyCode": "example_string",
  "currencySymbol": "example_string",
  "text": "example_string",
  "low": 123,
  "high": 123
}

Fields

Field	Type	Required	Description
currencyCode	string	Yes	Currency code (e.g., USD, CAD)
currencySymbol	string	Yes	Currency symbol (e.g., $, CA$)
text	string	Yes	Human-readable representation of the salary range (e.g., '$80k–$100k/year')
low	number	Yes	Minimum value in the salary range
high	number	Yes	Maximum value in the salary range

Job Location

Represents a physical or geographical location associated with the job posting.

{
  "country": "example_string",
  "region": "example_string",
  "city": "example_string",
  "fullAddress": "example_string"
}

Fields

Field	Type	Required	Description
country	string	Yes	Country where the job is located (e.g., Canada)
region	string	Yes	Province, state, or region of the job location
city	string	No	City where the job is located
fullAddress	string	No	Full address of the job location (if applicable)

Resume

Represents a parsed resume and its metadata.

{
  "id": "example_string",
  "createdAt": "2025-07-26T12:00:00Z",
  "updatedAt": "2025-07-26T12:00:00Z",
  "organizationId": "example_string",
  "memberId": "example_string",
  "candidateId": "example_string",
  "locationId": "example_string",
  "url": "example_string",
  "name": "example_string",
  "rawText": "example_string",
  "mimetype": "example_string",
  "personalInfo": {
    "name": "example_string",
    "occupation": "example_string",
    "email": "example_string",
    "phone": "example_string",
    "url": "example_string",
    "summary": "example_string",
    "location": {},
    "profiles": []
  },
  "work": [
    {
      "__id": "example_string",
      "company": "example_string",
      "position": "example_string",
      "location": "example_string",
      "url": "example_string",
      "startDate": "example_string",
      "endDate": "example_string",
      "summary": "example_string",
      "highlights": [
        {
          "__id": "example_string",
          "value": "example_string"
        }
      ]
    }
  ],
  "volunteer": [
    {
      "__id": "example_string",
      "organization": "example_string",
      "position": "example_string",
      "startDate": "example_string",
      "endDate": "example_string",
      "summary": "example_string",
      "highlights": [
        {
          "__id": "example_string",
          "value": "example_string"
        }
      ]
    }
  ],
  "education": [
    {
      "__id": "example_string",
      "institution": "example_string",
      "area": "example_string",
      "studyType": "example_string",
      "startDate": "example_string",
      "endDate": "example_string",
      "score": "example_string",
      "summary": "example_string",
      "courses": []
    }
  ],
  "projects": [
    {
      "__id": "example_string",
      "name": "example_string",
      "startDate": "example_string",
      "endDate": "example_string",
      "description": "example_string",
      "highlights": [],
      "url": "example_string"
    }
  ],
  "skills": [
    {
      "__id": "example_string",
      "name": "example_string",
      "level": "example_string",
      "keywords": []
    }
  ],
  "languages": [
    {
      "__id": "example_string",
      "language": "example_string",
      "fluency": "example_string"
    }
  ],
  "interests": [
    {
      "__id": "example_string",
      "name": "example_string",
      "keywords": []
    }
  ],
  "references": [
    {
      "__id": "example_string",
      "name": "example_string",
      "position": "example_string",
      "company": "example_string",
      "email": "example_string",
      "phone": "example_string",
      "relationship": "example_string"
    }
  ],
  "certificates": [
    {
      "__id": "example_string",
      "name": "example_string",
      "date": "example_string",
      "issuer": "example_string",
      "url": "example_string"
    }
  ],
  "publications": [
    {
      "__id": "example_string",
      "name": "example_string",
      "publisher": "example_string",
      "releaseDate": "example_string",
      "url": "example_string",
      "summary": "example_string"
    }
  ],
  "awards": [
    {
      "__id": "example_string",
      "title": "example_string",
      "date": "example_string",
      "awarder": "example_string",
      "summary": "example_string"
    }
  ]
}

Fields

Field	Type	Required	Description
id	string	Yes	Unique identifier for the resume.
createdAt	string date-time	Yes	Timestamp when the resume was created.
updatedAt	string date-time	No	Timestamp when the resume was deleted (if applicable).
organizationId	string	Yes	ID of the organization that owns the resume.
memberId	string	Yes	ID of the agent that uploaded or owns the resume.
candidateId	string	Yes	ID of the candidate this resume belongs to.
locationId	string	Yes	ID of the organization location associated with the resume.
url	string	Yes	Storage URL where the original resume file is stored.
name	string	Yes	Original file name of the resume.
rawText	string	Yes	Plain text content extracted from the resume.
mimetype	string	Yes	MIME type of the uploaded file (e.g., application/pdf).
personalInfo	object ResumePersonalInfo	Yes	Basic personal information. See `ResumeBasics` schema.
work	array WorkEntry	No	List of work experiences. See `WorkEntry` schema.
volunteer	array VolunteerEntry	No	List of volunteer experiences. See `VolunteerEntry` schema.
education	array EducationEntry	No	List of education entries. See `EducationEntry` schema.
projects	array ProjectEntry	No	List of personal or professional projects. See `ProjectEntry` schema.
skills	array SkillEntry	No	List of skill groups. See `SkillEntry` schema.
languages	array LanguageEntry	No	Languages known. See `LanguageEntry` schema.
interests	array InterestEntry	No	Candidate's interests or hobbies. See `InterestEntry` schema.
references	array ReferenceEntry	No	List of references. See `ReferenceEntry` schema.
certificates	array CertificateEntry	No	Certifications or licenses. See `CertificateEntry` schema.
publications	array PublicationEntry	No	Published works by the candidate. See `PublicationEntry` schema.
awards	array AwardEntry	No	Awards and honors received. See `AwardEntry` schema.

Parse Status

Indicates the parsing status of a resume or job post.

{
  "status": [
    "complete",
    "pending",
    "error"
  ],
  "error": "example_string"
}

Fields

Field	Type	Required	Description
status	string ParseStatusType	Yes
error	string	No	Error message, if parsing failed.

Parse Status Type

Enumerates the possible parsing states of a resume or job post.

[
  "complete",
  "pending",
  "error"
]

Fields

Field	Required	Description
complete	No	Parsing was successful.
pending	No	Parsing is still in progress.
error	No	Parsing failed due to an error.

Resume Personal Info

Contains basic personal information extracted from a resume.

{
  "name": "example_string",
  "occupation": "example_string",
  "email": "example_string",
  "phone": "example_string",
  "url": "example_string",
  "summary": "example_string",
  "location": {},
  "profiles": []
}

Fields

Field	Type	Required	Description
name	string	No	Full name of the candidate
occupation	string	No	Current job title or role
email	string email	No	Primary email address
phone	string	No	Phone number
url	string uri	No	Personal website or portfolio
summary	string	No	Brief professional summary
location	object	No	Candidate's location information
profiles	array	No	Online profiles such as LinkedIn or GitHub

Work Entry

Describes a candidate's past or current employment, including company, role, duration, and key highlights.

{
  "__id": "example_string",
  "company": "example_string",
  "position": "example_string",
  "location": "example_string",
  "url": "example_string",
  "startDate": "example_string",
  "endDate": "example_string",
  "summary": "example_string",
  "highlights": [
    {
      "__id": "example_string",
      "value": "example_string"
    }
  ]
}

Fields

Field	Type	Required	Description
__id	string	No	Unique identifier for this work entry.
company	string	No	Name of the company or organization.
position	string	No	Job title or role held at the company.
location	string	No	Location of the company or where the job was performed.
url	string	No	Company or job-specific URL (e.g., company website or job listing).
startDate	string	No	Start date of employment (ISO 8601 format).
endDate	string	No	End date of employment or null if still employed.
summary	string	No	Brief description of responsibilities or achievements.
highlights	array ResumeHighlightEntry	No	Key accomplishments, projects, or outcomes from the role.

Resume Highlight Entry

A single highlight or accomplishment within a resume section.

{
  "__id": "example_string",
  "value": "example_string"
}

Fields

Field	Type	Required	Description
__id	string	No	Unique identifier for this highlight.
value	string	No	The content of the highlight or achievement.

Volunteer Entry

Represents a volunteer experience, including organization, role, dates, and key highlights.

{
  "__id": "example_string",
  "organization": "example_string",
  "position": "example_string",
  "startDate": "example_string",
  "endDate": "example_string",
  "summary": "example_string",
  "highlights": [
    {
      "__id": "example_string",
      "value": "example_string"
    }
  ]
}

Fields

Field	Type	Required	Description
__id	string	No	Unique identifier for this volunteer entry.
organization	string	No	Name of the organization where the volunteer work took place.
position	string	No	Role or title held during the volunteer work.
startDate	string	No	Start date of the volunteer role (ISO 8601 format).
endDate	string	No	End date of the volunteer role or null if ongoing.
summary	string	No	Brief overview of responsibilities or contributions.
highlights	array	No	Notable achievements or activities completed during the volunteer work.

Education Entry

Represents an educational experience, including institution, degree, dates, and optional courses.

{
  "__id": "example_string",
  "institution": "example_string",
  "area": "example_string",
  "studyType": "example_string",
  "startDate": "example_string",
  "endDate": "example_string",
  "score": "example_string",
  "summary": "example_string",
  "courses": []
}

Fields

Field	Type	Required	Description
__id	string	No	Unique identifier for this education entry.
institution	string	No	Name of the educational institution.
area	string	No	Field of study or major.
studyType	string	No	Type of study (e.g., Bachelors, Masters).
startDate	string	No	Start date of the educational program (ISO 8601 format).
endDate	string	No	End date of the educational program (ISO 8601 format) or null if ongoing.
score	string	No	Grade or GPA achieved (if applicable).
summary	string	No	Brief overview of the program or accomplishments.
courses	array	No	List of notable courses taken.

Project Entry

Represents a personal or professional project, including description, timeline, and notable highlights.

{
  "__id": "example_string",
  "name": "example_string",
  "startDate": "example_string",
  "endDate": "example_string",
  "description": "example_string",
  "highlights": [],
  "url": "example_string"
}

Fields

Field	Type	Required	Description
__id	string	No	Unique identifier for this project entry.
name	string	No	Name or title of the project.
startDate	string	No	Start date of the project (ISO 8601 format).
endDate	string	No	End date of the project (ISO 8601 format), or null if ongoing.
description	string	No	Brief description of the project.
highlights	array	No	Notable accomplishments or contributions within the project.
url	string	No	Optional URL linking to the project or its documentation.

Skill Entry

Represents a skill with an optional proficiency level and related keywords.

{
  "__id": "example_string",
  "name": "example_string",
  "level": "example_string",
  "keywords": []
}

Fields

Field	Type	Required	Description
__id	string	No	Unique identifier for this skill entry.
name	string	No	Name of the skill.
level	string	No	Proficiency level of the skill (e.g., beginner, intermediate, expert).
keywords	array	No	List of related keywords or sub-skills.

Language Entry

Represents a language a candidate knows and their fluency level.

{
  "__id": "example_string",
  "language": "example_string",
  "fluency": "example_string"
}

Fields

Field	Type	Required	Description
__id	string	No	Unique identifier for this language entry.
language	string	No	Name of the language (e.g., English, French).
fluency	string	No	Level of fluency in the language (e.g., Native, Professional, Basic).

Interest Entry

Represents a candidate's personal or professional interests.

{
  "__id": "example_string",
  "name": "example_string",
  "keywords": []
}

Fields

Field	Type	Required	Description
__id	string	No	Unique identifier for this interest entry.
name	string	No	The name of the interest (e.g., Design, Public Speaking).
keywords	array	No	Specific aspects or subcategories of the interest.

Reference Entry

Represents a professional reference provided by the candidate.

{
  "__id": "example_string",
  "name": "example_string",
  "position": "example_string",
  "company": "example_string",
  "email": "example_string",
  "phone": "example_string",
  "relationship": "example_string"
}

Fields

Field	Type	Required	Description
__id	string	No	Unique identifier for this reference entry.
name	string	No	Full name of the reference.
position	string	No	Position or title of the reference.
company	string	No	Company the reference is affiliated with.
email	string	No	Email address of the reference.
phone	string	No	Phone number of the reference.
relationship	string	No	Nature of the relationship between the candidate and the reference.

Certificate Entry

Represents a certificate earned by the candidate.

{
  "__id": "example_string",
  "name": "example_string",
  "date": "example_string",
  "issuer": "example_string",
  "url": "example_string"
}

Fields

Field	Type	Required	Description
__id	string	No	Unique identifier for this certificate entry.
name	string	No	Name of the certificate.
date	string	No	Date the certificate was awarded.
issuer	string	No	Issuing organization.
url	string	No	URL linking to the certificate.

Publication Entry

Represents a publication by the candidate.

{
  "__id": "example_string",
  "name": "example_string",
  "publisher": "example_string",
  "releaseDate": "example_string",
  "url": "example_string",
  "summary": "example_string"
}

Fields

Field	Type	Required	Description
__id	string	No	Unique identifier for this publication entry.
name	string	No	Title of the publication.
publisher	string	No	Publisher of the work.
releaseDate	string	No	Date the publication was released.
url	string	No	Link to the publication.
summary	string	No	Brief description or summary of the publication.

Award Entry

Represents an award or recognition the candidate has received.

{
  "__id": "example_string",
  "title": "example_string",
  "date": "example_string",
  "awarder": "example_string",
  "summary": "example_string"
}

Fields

Field	Type	Required	Description
__id	string	No	Unique identifier for this award entry.
title	string	No	Title or name of the award.
date	string	No	Date the award was received.
awarder	string	No	Name of the awarding organization or person.
summary	string	No	Brief summary or context about the award.

Resume Job Score

Represents the score breakdown when comparing a resume to a job description.

{
  "summary": 123,
  "skills": 123,
  "work": [
    {
      "id": "example_string",
      "score": 123
    }
  ]
}

Fields

Field	Type	Required	Description
summary	number	No	Score based on the summary match between resume and job.
skills	number	No	Score based on skills match.
work	array ScoreEntry	No	Scoring breakdown per work experience entry.

Score Entry

Score assigned to a specific work experience entry when evaluating resume relevance.

{
  "id": "example_string",
  "score": 123
}

Fields

Field	Type	Required	Description
id	string	No	ID of the work entry.
score	number	No	Relevance score of the work entry.

Partial Skill Match

A partial match between a required job skill and a resume skill.

{
  "jobSkill": "example_string",
  "resumeSkill": "example_string"
}

Fields

Field	Type	Required	Description
jobSkill	string	No	The skill required by the job.
resumeSkill	string	No	The similar or related skill found in the resume.

Skills Gap

Details on how the resume's skills align with the job's required skills.

{
  "missing": [],
  "present": [],
  "partialMatches": [
    {
      "jobSkill": "example_string",
      "resumeSkill": "example_string"
    }
  ]
}

Fields

Field	Type	Required	Description
missing	array	No	Skills required by the job but missing from the resume.
present	array	No	Skills both present in the resume and required by the job.
partialMatches	array PartialSkillMatch	No	Skills that partially match between resume and job requirements.

Resume Job Overview

Summary of how well a resume matches a job posting, including a rating and skill alignment analysis.

{
  "rating": "poor",
  "headline": "example_string",
  "skillsGap": {
    "missing": [],
    "present": [],
    "partialMatches": [
      {
        "jobSkill": "example_string",
        "resumeSkill": "example_string"
      }
    ]
  }
}

Fields

Field	Type	Required	Description
rating	string	No	Overall match rating between resume and job.
headline	string	No	A short summary describing the alignment of the resume to the job.
skillsGap	object SkillsGap	No	Details on how the resume's skills align with the job's required skills (see `SkillsGap` schema).

Resume Job Action Priority

Priority levels for resume job actions.

[
  "high",
  "medium",
  "low"
]

Fields

Field	Required	Description
high	No	High priority action.
medium	No	Medium priority action.
low	No	Low priority action.

Resume Job Action Type

Types of resume edits recommended by the system.

[
  "insert",
  "replace",
  "remove"
]

Fields

Field	Required	Description
insert	No	Suggest adding new content.
replace	No	Suggest replacing existing content.
remove	No	Suggest removing content.

Resume Job Action Resolution Status

Status of a user's response to a recommended resume action.

[
  "applied",
  "skipped"
]

Fields

Field	Type	Required	Description
applied		No	The suggestion was accepted and applied.
skipped		No	The suggestion was skipped by the user.

Resume Job Action

An AI-suggested action to improve a resume for a specific job posting.

{
  "priority": [
    "high",
    "medium",
    "low"
  ],
  "headline": "example_string",
  "reason": "example_string",
  "action": [
    "insert",
    "replace",
    "remove"
  ],
  "rewrite": null,
  "resolved": true,
  "resolutionStatus": "applied"
}

Fields

Field	Type	Required	Description
priority	string ResumeJobActionPriority	No	Priority level of the action.
headline	string	No	Short summary of the recommendation.
reason	string	No	Explanation of why the action is recommended.
action	string ResumeJobActionType	No	Type of edit recommended.
rewrite	stringnull	No	The rewritten suggestion, if applicable.
resolved	boolean	No	Indicates if the action has been resolved.
resolutionStatus	string	No	Whether the suggestion was applied or skipped by the user.

Section Review

A quality assessment of a resume section, including feedback and suggestions.

{
  "rating": "poor",
  "feedback": "example_string",
  "recommendations": [],
  "rewrites": []
}

Fields

Field	Type	Required	Description
rating	string	Yes	Overall quality of the section
feedback	string	No	Explanation of the rating
recommendations	array	No	High-level writing advice (up to 3)
rewrites	array	No	Alternative rewritten versions (up to 3)

Work Experience Review

Detailed review of a resume's work experience entry including title, summary, and highlights.

{
  "workId": "example_string",
  "titleReview": {
    "rating": "poor",
    "feedback": "example_string",
    "recommendations": [],
    "rewrites": []
  },
  "summaryReview": {
    "rating": "poor",
    "feedback": "example_string",
    "recommendations": [],
    "rewrites": []
  },
  "highlightsReview": [
    {
      "highlightId": "example_string",
      "rating": "poor",
      "feedback": "example_string",
      "recommendations": [],
      "rewrites": []
    }
  ]
}

Fields

Field	Type	Required	Description
workId	string	Yes	ID of the job entry being reviewed
titleReview	object SectionReview	Yes	Review of the job title
summaryReview	object SectionReview	Yes	Review of the job summary
highlightsReview	array	Yes	List of reviews for each job highlight bullet

Work Highlight Review

Review of a specific work experience highlight with a unique ID.

{
  "highlightId": "example_string",
  "rating": "poor",
  "feedback": "example_string",
  "recommendations": [],
  "rewrites": []
}

Fields

Field	Type	Required	Description
highlightId	string	Yes	ID of the specific highlight (bullet point)
rating	string	Yes	Overall quality of the section
feedback	string	No	Explanation of the rating
recommendations	array	No	High-level writing advice (up to 3)
rewrites	array	No	Alternative rewritten versions (up to 3)

Resume Job Analysis

Contains analysis details comparing a resume against a job description, including scores, overview, and AI recommendations.

{
  "id": "example_string",
  "createdAt": "2025-07-26T12:00:00Z",
  "updatedAt": "2025-07-26T12:00:00Z",
  "resumeId": "example_string",
  "jobId": "example_string",
  "score": {
    "summary": 123,
    "skills": 123,
    "work": [
      {
        "id": "example_string",
        "score": 123
      }
    ]
  },
  "overview": {
    "rating": "poor",
    "headline": "example_string",
    "skillsGap": {
      "missing": [],
      "present": [],
      "partialMatches": [
        {}
      ]
    }
  },
  "actions": {},
  "professionalSummary": {
    "rating": "poor",
    "feedback": "example_string",
    "recommendations": [],
    "rewrites": []
  },
  "workExperience": [
    {
      "workId": "example_string",
      "titleReview": {
        "rating": "poor",
        "feedback": "example_string",
        "recommendations": [],
        "rewrites": []
      },
      "summaryReview": {
        "rating": "poor",
        "feedback": "example_string",
        "recommendations": [],
        "rewrites": []
      },
      "highlightsReview": [
        {
          "highlightId": "example_string",
          "rating": "poor",
          "feedback": "example_string",
          "recommendations": [],
          "rewrites": []
        }
      ]
    }
  ]
}

Fields

Field	Type	Required	Description
id	string	Yes	Unique identifier for the analysis
createdAt	string date-time	Yes	Timestamp when the analysis was created
updatedAt	string date-time	Yes	Timestamp when the analysis was last updated
resumeId	string	Yes	ID of the resume being analyzed
jobId	string	Yes	ID of the job the resume is being matched against
score	object ResumeJobScore	Yes	Numerical breakdown of how well the resume matches the job
overview	object ResumeJobOverview	Yes	High-level summary of the match including skills gap and rating
actions	object ResumeJobActions	Yes	AI-suggested resume changes
professionalSummary	object SectionReview	Yes	Review of the professional summary section of the resume
workExperience	array WorkExperienceReview	Yes	Detailed reviews of each work experience section

UserR

Represents a user in the system.

{
  "id": "example_string",
  "name": "example_string",
  "email": "example_string",
  "password": "example_string",
  "createdAt": "2025-07-26T12:00:00Z",
  "updatedAt": "2025-07-26T12:00:00Z",
  "lastLogin": "2025-07-26T12:00:00Z",
  "settings": {
    "notificationsEnabled": true,
    "theme": "example_string",
    "language": "example_string"
  }
}

Fields

Field	Type	Required	Description
id	string	Yes	Unique identifier for the user
name	string	Yes	Full name of the user
email	string	Yes	Email address of the user
password	string	Yes	Member's password (write-only)
createdAt	string date-time	No	Timestamp when the user was created
updatedAt	string date-time	No	Timestamp when the user was last updated
lastLogin	string date-time	No	Timestamp of the user's last login
settings	object UserSettings	No	Member-specific settings. See UserSettings schema.

Member Settings

Defines the customizable settings for a user.

{
  "notificationsEnabled": true,
  "theme": "example_string",
  "language": "example_string"
}

Fields

Field	Type	Required	Description
notificationsEnabled	boolean	No	Whether the user receives notifications.
theme	string	No	The preferred theme for the user interface (e.g., 'light', 'dark', 'system').
language	string	No	The preferred language for the user interface (e.g., 'en', 'es').

Product

Represents a product in the catalog.

{
  "id": "example_string",
  "name": "example_string",
  "description": "example_string",
  "price": 123,
  "currency": "example_string",
  "inStock": true,
  "imageUrl": "example_string"
}

Fields

Field	Type	Required	Description
id	string	Yes	Unique identifier for the product
name	string	Yes	Name of the product
description	string	No	Detailed description of the product
price	number	Yes	Price of the product
currency	string	Yes	Currency of the product price (e.g., USD, EUR)
inStock	boolean	Yes	Availability status of the product
imageUrl	string	No	URL to the product image

Error

Standard error response format.

{
  "code": "example_string",
  "message": "example_string",
  "details": {}
}

Fields

Field	Type	Required	Description
code	string	Yes	A unique error code
message	string	Yes	A human-readable error message
details	object	No	Optional additional error details