Eightfold AI · Schema
CreateATSProfileSchema
Talent IntelligenceTalent AcquisitionTalent ManagementAI InterviewingHuman ResourcesWorkforce PlanningAI Agents
Properties
| Name | Type | Description |
|---|---|---|
| locationCountry | stringnull | location country of candidate |
| contactConsent | stringnull | Contact consent for candidate. Valid inputs: applied_only, all, country_only |
| isAnonymized | booleannull | is anonymized candidate |
| scheduledInterviews | arraynull | scheduled interviews of candidate |
| skills | arraynull | skills of candidate |
| location | stringnull | location of candidate |
| address | stringnull | address of candidate |
| firstName | string | first name of candidate |
| emails | stringnull | email of candidate |
| detailTags | arraynull | detail tags of candidate |
| attachments | arraynull | Attachments of candidate |
| resumeContent | object | Resume content for candidate. |
| visaStatuses | arraynull | visa statuses of candidate |
| veteranStatusStr | stringnull | String value for veteran status of the candidate |
| education | arraynull | education of candidate |
| isInternal | booleannull | is internal candidate |
| customInfo | objectnull | custom info of candidate |
| autoGenerateCandidateId | booleannull | When true, auto-generate the candidate_id; only supported for system_id=talent_tracking and only when candidateId is not provided. Must not be set for other systems. |
| courseAttendance | arraynull | course attandance of candidate |
| systemId | stringnull | system if of candidate |
| urls | arraynull | urls of candidate |
| candidateId | stringnull | ATS Candidate id. Omit when autoGenerateCandidateId is true. |
| title | stringnull | title of candidate |
| displayTags | arraynull | display tags for candidate |
| tags | arraynull | tags of candidate |
| veteranStatus | booleannull | Boolean value for veteran status of the candidate |
| highestEducationLevel | stringnull | highest education level of candidate |
| certifications | arraynull | certifications for candidate |
| lastActivityTs | integernull | last activity time stamp of candidate |
| summary | stringnull | summary of candidate |
| photoContent | object | Photo content. |
| applications | arraynull | applications of candidates |
| disabilityStatus | booleannull | disability status |
| phones | stringnull | comma separated phone numbers of candidate |
| experience | arraynull | experience of candidate |
| races | arraynull | race of candidate |
| dateOfBirth | stringnull | date of birth of candidate |
| project | arraynull | project of candidate |
| notes | arraynull | notes of candidates |
| gender | stringnull | gender of candidate |
| questions | arraynull | questions of candidate |
| skillDetails | arraynull | skill details of candidate |
| disabilityStatusStr | stringnull | disability status of an applicant |
| lastName | stringnull | last name of candidate |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://raw.githubusercontent.com/api-evangelist/eightfold-ai/main/json-schema/eightfold-ai-create-atsprofile-schema-schema.json",
"title": "CreateATSProfileSchema",
"x-generated": "2026-10-14",
"x-method": "derived",
"x-generator": "derive-json-schema.py",
"x-source": "openapi/eightfold-ai-api-server-v2-service-service-openapi.yml#/components/schemas/CreateATSProfileSchema",
"type": "object",
"properties": {
"locationCountry": {
"type": [
"string",
"null"
],
"description": "location country of candidate"
},
"contactConsent": {
"type": [
"string",
"null"
],
"description": "Contact consent for candidate. Valid inputs: applied_only, all, country_only"
},
"isAnonymized": {
"type": [
"boolean",
"null"
],
"description": "is anonymized candidate"
},
"scheduledInterviews": {
"description": "scheduled interviews of candidate",
"type": [
"array",
"null"
],
"items": {
"$ref": "#/$defs/ATSScheduledInterview"
}
},
"skills": {
"type": [
"array",
"null"
],
"description": "skills of candidate",
"items": {
"type": "string"
}
},
"location": {
"type": [
"string",
"null"
],
"description": "location of candidate"
},
"address": {
"type": [
"string",
"null"
],
"description": "address of candidate"
},
"firstName": {
"type": "string",
"description": "first name of candidate"
},
"emails": {
"type": [
"string",
"null"
],
"description": "email of candidate"
},
"detailTags": {
"description": "detail tags of candidate",
"type": [
"array",
"null"
],
"items": {
"$ref": "#/$defs/AtsTag"
}
},
"attachments": {
"description": "Attachments of candidate",
"type": [
"array",
"null"
],
"items": {
"$ref": "#/$defs/AtsAttachment"
}
},
"resumeContent": {
"nullable": true,
"description": "Resume content for candidate.",
"allOf": [
{
"$ref": "#/$defs/AtsContent"
}
]
},
"visaStatuses": {
"type": [
"array",
"null"
],
"description": "visa statuses of candidate",
"items": {
"type": "string"
}
},
"veteranStatusStr": {
"type": [
"string",
"null"
],
"readOnly": true,
"description": "String value for veteran status of the candidate"
},
"education": {
"description": "education of candidate",
"type": [
"array",
"null"
],
"items": {
"$ref": "#/$defs/AtsEducation"
}
},
"isInternal": {
"type": [
"boolean",
"null"
],
"description": "is internal candidate"
},
"customInfo": {
"type": [
"object",
"null"
],
"description": "custom info of candidate"
},
"autoGenerateCandidateId": {
"type": [
"boolean",
"null"
],
"writeOnly": true,
"description": "When true, auto-generate the candidate_id; only supported for system_id=talent_tracking and only when candidateId is not provided. Must not be set for other systems."
},
"courseAttendance": {
"description": "course attandance of candidate",
"type": [
"array",
"null"
],
"items": {
"$ref": "#/$defs/LmsCourseAttendance"
}
},
"systemId": {
"type": [
"string",
"null"
],
"description": "system if of candidate"
},
"urls": {
"type": [
"array",
"null"
],
"description": "urls of candidate",
"items": {
"type": "string"
}
},
"candidateId": {
"type": [
"string",
"null"
],
"description": "ATS Candidate id. Omit when autoGenerateCandidateId is true."
},
"title": {
"type": [
"string",
"null"
],
"description": "title of candidate"
},
"displayTags": {
"type": [
"array",
"null"
],
"description": "display tags for candidate",
"items": {
"type": "string"
}
},
"tags": {
"type": [
"array",
"null"
],
"description": "tags of candidate",
"items": {
"type": "string"
}
},
"veteranStatus": {
"type": [
"boolean",
"null"
],
"description": "Boolean value for veteran status of the candidate"
},
"highestEducationLevel": {
"type": [
"string",
"null"
],
"description": "highest education level of candidate"
},
"certifications": {
"description": "certifications for candidate",
"type": [
"array",
"null"
],
"items": {
"$ref": "#/$defs/AtsCertification"
}
},
"lastActivityTs": {
"type": [
"integer",
"null"
],
"format": "int32",
"description": "last activity time stamp of candidate"
},
"summary": {
"type": [
"string",
"null"
],
"description": "summary of candidate"
},
"photoContent": {
"nullable": true,
"description": "Photo content.",
"allOf": [
{
"$ref": "#/$defs/AtsContent"
}
]
},
"applications": {
"description": "applications of candidates",
"type": [
"array",
"null"
],
"items": {
"$ref": "#/$defs/AtsApplication"
}
},
"disabilityStatus": {
"type": [
"boolean",
"null"
],
"description": "disability status"
},
"phones": {
"type": [
"string",
"null"
],
"description": "comma separated phone numbers of candidate"
},
"experience": {
"description": "experience of candidate",
"type": [
"array",
"null"
],
"items": {
"$ref": "#/$defs/AtsExperience"
}
},
"races": {
"type": [
"array",
"null"
],
"description": "race of candidate",
"items": {
"type": "string"
}
},
"dateOfBirth": {
"type": [
"string",
"null"
],
"description": "date of birth of candidate"
},
"project": {
"description": "project of candidate",
"type": [
"array",
"null"
],
"items": {
"$ref": "#/$defs/AtsProject"
}
},
"notes": {
"description": "notes of candidates",
"type": [
"array",
"null"
],
"items": {
"$ref": "#/$defs/AtsNote"
}
},
"gender": {
"type": [
"string",
"null"
],
"description": "gender of candidate"
},
"questions": {
"description": "questions of candidate",
"type": [
"array",
"null"
],
"items": {
"$ref": "#/$defs/AtsQuestionAnswer"
}
},
"skillDetails": {
"description": "skill details of candidate",
"type": [
"array",
"null"
],
"items": {
"$ref": "#/$defs/ATSSkillDetail"
}
},
"disabilityStatusStr": {
"type": [
"string",
"null"
],
"readOnly": true,
"description": "disability status of an applicant"
},
"lastName": {
"type": [
"string",
"null"
],
"description": "last name of candidate"
}
},
"required": [
"emails",
"firstName",
"lastActivityTs"
],
"$defs": {
"ATSScheduledInterview": {
"type": "object",
"properties": {
"organizer": {
"type": [
"string",
"null"
],
"description": "Organizer"
},
"status": {
"type": [
"string",
"null"
],
"description": "Status"
},
"endTs": {
"type": [
"integer",
"null"
],
"format": "int32",
"description": "End Timestamp"
},
"interviewType": {
"type": [
"string",
"null"
],
"description": "Interview Type"
},
"interviewers": {
"type": [
"array",
"null"
],
"description": "Interviewers",
"items": {
"type": "string"
}
},
"startTs": {
"type": [
"integer",
"null"
],
"format": "int32",
"description": "Start Timestamp"
},
"location": {
"type": [
"string",
"null"
],
"description": "Location of interview"
},
"comment": {
"type": [
"string",
"null"
],
"description": "Comment"
},
"referenceId": {
"type": [
"string",
"null"
],
"description": "Reference ID"
}
}
},
"ATSScoreCardAttribute": {
"type": "object",
"properties": {
"rating": {
"type": [
"string",
"null"
],
"description": "Rating. Valid inputs: strong_yes, yes, mixed, no, strong_no"
},
"answer": {
"type": [
"string",
"null"
],
"description": "Answer"
},
"note": {
"type": [
"string",
"null"
],
"description": "Note"
},
"question": {
"type": [
"string",
"null"
],
"description": "Question"
},
"rating_label": {
"type": [
"string",
"null"
],
"description": "Rating label"
}
}
},
"ATSSkillDetail": {
"type": "object",
"properties": {
"skillGroups": {
"description": "Skill groups",
"type": [
"array",
"null"
],
"items": {
"$ref": "#/$defs/ATSSkillGroup"
}
},
"proficiency": {
"type": [
"string",
"null"
],
"description": "Proficiency. Note: proficiency must be specified only for each skill group when skill groups are present"
},
"evaluationTimestamp": {
"type": [
"integer",
"null"
],
"format": "int32",
"description": "Evaluation timestamp"
},
"dataSource": {
"type": [
"string",
"null"
],
"description": "Data source of the skill"
},
"skill": {
"type": [
"string",
"null"
],
"description": "Skill"
}
}
},
"ATSSkillGroup": {
"type": "object",
"properties": {
"proficiency": {
"type": [
"string",
"null"
],
"description": "Proficiency"
},
"skillGroup": {
"type": [
"string",
"null"
],
"description": "Skill Group"
}
}
},
"AtsApplication": {
"type": "object",
"properties": {
"locationCountry": {
"type": [
"string",
"null"
],
"description": "location country of an application"
},
"reason": {
"type": [
"string",
"null"
],
"maxLength": 5000,
"description": "reason for an application"
},
"location": {
"type": [
"string",
"null"
],
"description": "location of an application"
},
"visaStatuses": {
"type": [
"array",
"null"
],
"description": "list of visa status",
"items": {
"type": "string"
}
},
"veteranStatusStr": {
"type": [
"string",
"null"
],
"readOnly": true,
"description": "String value for veteran status of the applicant"
},
"jobs": {
"description": "Jobs related to an application.",
"type": [
"array",
"null"
],
"items": {
"$ref": "#/$defs/Jobs"
}
},
"hiredTs": {
"type": [
"integer",
"null"
],
"format": "int32",
"description": "hired timestamp of an applicant"
},
"lastModifiedTs": {
"type": [
"integer",
"null"
],
"format": "int32",
"description": "last modified timestamp of an application"
},
"customInfo": {
"type": [
"object",
"null"
],
"description": "custom info for an application"
},
"note": {
"nullable": true,
"description": "ats notes for an application",
"allOf": [
{
"$ref": "#/$defs/AtsNote"
}
]
},
"systemId": {
"type": [
"string",
"null"
],
"description": "system id of an application"
},
"creditor": {
"type": [
"string",
"null"
],
"description": "creditor of an application"
},
"candidateId": {
"type": [
"string",
"null"
],
"description": "candidate id of an applicant"
},
"rejectedTs": {
"type": [
"integer",
"null"
],
"format": "int32",
"description": "rejected timestamp of an applicant"
},
"veteranStatus": {
"type": [
"boolean",
"null"
],
"description": "Boolean value for veteran status of the applicant"
},
"applicationTs": {
"type": [
"integer",
"null"
],
"format": "int32",
"description": "application timestamp"
},
"pastStages": {
"description": "past stages of an application",
"type": [
"array",
"null"
],
"items": {
"$ref": "#/$defs/AtsStage"
}
},
"sourceName": {
"type": [
"string",
"null"
],
"description": "source name of an application"
},
"isProspect": {
"type": [
"boolean",
"null"
],
"description": "is prospective applicant"
},
"scorecards": {
"description": "scorecards for an application",
"type": [
"array",
"null"
],
"items": {
"$ref": "#/$defs/AtsScorecard"
}
},
"jobSystemId": {
"type": [
"string",
"null"
],
"description": "job system id for an application"
},
"disabilityStatus": {
"type": [
"boolean",
"null"
],
"description": "disability status of an applicant"
},
"currentStage": {
"nullable": true,
"description": "current stage of an application",
"allOf": [
{
"$ref": "#/$defs/AtsStage"
}
]
},
"status": {
"type": [
"string",
"null"
],
"description": "Status of application.Valid inputs: active, hired, rejected, converted, withdrawn"
},
"races": {
"type": [
"array",
"null"
],
"description": "list of races of an applicant",
"items": {
"type": "string"
}
},
"sourceType": {
"type": [
"string",
"null"
],
"description": "source type of an application"
},
"gender": {
"type": [
"string",
"null"
],
"description": "gender of an applicant"
},
"questions": {
"description": "questions",
"type": [
"array",
"null"
],
"items": {
"$ref": "#/$defs/AtsQuestionAnswer"
}
},
"rejectedBy": {
"type": [
"string",
"null"
],
"description": "applicant rejected by"
},
"disabilityStatusStr": {
"type": [
"string",
"null"
],
"readOnly": true,
"description": "disability status of an applicant"
},
"applicationId": {
"type": "string",
"description": "application id"
}
},
"required": [
"applicationId",
"applicationTs",
"candidateId",
"lastModifiedTs"
]
},
"AtsAttachment": {
"type": "object",
"properties": {
"isBase64": {
"type": [
"boolean",
"null"
],
"description": "Denotes if the attachment base64 encoded"
},
"fileName": {
"type": "string",
"description": "File name of the attachment"
},
"lastModifiedTs": {
"type": [
"integer",
"null"
],
"format": "int32",
"description": "Last Modified timestamp of the attachment"
},
"applicationMetadata": {
"description": "application_metadata",
"type": [
"array",
"null"
],
"items": {
"$ref": "#/$defs/AtsAttachmentApplicationMetadata"
}
},
"attachmentContent": {
"type": [
"string",
"null"
],
"description": "Content of the attachment"
},
"attachmentId": {
"type": "string",
"description": "Attachment id of the attachment"
},
"attachmentType": {
"type": [
"string",
"null"
],
"description": "Attachment type. Valid inputs: resume, others, photo, cover_letter"
}
},
"required": [
"attachmentContent",
"attachmentId",
"attachmentType",
"fileName"
]
},
"AtsAttachmentApplicationMetadata": {
"type": "object",
"properties": {
"applicationId": {
"type": "string",
"description": "application id for an attachment"
}
},
"required": [
"applicationId"
]
},
"AtsCertification": {
"type": "object",
"properties": {
"locationCountry": {
"type": [
"string",
"null"
],
"description": "Country where certification was issued"
},
"verificationStatus": {
"type": [
"string",
"null"
],
"description": "verification status of a certification"
},
"licenseNo": {
"type": [
"string",
"null"
],
"description": "License number of a certification"
},
"skills": {
"type": [
"array",
"null"
],
"description": "Skills associated with the certification",
"items": {
"type": "string"
}
},
"validFromTs": {
"type": [
"integer",
"null"
],
"format": "int32",
"description": "validtion from timestamp of a certification"
},
"comments": {
"type": [
"string",
"null"
],
"description": "Comments on the certification"
},
"allText": {
"type": [
"string",
"null"
],
"description": "All text associated with the certification"
},
"endTs": {
"type": [
"integer",
"null"
],
"format": "int32",
"description": "ending timestamp of a certification"
},
"verificationBy": {
"type": [
"string",
"null"
],
"description": "email of the verifier"
},
"certificateName": {
"type": [
"string",
"null"
],
"description": "certificate name of a certification"
},
"verificationTs": {
"type": [
"integer",
"null"
],
"format": "int32",
"description": "verification timestamp"
},
"status": {
"type": [
"string",
"null"
],
"description": "Status of the certification"
},
"certificateType": {
"type": [
"string",
"null"
],
"description": "Type of the certification"
},
"proficiency": {
"type": [
"string",
"null"
],
"description": "proficiency of a certification"
},
"validToTs": {
"type": [
"integer",
"null"
],
"format": "int32",
"description": "validation till timestamp of a certification"
},
"attachmentIds": {
"type": [
"array",
"null"
],
"description": "List of attachment ids of a certification",
"items": {
"type": "string"
}
},
"startTs": {
"type": [
"integer",
"null"
],
"format": "int32",
"description": "starting timestamp of a certification"
},
"certificateExternalId": {
"type": [
"string",
"null"
],
"description": "external id for the type of certification"
},
"locationState": {
"type": [
"string",
"null"
],
"description": "State where certification was issued"
},
"issuingAuthority": {
"type": [
"string",
"null"
],
"description": "issuing authority of a certification"
},
"description": {
"type": [
"string",
"null"
],
"description": "Description of the certification"
}
},
"required": [
"certificateName"
]
},
"AtsContent": {
"type": "object",
"properties": {
"extension": {
"type": [
"string",
"null"
],
"description": "extension"
},
"content": {
"type": [
"string",
"null"
],
"description": "content"
},
"isBase64": {
"type": [
"boolean",
"null"
],
"description": "is base 64 encoded?"
}
}
},
"AtsEducation": {
"type": "object",
"properties": {
"endTs": {
"type": [
"integer",
"null"
],
"format": "int32",
"description": "ending timestamp"
},
"verificationStatus": {
"type": [
"string",
"null"
],
"description": "verification status of the education details"
},
"degreeExternalId": {
"type": [
"string",
"null"
],
"description": "external id of the degree"
},
"attachmentIds": {
"type": [
"array",
"null"
],
"description": "List of attachment ids of the education",
"items": {
"type": "string"
}
},
"startTs": {
"type": [
"integer",
"null"
],
"format": "int32",
"description": "starting timestamp of education"
},
"degree": {
"type": [
"string",
"null"
],
"description": "degree"
},
"major": {
"type": [
"string",
"null"
],
"description": "major"
},
"verificationBy": {
"type": [
"string",
"null"
],
"description": "email of the verifier"
},
"location": {
"type": [
"string",
"null"
],
"description": "location"
},
"isCurrent": {
"type": [
"boolean",
"null"
],
"description": "is current education"
},
"schoolExternalId": {
"type": [
"string",
"null"
],
"description": "external id of the school"
},
"majorExternalId": {
"type": [
"string",
"null"
],
"description": "external id of the major"
},
"verificationTs": {
"type": [
"integer",
"null"
],
"format": "int32",
"description": "verification timestamp"
},
"school": {
"type": [
"string",
"null"
],
"description": "school"
},
"nameAlias": {
"type": [
"string",
"null"
],
"description": "name of the candidate in the records if different from the name in the profile"
},
"isGraduated": {
"type": [
"boolean",
"null"
],
"description": "graduation status of the candidate"
},
"description": {
"type": [
"string",
"null"
],
"description": "description"
}
},
"required": [
"degree",
"description",
"location",
"major",
"school",
"startTs"
]
},
"AtsExperience": {
"type": "object",
"properties": {
"endTs": {
"type": [
"integer",
"null"
],
"format": "int32",
"description": "end_ts of exp"
},
"industry": {
"type": [
"string",
"null"
],
"description": "industry of work"
},
"isInternal": {
"type": [
"boolean",
"null"
],
"description": "is internal employee"
},
"department": {
"type": [
"string",
"null"
],
"description": "department of work"
},
"startTs": {
"type": [
"integer",
"null"
],
"format": "int32",
"description": "start_ts of exp"
},
"location": {
"type": [
"string",
"null"
],
"description": "location of work"
},
"company": {
"type": [
"string",
"null"
],
"description": "company of a candidate"
},
"isCurrent": {
"type": [
"boolean",
"null"
],
"description": "is currentely employed"
},
"description": {
"type": [
"string",
"null"
],
"description": "description of the post/company"
},
"title": {
"type": [
"string",
"null"
],
"description": "title of post"
}
},
"required": [
"company",
"isCurrent",
"isInternal",
"location",
"startTs",
"title"
]
},
"AtsNote": {
"type": "object",
"properties": {
"subject": {
"type": [
"string",
"null"
],
"description": "subject of a note"
},
"to": {
"type": [
"string",
"null"
],
"description": "email of reciever"
},
"noteType": {
"type": [
"string",
"null"
],
"description": "Note type of an ats note. Valid inputs: email, note, other"
},
"visibility": {
"type": [
"string",
"null"
],
"description": "visibility of a note"
},
"creator": {
"type": [
"string",
"null"
],
"description": "creator of a note"
},
"cc": {
"type": [
"array",
"null"
],
"description": "email address for cc",
"items": {
"type": "string"
}
},
"body": {
"type": [
"string",
"null"
],
"description": "body of a note"
},
"sender": {
"type": [
"string",
"null"
],
"description": "email of sender"
},
"creationTs": {
"type": [
"integer",
"null"
],
"format": "int32",
"description": "creation timestamp of a note"
}
}
},
"AtsProject": {
"type": "object",
"properties": {
"endTs": {
"type": [
"integer",
"null"
],
"format": "int32",
"description": "ending timestamp of a project"
},
"links": {
"type": [
"array",
"null"
],
"description": "links for a project",
"items": {
"type": "string"
}
},
"startTs": {
"type": [
"integer",
"null"
],
"format": "int32",
"description": "start timestamp of a project"
},
"skills": {
"type": [
"array",
"null"
],
"description": "skills",
"items": {
"type": "string"
}
},
"company": {
"type": [
"string",
"null"
],
"description": "company of a project"
},
"contributors": {
"type": [
"array",
"null"
],
"description": "contributors to a project",
"items": {
"type": "string"
}
},
"description": {
"type": [
"string",
"null"
],
"description": "description"
},
"title": {
"type": [
"string",
"null"
],
"description": "title of a project"
}
},
"required": [
"company",
"startTs",
"title"
]
},
"AtsQuestionAnswer": {
"type": "object",
"properties": {
"formName": {
"type": [
"string",
"null"
],
"description": "form name for the question"
},
"choices": {
"type": [
"array",
"null"
],
# --- truncated at 32 KB (41 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/eightfold-ai/refs/heads/main/json-schema/eightfold-ai-create-atsprofile-schema-schema.json
Work with this as data
Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for schemas
4 MCP tools reach this
find_json_schemasBrowse and filter every JSON Schema in the catalog.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/eightfold-ai-create-atsprofile-schema"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.