Supported Apps

Here are the list of apps that support this API.

Ashby (ashby)

Supported Request Fields:

firstName - Required
lastName - Required
phones[].phoneNumber - only the value at the 0th index is honored.
emails[].email - the value at 0th index is considered as primaryEmail and the rest are cosidered as alternate emails.
links[].platform - one of LINKEDIN GITHUB WEBSITE
links[].link
tags - expects list of tagId's as input - to get the tha tagId, you can use get global tags, or get candidate tags api.
presentAddress.city
presentAddress.state
presentAddress.country
attachments[].fileType - one of RESUME OTHERS
attachments[].fileName - Required
attachments[].fileContent
attachments[].fileUrl - One Of fileContent or fileUrl is Required
attachments[].contentType - Required if fileContent is given
metaData

Supported Response Fields:

candidateId

SuccessFactors ATS (successfactors-ats)

Supported Request Fields:

firstName - Required
lastName - Required
phones[].phoneNumber - only the value at the 0th index is honored.
emails[].type - WORK
emails[].email - Knit sends the first WORK-type email in the list as contactEmail and the first non-WORK email as primaryEmail. Only these two emails are honored. At least one non-WORK email is Required.
title
tags
presentAddress.addressLine1
presentAddress.addressLine2
presentAddress.city
presentAddress.state - give a vallid state name
presentAddress.country - Required - expects a 2 letter country code like US , CA etc.
presentAddress.zipCode
education[].institute
education[].fromDate
education[].toDate
attachments[].fileType - one of RESUME COVER_LETTER OTHERS
attachments[].fileName
attachments[].fileContent
attachments[].fileUrl
attachments[].contentType
metaData

Supported Response Fields:

candidateId

TeamTailor (teamtailor)

Supported Request Fields:

firstName - Required
lastName - Required
phones[].phoneNumber - only the value at the 0th index is honored.
emails[].email - only the value at the 0th index is honored.
links[].platform - supported LINKEDIN
links[].link
tags
attachments[].fileType - one of RESUME OTHERS
attachments[].fileName - Required if fileContent is given
attachments[].fileContent
attachments[].fileUrl
attachments[].contentType
metaData

Supported Response Fields:

candidateId

UKG Pro Recruiting (ukgpro-ats)

Supported Request Fields:

firstName - Required
lastName - Required
phones[].phoneNumber - the value at 0th and 1st index are honored as primary and secondary phones, the rest are ignored.
emails[].email - only the value at 0th index is honored
links[].platform - whatever given here is passed exactly as name for the link
links[].link
presentAddress.addressLine1
presentAddress.addressLine2
presentAddress.city
presentAddress.state - expects 2 letter code of the state
presentAddress.country - expects 3 letter code of the country
presentAddress.zipCode
education[].degree
education[].institute
education[].fromDate
education[].toDate
education[].major - expects id of the major
education[].minor - expects id of the minor
education[].description
skills[].name
skills[].level - expects id of the proficiency_level - can be obtained using the passthrough request
experiences[].company
experiences[].jobTitle
experiences[].startDate
experiences[].endDate
experiences[].summary
attachments[].fileType - every type is uploaded as a generic candidate document to UKG Pro Recruiting.
attachments[].fileName - Required (only if you are giving attachments)
attachments[].fileContent
attachments[].fileUrl
attachments[].contentType - Required if you are giving fileContent and not a fileUrl
metaData

Supported Response Fields:

candidateId

Vincere (vincere)

Supported Request Fields:

firstName - Required
lastName - Required
phones[].type - one of WORK HOME OTHERS
phones[].phoneNumber
emails[].email - only the value at 0th index is honored and Required.
links[].platform - one of LINKEDIN FACEBOOK TWITTER WEBSITE
links[].link
company
workAddress.addressLine1
workAddress.addressLine2
workAddress.city
workAddress.state
workAddress.country
workAddress.zipCode - all the workAddress fields are appended together and sent as company location name.
permanentAddress.addressLine1
permanentAddress.addressLine2
permanentAddress.city
permanentAddress.country
permanentAddress.zipCode - all the permanentAddress fields are appended together and sent as personal location name.
presentAddress.addressLine1
presentAddress.addressLine2
presentAddress.city
presentAddress.state
presentAddress.country
presentAddress.zipCode - all the presentAddress fields are appended together and sent as current location name.
education[].degree
education[].institute
education[].fromDate
education[].toDate
education[].major
education[].minor
education[].description
education[].score
skills[].name
skills[].level - one of "BEGINNER", "INTERMEDIATE", "ADVANCED", "FLUENT", "NATIVE"
experiences[].company
experiences[].jobTitle
experiences[].startDate
experiences[].endDate
experiences[].currentlyWorking
experiences[].summary
attachments[].fileType
attachments[].fileName - Required (only if you are giving attachments)
attachments[].fileContent
attachments[].fileUrl
attachments[].contentType
metaData
metaData.candidate_source_id - Required - Can be obtained using the passthrough request
metaData.document_type_id - Required Only If you are adding attachments - Can be obtained using the passthrough request

Supported Response Fields:

candidateId

Workable (workable)

Supported Request Fields:

firstName - Required
lastName - Required
phones[].phoneNumber - only the value at the 0th index is honored.
emails[].email - only the value at 0th index is honored and Required.
title
links[].platform - one of FACEBOOK GITHUB LINKEDIN STACKOVERFLOW TWITTER BLOG
links[].link
tags
presentAddress.addressLine1
presentAddress.addressLine2
presentAddress.city
presentAddress.state
presentAddress.country
presentAddress.zipCode - all the presentAddress fields are appended together and sent as address string.
education[].degree
education[].institute
education[].id
education[].fromDate
education[].toDate
education[].major
skills[].name
experiences[].company
experiences[].jobTitle
experiences[].startDate
experiences[].endDate
experiences[].currentlyWorking
experiences[].summary
attachments[].fileType - supported values RESUME
attachments[].fileName - Required (only if you are giving attachments)
attachments[].fileContent
attachments[].fileUrl
attachments[].contentType
metaData
metaData.stage - one of sourced or applied - defaults to source

Supported Response Fields:

candidateId

Remarks : Candiates are created into your workable acoount talent pool, you can view the candidate in the dashboard, but these candidates are not accessible via api to read/update, Move the candidate to a Job to retrieve it via apis or syncs.

Zoho Recruit (zoho-recruit)

Supported Request Fields:

firstName - Required
lastName - Required
phones[].phoneNumber - value at 0th, 1st, 2nd indices are honored as Mobile, Phone, Fax respectively.
emails[].email - the value at 0th and 1st index are honored as Email and Secondary_Email respectively.
title
company
links[].platform - one of LINKEDIN FACEBOOK TWITTER PERSONAL_WEBSITE
links[].link
tags
presentAddress.addressLine1
presentAddress.addressLine2
presentAddress.city
presentAddress.state
presentAddress.country
presentAddress.zipCode
education[].degree
education[].institute
education[].fromDate
education[].toDate
education[].major
education[].currentlyPursuing
skills[].name
experiences[].company
experiences[].jobTitle
experiences[].startDate
experiences[].endDate
experiences[].currentlyWorking
experiences[].summary
attachments[].fileType - one of RESUME COVER_LETTER OTHERS
attachments[].fileName
attachments[].fileContent
attachments[].fileUrl
attachments[].contentType
metaData

Supported Response Fields:

candidateId

200

400Bad Request