Create Application
Copy
Ask AI
curl --request POST \
--url https://api.stackone.com/unified/ats/applications \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--header 'x-account-id: <x-account-id>' \
--data '
{
"passthrough": {
"other_known_names": "John Doe"
},
"job_id": "4071538b-3cac-4fbf-ac76-f78ed250ffdd",
"job_posting_id": "1c702a20-8de8-4d03-ac18-cbf4ac42eb51",
"location_id": "dd8d41d1-5eb8-4408-9c87-9ba44604eae4",
"application_status": {
"value": "hired",
"source_value": "Hired"
},
"questionnaires": {
"id": "right_to_work",
"answers": [
{
"id": "answer1",
"type": "text",
"values": [
"Yes"
]
}
]
},
"source": {
"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"name": "LinkedIn"
},
"candidate_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48",
"candidate": {
"passthrough": {
"other_known_names": "John Doe"
},
"unified_custom_fields": {
"my_project_custom_field_1": "REF-1236",
"my_project_custom_field_2": "some other value"
},
"phone_number": "+1234567890",
"phone_numbers": [
{
"type": "personal",
"phone": "+447700112233"
}
],
"name": "Romain Sestier",
"first_name": "Romain",
"last_name": "Sestier",
"email": "[email protected]",
"social_links": [
{
"type": "linkedin",
"url": "https://www.linkedin.com/in/romainsestier/"
}
],
"company": "Company Inc.",
"title": "Software Engineer",
"hired_at": "2021-01-01T01:01:01.000Z",
"country": "United States",
"custom_fields": [
{
"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"name": "Training Completion Status",
"value": "Completed",
"value_id": "value_456",
"remote_value_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48"
}
]
},
"documents": [
{
"name": "weather-forecast",
"file_format": {
"value": "pdf",
"source_value": "application/pdf"
},
"content": "VGhpcyBpc24ndCByZWFsbHkgYSBzYW1wbGUgZmlsZSwgYnV0IG5vIG9uZSB3aWxsIGV2ZXIga25vdyE",
"category_id": "6530",
"path": "/path/to/file",
"confidential": {
"value": "true",
"source_value": "public"
},
"category": {
"name": "resume",
"id": "550e8400-e29b-41d4-a716-446655440000"
}
}
]
}
'Copy
Ask AI
{
"statusCode": 201,
"message": "Record created successfully.",
"timestamp": "2021-01-01T01:01:01.000Z",
"data": {
"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3"
}
}Applications
Create Application
POST
/
unified
/
ats
/
applications
Create Application
Copy
Ask AI
curl --request POST \
--url https://api.stackone.com/unified/ats/applications \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--header 'x-account-id: <x-account-id>' \
--data '
{
"passthrough": {
"other_known_names": "John Doe"
},
"job_id": "4071538b-3cac-4fbf-ac76-f78ed250ffdd",
"job_posting_id": "1c702a20-8de8-4d03-ac18-cbf4ac42eb51",
"location_id": "dd8d41d1-5eb8-4408-9c87-9ba44604eae4",
"application_status": {
"value": "hired",
"source_value": "Hired"
},
"questionnaires": {
"id": "right_to_work",
"answers": [
{
"id": "answer1",
"type": "text",
"values": [
"Yes"
]
}
]
},
"source": {
"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"name": "LinkedIn"
},
"candidate_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48",
"candidate": {
"passthrough": {
"other_known_names": "John Doe"
},
"unified_custom_fields": {
"my_project_custom_field_1": "REF-1236",
"my_project_custom_field_2": "some other value"
},
"phone_number": "+1234567890",
"phone_numbers": [
{
"type": "personal",
"phone": "+447700112233"
}
],
"name": "Romain Sestier",
"first_name": "Romain",
"last_name": "Sestier",
"email": "[email protected]",
"social_links": [
{
"type": "linkedin",
"url": "https://www.linkedin.com/in/romainsestier/"
}
],
"company": "Company Inc.",
"title": "Software Engineer",
"hired_at": "2021-01-01T01:01:01.000Z",
"country": "United States",
"custom_fields": [
{
"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"name": "Training Completion Status",
"value": "Completed",
"value_id": "value_456",
"remote_value_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48"
}
]
},
"documents": [
{
"name": "weather-forecast",
"file_format": {
"value": "pdf",
"source_value": "application/pdf"
},
"content": "VGhpcyBpc24ndCByZWFsbHkgYSBzYW1wbGUgZmlsZSwgYnV0IG5vIG9uZSB3aWxsIGV2ZXIga25vdyE",
"category_id": "6530",
"path": "/path/to/file",
"confidential": {
"value": "true",
"source_value": "public"
},
"category": {
"name": "resume",
"id": "550e8400-e29b-41d4-a716-446655440000"
}
}
]
}
'Copy
Ask AI
{
"statusCode": 201,
"message": "Record created successfully.",
"timestamp": "2021-01-01T01:01:01.000Z",
"data": {
"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3"
}
}Authorizations
Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.
Headers
The account identifier
Body
application/json
Value to pass through to the provider
Example:
{ "other_known_names": "John Doe" }
Unique identifier of the job
Example:
"4071538b-3cac-4fbf-ac76-f78ed250ffdd"
Unique identifier of the job posting that is associated with application
Example:
"1c702a20-8de8-4d03-ac18-cbf4ac42eb51"
Unique identifier of the location
Example:
"dd8d41d1-5eb8-4408-9c87-9ba44604eae4"
Show child attributes
Show child attributes
The status of the application.
Available options:
active, assessment, background_check, converted, declined_by_candidate, hired, interview, lead, offer, reference_check, rejected, review, screen, new, onboarding, created, accepted, short_list, approved, unmapped_value, Example:
"hired"
The source value of the application status.
Example:
"Hired"
Questionnaires associated with the application
Show child attributes
Show child attributes
Unique identifier
Example:
"8187e5da-dc77-475e-9949-af0f1fa4e4e3"
Show child attributes
Show child attributes
Unique identifier
Example:
"8187e5da-dc77-475e-9949-af0f1fa4e4e3"
Type of the answer
Show child attributes
Show child attributes
The type of the answer.
Available options:
short_text, long_text, attachment, multi_select, single_select, boolean, number, date, video, reference_check, url, unmapped_value, Example:
"short_text"
The source value of the answer type.
Example:
"Short Text"
Values of the answer
Example:
[
"Yes",
"No Travel",
"It sounds pretty cool.",
"Excel",
"Power Point"
]
Example:
{
"id": "right_to_work",
"answers": [
{
"id": "answer1",
"type": "text",
"values": ["Yes"]
}
]
}
Unique identifier of the candidate. Provide this OR candidate, but not both.
Example:
"e3cb75bf-aa84-466e-a6c1-b8322b257a48"
Candidate Properties. Provide this OR candidate_id, but not both. Providing this attempts to create a new candidate with the application.
Show child attributes
Show child attributes
Value to pass through to the provider
Example:
{ "other_known_names": "John Doe" }
Custom Unified Fields configured in your StackOne project
Example:
{
"my_project_custom_field_1": "REF-1236",
"my_project_custom_field_2": "some other value"
}
The candidate personal phone number
Example:
"+1234567890"
List of candidate phone numbers including the type of the number when available
Candidate name
Example:
"Romain Sestier"
Candidate first name
Example:
"Romain"
Candidate last name
Example:
"Sestier"
Candidate email
Example:
Candidate company
Example:
"Company Inc."
Candidate title
Example:
"Software Engineer"
Candidate hired date
Example:
"2021-01-01T01:01:01.000Z"
Candidate country
Example:
"United States"
The candidate custom fields
Show child attributes
Show child attributes
Unique identifier
Example:
"8187e5da-dc77-475e-9949-af0f1fa4e4e3"
Provider's unique identifier
Example:
"8187e5da-dc77-475e-9949-af0f1fa4e4e3"
The name of the custom field.
Example:
"Training Completion Status"
The value associated with the custom field.
Example:
"Completed"
The unique identifier for the value of the custom field.
Example:
"value_456"
Provider's unique identifier for the value of the custom field.
Example:
"e3cb75bf-aa84-466e-a6c1-b8322b257a48"
Document Properties. Providing this attempts to upload files with the application.
Show child attributes
Show child attributes
The filename of the file to upload
Example:
"weather-forecast"
The file format of the file
Show child attributes
Show child attributes
The file format of the file, expressed as a file extension
Available options:
unmapped_value, ez, aw, atom, atomcat, atomdeleted, atomsvc, dwd, held, rsat, bdoc, xcs, ccxml, cdfx, cdmia, cdmic, cdmid, cdmio, cdmiq, cu, mpd, davmount, dbk, dssc, xdssc, es, ecma, emma, emotionml, epub, exi, exp, fdt, pfr, geojson, gml, gpx, gxf, gz, hjson, stk, ink, inkml, ipfix, its, jar, war, ear, ser, class, js, mjs, json, map, json5, jsonml, jsonld, lgr, lostxml, hqx, cpt, mads, webmanifest, mrc, mrcx, ma, nb, mb, mathml, mbox, mscml, metalink, meta4, mets, maei, musd, mods, m21, mp21, mp4s, m4p, doc, dot, mxf, nq, nt, cjs, bin, dms, lrf, mar, so, dist, distz, pkg, bpk, dump, elc, deploy, exe, dll, deb, dmg, iso, img, msi, msp, msm, buffer, oda, opf, ogx, omdoc, onetoc, onetoc2, onetmp, onepkg, oxps, relo, xer, pdf, pgp, asc, sig, prf, p10, p7m, p7c, p7s, p8, ac, cer, crl, pkipath, pki, pls, ai, eps, ps, provx, pskcxml, raml, rdf, owl, rif, rnc, rl, rld, rs, rapd, sls, rusd, gbr, mft, roa, rsd, rss, rtf, sbml, scq, scs, spq, spp, sdp, senmlx, sensmlx, setpay, setreg, shf, siv, sieve, smi, smil, rq, srx, gram, grxml, sru, ssdl, ssml, swidtag, tei, teicorpus, tfi, tsd, toml, trig, ttml, ubj, rsheet, td, vxml, wasm, wgt, hlp, wsdl, wspolicy, xaml, xav, xca, xdf, xel, xns, xenc, xhtml, xht, xlf, xml, xsl, xsd, rng, dtd, xop, xpl, *xsl, xslt, xspf, mxml, xhvml, xvml, xvm, yang, yin, zip, *3gpp, adp, amr, au, snd, mid, midi, kar, rmi, mxmf, *mp3, m4a, mp4a, mpga, mp2, mp2a, mp3, m2a, m3a, oga, ogg, spx, opus, s3m, sil, wav, *wav, weba, xm, ttc, otf, ttf, woff, woff2, exr, apng, avif, bmp, cgm, drle, emf, fits, g3, gif, heic, heics, heif, heifs, hej2, hsj2, ief, jls, jp2, jpg2, jpeg, jpg, jpe, jph, jhc, jpm, jpx, jpf, jxr, jxra, jxrs, jxs, jxsc, jxsi, jxss, ktx, ktx2, png, sgi, svg, svgz, t38, tif, tiff, tfx, webp, wmf, disposition-notification, u8msg, u8dsn, u8mdn, u8hdr, eml, mime, 3mf, gltf, glb, igs, iges, msh, mesh, silo, mtl, obj, stpx, stpz, stpxz, stl, wrl, vrml, *x3db, x3dbz, x3db, *x3dv, x3dvz, x3d, x3dz, x3dv, appcache, manifest, ics, ifb, coffee, litcoffee, css, csv, html, htm, shtml, jade, jsx, less, markdown, md, mml, mdx, n3, txt, text, conf, def, list, log, in, ini, rtx, *rtf, sgml, sgm, shex, slim, slm, spdx, stylus, styl, tsv, t, tr, roff, man, me, ms, ttl, uri, uris, urls, vcard, vtt, *xml, yaml, yml, 3gp, 3gpp, 3g2, h261, h263, h264, m4s, jpgv, *jpm, jpgm, mj2, mjp2, ts, mp4, mp4v, mpg4, mpeg, mpg, mpe, m1v, m2v, ogv, qt, mov, webm, cww, 1km, plb, psb, pvb, tcap, pwn, aso, imp, acu, atc, acutc, air, fcdt, fxp, fxpl, xdp, xfdf, ahead, azf, azs, azw, acc, ami, apk, cii, fti, atx, mpkg, key, m3u8, numbers, pages, pkpass, swi, iota, aep, bmml, mpm, bmi, rep, cdxml, mmd, cdy, csl, cla, rp9, c4g, c4d, c4f, c4p, c4u, c11amc, c11amz, csp, cdbcmsg, cmc, clkx, clkk, clkp, clkt, clkw, wbs, pml, ppd, car, pcurl, dart, rdz, dbf, uvf, uvvf, uvd, uvvd, uvt, uvvt, uvx, uvvx, uvz, uvvz, fe_launch, dna, mlp, mle, dpg, dfac, kpxx, ait, svc, geo, mag, nml, esf, msf, qam, slt, ssf, es3, et3, ez2, ez3, fdf, mseed, seed, dataless, gph, ftc, fm, frame, maker, book, fnc, ltf, fsc, oas, oa2, oa3, fg5, bh2, ddd, xdw, xbd, fzs, txd, ggb, ggt, gex, gre, gxt, g2w, g3w, gmx, gdoc, gslides, gsheet, kml, kmz, gqf, gqs, gac, ghf, gim, grv, gtm, tpl, vcg, hal, zmm, hbci, les, hpgl, hpid, hps, jlt, pcl, pclxl, sfd-hdstx, mpy, afp, listafp, list3820, irm, sc, icc, icm, igl, ivp, ivu, igm, xpw, xpx, i2g, qbo, qfx, rcprofile, irp, xpr, fcs, jam, rms, jisp, joda, ktz, ktr, karbon, chrt, kfo, flw, kon, kpr, kpt, ksp, kwd, kwt, htke, kia, kne, knp, skp, skd, skt, skm, sse, lasxml, lbd, lbe, apr, pre, nsf, org, scm, lwp, portpkg, mvt, mcd, mc1, cdkey, mwf, mfm, flo, igx, mif, daf, dis, mbk, mqy, msl, plc, txf, mpn, mpc, xul, cil, cab, xls, xlm, xla, xlc, xlt, xlw, xlam, xlsb, xlsm, xltm, eot, chm, ims, lrm, thmx, msg, cat, *stl, ppt, pps, pot, ppam, pptm, sldm, ppsm, potm, mpp, mpt, docm, dotm, wps, wks, wcm, wdb, wpl, xps, mseq, mus, msty, taglet, nlu, ntf, nitf, nnd, nns, nnw, *ac, ngdat, n-gage, rpst, rpss, edm, edx, ext, odc, otc, odb, odf, odft, odg, otg, odi, oti, odp, otp, ods, ots, odt, odm, ott, oth, xo, dd2, obgx, oxt, osm, pptx, sldx, ppsx, potx, xlsx, xltx, docx, dotx, mgp, dp, esa, pdb, pqa, oprc, paw, str, ei6, efif, wg, plf, pbd, box, mgz, qps, ptid, qxd, qxt, qwd, qwt, qxl, qxb, rar, bed, mxl, musicxml, cryptonote, cod, rm, rmvb, link66, st, see, sema, semd, semf, ifm, itp, iif, ipk, twd, twds, mmf, teacher, fo, sdkm, sdkd, dxp, sfs, sdc, sda, sdd, smf, sdw, vor, sgl, smzip, sm, wadl, sxc, stc, sxd, std, sxi, sti, sxm, sxw, sxg, stw, sus, susp, svd, sis, sisx, xsm, bdm, xdm, ddf, tao, pcap, cap, dmp, tmo, tpt, mxs, tra, ufd, ufdl, utz, umj, unityweb, uoml, vcx, vsd, vst, vss, vsw, vis, vsf, wbxml, wmlc, wmlsc, wtb, nbp, wpd, wqd, stf, xar, xfdl, hvd, hvs, hvp, osf, osfpvg, saf, spf, cmp, zir, zirz, zaz, 7z, abw, ace, *dmg, arj, aab, x32, u32, vox, aam, aas, bcpio, *bdoc, torrent, blb, blorb, bz, bz2, boz, cbr, cba, cbt, cbz, cb7, vcd, cfs, chat, pgn, crx, cco, nsc, cpio, csh, *deb, udeb, dgc, dir, dcr, dxr, cst, cct, cxt, w3d, fgd, swa, wad, ncx, dtb, res, dvi, evy, eva, bdf, gsf, psf, pcf, snf, pfa, pfb, pfm, afm, arc, spl, gca, ulx, gnumeric, gramps, gtar, hdf, php, install, *iso, *key, *numbers, *pages, jardiff, jnlp, kdbx, latex, luac, lzh, lha, run, mie, prc, mobi, application, lnk, wmd, wmz, xbap, mdb, obd, crd, clp, *exe, *dll, com, bat, *msi, mvb, m13, m14, *wmf, *wmz, *emf, emz, mny, pub, scd, trm, wri, nc, cdf, pac, nzb, pl, pm, *prc, *pdb, p12, pfx, p7b, spc, p7r, *rar, rpm, ris, sea, sh, shar, swf, xap, sql, sit, sitx, srt, sv4cpio, sv4crc, t3, gam, tar, tcl, tk, tex, tfm, texinfo, texi, *obj, ustar, hdd, ova, ovf, vbox, vbox-extpack, vdi, vhd, vmdk, src, webapp, der, crt, pem, fig, *xlf, xpi, xz, z1, z2, z3, z4, z5, z6, z7, z8, uva, uvva, eol, dra, dts, dtshd, lvp, pya, ecelp4800, ecelp7470, ecelp9600, rip, aac, aif, aiff, aifc, caf, flac, *m4a, mka, m3u, wax, wma, ram, ra, rmp, *ra, cdx, cif, cmdf, cml, csml, xyz, btif, pti, psd, azv, uvi, uvvi, uvg, uvvg, djvu, djv, *sub, dwg, dxf, fbs, fpx, fst, mmr, rlc, ico, dds, mdi, wdp, npx, b16, tap, vtf, wbmp, xif, pcx, 3ds, ras, cmx, fh, fhc, fh4, fh5, fh7, *ico, jng, sid, *bmp, *pcx, pic, pct, pnm, pbm, pgm, ppm, rgb, tga, xbm, xpm, xwd, wsc, dae, dwf, gdl, gtw, mts, ogex, x_b, x_t, vds, usdz, bsp, vtu, dsc, curl, dcurl, mcurl, scurl, sub, fly, flx, gv, 3dml, spot, jad, wml, wmls, s, asm, c, cc, cxx, cpp, h, hh, dic, htc, f, for, f77, f90, hbs, java, lua, mkd, nfo, opml, *org, p, pas, pde, sass, scss, etx, sfv, ymp, uu, vcs, vcf, uvh, uvvh, uvm, uvvm, uvp, uvvp, uvs, uvvs, uvv, uvvv, dvb, fvt, mxu, m4u, pyv, uvu, uvvu, viv, f4v, fli, flv, m4v, mkv, mk3d, mks, mng, asf, asx, vob, wm, wmv, wmx, wvx, avi, movie, smv, ice, mht, Example:
"pdf"
Example:
"application/pdf"
The base64 encoded content of the file to upload
Example:
"VGhpcyBpc24ndCByZWFsbHkgYSBzYW1wbGUgZmlsZSwgYnV0IG5vIG9uZSB3aWxsIGV2ZXIga25vdyE"
The categoryId of the documents
Example:
"6530"
The path for the file to be uploaded to
Example:
"/path/to/file"
The category to be associated with the file to be uploaded. Id will take precedence over name.
Show child attributes
Show child attributes
The category name to associate with the file
Available options:
resume, avatar, cover_letter, profile_picture, policy, passport, assessment, interview_attachment, take_home_test, offer_letter, signed_offer_letter, national_id, offer_packet, other, unmapped_value, Example:
"resume"
The provider specific category for associating uploaded files, if provided, the value will be ignored.
Example:
"550e8400-e29b-41d4-a716-446655440000"
Example:
{
"name": "resume",
"id": "550e8400-e29b-41d4-a716-446655440000"
}
Response
The application was created successfully.
Example:
201
Example:
"Record created successfully."
Example:
"2021-01-01T01:01:01.000Z"
Was this page helpful?
⌘I