Get Application

Authorizations

Authorization

string

header

required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Headers

x-account-id

string

required

The account identifier

Path Parameters

string

required

Query Parameters

raw

boolean | null

Indicates that the raw request result should be returned in addition to the mapped result (default value is false)

proxy

object

Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key

fields

string | null

The comma separated list of fields that will be returned in the response (if empty, all fields are returned)

Example:

"id,remote_id,candidate_id,remote_candidate_id,job_id,remote_job_id,job_posting_id,remote_job_posting_id,interview_stage,interview_stage_id,remote_interview_stage_id,application_stage,application_stage_id,remote_application_stage_id,rejected_reason,rejected_reason_id,remote_rejected_reason_id,rejected_reason_ids,remote_rejected_reason_ids,rejected_reasons,rejected_at,location_id,remote_location_id,location_ids,remote_location_ids,status,application_status,questionnaires,attachments,result_links,source,created_at,updated_at,documents,custom_fields,candidate,unified_custom_fields"

expand

string | null

The comma separated list of fields that will be expanded in the response

Example:

"documents"

include

string | null

The comma separated list of fields that will be included in the response

Example:

"attachments,custom_fields"

Response

The application with the given identifier was retrieved.

data

object

required

Show child attributes

data.id

string | null

Unique identifier

Example:

"8187e5da-dc77-475e-9949-af0f1fa4e4e3"

data.remote_id

string | null

Provider's unique identifier

Example:

"8187e5da-dc77-475e-9949-af0f1fa4e4e3"

data.unified_custom_fields

object

Custom Unified Fields configured in your StackOne project

Example:

{
  "my_project_custom_field_1": "REF-1236",
  "my_project_custom_field_2": "some other value"
}

data.candidate_id

string | null

Unique identifier of the candidate

Example:

"e3cb75bf-aa84-466e-a6c1-b8322b257a48"

data.remote_candidate_id

string | null

Provider's unique identifier of the candidate

Example:

"e3cb75bf-aa84-466e-a6c1-b8322b257a48"

data.job_id

string | null

Unique identifier of the job

Example:

"4071538b-3cac-4fbf-ac76-f78ed250ffdd"

data.remote_job_id

string | null

Provider's unique identifier of the job

Example:

"4071538b-3cac-4fbf-ac76-f78ed250ffdd"

data.interview_stage

object

deprecated

Show child attributes

data.interview_stage.id

string | null

Unique identifier

Example:

"8187e5da-dc77-475e-9949-af0f1fa4e4e3"

data.interview_stage.remote_id

string | null

Provider's unique identifier

Example:

"8187e5da-dc77-475e-9949-af0f1fa4e4e3"

data.interview_stage.unified_custom_fields

object

Custom Unified Fields configured in your StackOne project

Example:

{
  "my_project_custom_field_1": "REF-1236",
  "my_project_custom_field_2": "some other value"
}

data.interview_stage.name

string | null

data.interview_stage.order

number | null

data.interview_stage.created_at

string<date-time> | null

Interview Stage created date

Example:

"2021-01-01T01:01:01.000Z"

data.interview_stage.updated_at

string<date-time> | null

Interview Stage updated date

Example:

"2021-01-01T01:01:01.000Z"

data.application_stage

object

Show child attributes

data.application_stage.id

string | null

Unique identifier

Example:

"8187e5da-dc77-475e-9949-af0f1fa4e4e3"

data.application_stage.remote_id

string | null

Provider's unique identifier

Example:

"8187e5da-dc77-475e-9949-af0f1fa4e4e3"

data.application_stage.unified_custom_fields

object

Custom Unified Fields configured in your StackOne project

Example:

{
  "my_project_custom_field_1": "REF-1236",
  "my_project_custom_field_2": "some other value"
}

data.application_stage.name

string | null

Application Stage name

Example:

"Review"

data.application_stage.order

number | null

Application Stage order

Example:

"1"

data.application_stage.created_at

string<date-time> | null

Application Stage created date

Example:

"2021-01-01T01:01:01.000Z"

data.application_stage.updated_at

string<date-time> | null

Application Stage updated date

Example:

"2021-01-01T01:01:01.000Z"

data.interview_stage_id

string | null

deprecated

Unique identifier of the interview stage

Example:

"18bcbb1b-3cbc-4198-a999-460861d19480"

data.remote_interview_stage_id

string | null

deprecated

Provider's unique identifier of the interview stage

Example:

"18bcbb1b-3cbc-4198-a999-460861d19480"

data.application_stage_id

string | null

Unique identifier of the application stage

Example:

"18bcbb1b-3cbc-4198-a999-460861d19480"

data.remote_application_stage_id

string | null

Unique identifier of the application stage

Example:

"18bcbb1b-3cbc-4198-a999-460861d19480"

data.rejected_reasons

object[] | null

Show child attributes

data.rejected_reasons.id

string | null

Unique identifier

Example:

"8187e5da-dc77-475e-9949-af0f1fa4e4e3"

data.rejected_reasons.remote_id

string | null

Provider's unique identifier

Example:

"8187e5da-dc77-475e-9949-af0f1fa4e4e3"

data.rejected_reasons.unified_custom_fields

object

Custom Unified Fields configured in your StackOne project

Example:

{
  "my_project_custom_field_1": "REF-1236",
  "my_project_custom_field_2": "some other value"
}

data.rejected_reasons.label

string | null

The label of the rejected reason.

Example:

"Failed Phone Screen"

data.rejected_reasons.type

string | null

deprecated

The string type of the rejected reason.

Example:

"rejected_by_organization"

data.rejected_reasons.rejected_reason_type

object

Show child attributes

data.rejected_reasons.rejected_reason_type.value

enum<string> | null

The type of the rejected reason.

Available options:

rejected_by_candidate,

rejected_by_organization,

other,

unknown,

unmapped_value,

Example:

"rejected_by_organization"

data.rejected_reasons.rejected_reason_type.source_value

The source value of the rejected reason type.

Example:

"RejectedByOrg"

data.rejected_reason_ids

string[] | null

Unique identifiers of the rejection reasons

Example:

["f223d7f6-908b-48f0-9237-b201c307f609"]

data.remote_rejected_reason_ids

string[] | null

Provider's unique identifiers of the rejection reasons

Example:

["f223d7f6-908b-48f0-9237-b201c307f609"]

data.rejected_at

string<date-time> | null

Date of rejection

Example:

"2021-01-01T01:01:01.000Z"

data.location_id

string | null

deprecated

Unique identifier of the location

Example:

"dd8d41d1-5eb8-4408-9c87-9ba44604eae4"

data.remote_location_id

string | null

deprecated

Provider's unique identifier of the location

Example:

"dd8d41d1-5eb8-4408-9c87-9ba44604eae4"

data.location_ids

string[] | null

Unique identifiers of the locations

Example:

["dd8d41d1-5eb8-4408-9c87-9ba44604eae4"]

data.remote_location_ids

string[] | null

Remote's unique identifiers of the locations

Example:

["dd8d41d1-5eb8-4408-9c87-9ba44604eae4"]

data.application_status

object

Show child attributes

data.application_status.value

enum<string> | null

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"

data.application_status.source_value

The source value of the application status.

Example:

"Hired"

data.questionnaires

object[] | null

Questionnaires associated with the application

Show child attributes

data.questionnaires.id

string | null

Unique identifier

Example:

"8187e5da-dc77-475e-9949-af0f1fa4e4e3"

data.questionnaires.remote_id

string | null

Provider's unique identifier

Example:

"8187e5da-dc77-475e-9949-af0f1fa4e4e3"

data.questionnaires.answers

object[] | null

Show child attributes

data.questionnaires.answers.id

string | null

Unique identifier

Example:

"8187e5da-dc77-475e-9949-af0f1fa4e4e3"

data.questionnaires.answers.remote_id

string | null

Provider's unique identifier

Example:

"8187e5da-dc77-475e-9949-af0f1fa4e4e3"

data.questionnaires.answers.type

object

Type of the answer

Show child attributes

data.questionnaires.answers.type.value

enum<string> | null

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"

data.questionnaires.answers.type.source_value

The source value of the answer type.

Example:

"Short Text"

data.questionnaires.answers.values

string[] | null

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"]
    }
  ]
}

data.candidate

object

Show child attributes

data.candidate.name

string | null

Candidate name

Example:

"Romain Sestier"

data.candidate.first_name

string | null

First name of the candidate

Example:

"John"

data.candidate.last_name

string | null

Last name of the candidate

Example:

"Doe"

data.candidate.email

string | null

Email of the candidate

Example:

"[email protected]"

data.candidate.emails

object[] | null

List of candidate emails

Show child attributes

data.candidate.emails.type

string | null

Type of the email

Example:

"personal"

data.candidate.emails.value

string | null

Email value

Example:

"[email protected]"

data.candidate.phone_numbers

object[] | null

List of candidate phone numbers including the type of the number when available

Show child attributes

data.candidate.phone_numbers.type

enum<string> | null

Type of phone number

Available options:

personal,

work,

mobile,

home,

unknown,

other,

unmapped_value,

data.candidate.phone_numbers.phone

string | null

Phone number string

Example:

"+447700112233"

List of candidate social links

Show child attributes

Type of the social link

Example:

"linkedin"

URL of the social link

Example:

"https://www.linkedin.com/in/romainsestier/"

data.candidate.company

string | null

Candidate company

Example:

"Company Inc."

data.candidate.title

string | null

Candidate title

Example:

"Software Engineer"

data.attachments

object[] | null

deprecated

Use documents expand instead

Show child attributes

data.attachments.file_name

string | null

The file name of the attachment.

Example:

"resume.pdf"

data.attachments.content

string | null

The content of the attachment.

Example:

"Base64 encoded content"

data.attachments.url

string | null

The URL of the attachment.

Example:

"http://example.com/resume.pdf"

data.attachments.content_type

object

Show child attributes

data.attachments.content_type.value

enum<string> | null

The content type of the attachment.

Available options:

text,

pdf,

video,

other,

unmapped_value,

Example:

"text"

data.attachments.content_type.source_value

The source value of the content type.

Example:

"Text"

data.documents

object[] | null

The documents attached to this application (eg. resume, cover letter etc.)

Show child attributes

data.documents.id

string | null

Unique identifier

Example:

"8187e5da-dc77-475e-9949-af0f1fa4e4e3"

data.documents.remote_id

string | null

Provider's unique identifier

Example:

"8187e5da-dc77-475e-9949-af0f1fa4e4e3"

data.documents.name

string | null

The name of the file

Example:

"My Document"

data.documents.category

object

The category of the the document

Show child attributes

data.documents.category.value

string | null

The category of the file

data.documents.category.source_value

Example:

"templates, forms, backups, etc."

data.documents.contents

object[] | null

deprecated

The content of the file. Deprecated, use url and file_format one level up instead

Show child attributes

data.documents.contents.url

string | null

URL where the file content is located

Example:

"https://example.com/file.pdf"

data.documents.contents.unified_url

string | null

Unified download URL for retrieving file content.

Example:

"https://api.stackone.com/unified/hris/employees/12345/documents/67890/download"

data.documents.contents.file_format

object

The file format of the file

Show child attributes

data.documents.contents.file_format.value

enum<string> | null

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"

data.documents.contents.file_format.source_value

Example:

"application/pdf"

data.documents.category_id

string | null

The categoryId of the documents

Example:

"6530"

data.documents.created_at

string<date-time> | null

The creation date of the file

Example:

"2021-01-01T01:01:01.000Z"

data.documents.updated_at

string<date-time> | null

The update date of the file

Example:

"2021-01-02T01:01:01.000Z"

data.documents.remote_url

string | null

URL where the file content is located

Example:

"https://example.com/file.pdf"

data.documents.file_format

object

The file format of the file

Show child attributes

data.documents.file_format.value

enum<string> | null

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"

data.documents.file_format.source_value

Example:

"application/pdf"

data.documents.unified_custom_fields

object

Custom Unified Fields configured in your StackOne project

Example:

{
  "my_project_custom_field_1": "REF-1236",
  "my_project_custom_field_2": "some other value"
}

data.documents.type

object

deprecated

The content type of the document

Show child attributes

data.documents.type.value

enum<string> | null

The category of 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,

data.documents.type.source_value

data.result_links

object[] | null

Show child attributes

data.result_links.label

string | null

The label of the result link.

Example:

"test result link"

data.result_links.url

string | null

The URL of the result link.

Example:

"http://example.com/test-result/4565765/data"

data.source

object

Show child attributes

data.source.id

string | null

Unique identifier

Example:

"8187e5da-dc77-475e-9949-af0f1fa4e4e3"

data.source.remote_id

string | null

Provider's unique identifier

Example:

"8187e5da-dc77-475e-9949-af0f1fa4e4e3"

data.source.name

string | null

The source of the application

Example:

"LinkedIn"

data.created_at

string<date-time> | null

Date of creation

Example:

"2021-01-01T01:01:01.000Z"

data.updated_at

string<date-time> | null

Date of last update

Example:

"2021-01-01T01:01:01.000Z"

data.custom_fields

object[] | null

The application custom fields

Show child attributes

data.custom_fields.id

string | null

Unique identifier

Example:

"8187e5da-dc77-475e-9949-af0f1fa4e4e3"

data.custom_fields.remote_id

string | null

Provider's unique identifier

Example:

"8187e5da-dc77-475e-9949-af0f1fa4e4e3"

data.custom_fields.name

string | null

The name of the custom field.

Example:

"Training Completion Status"

data.custom_fields.value

The value associated with the custom field.

Example:

"Completed"

data.custom_fields.value_id

string | null

The unique identifier for the value of the custom field.

Example:

"value_456"

data.custom_fields.remote_value_id

string | null

Provider's unique identifier for the value of the custom field.

Example:

"e3cb75bf-aa84-466e-a6c1-b8322b257a48"

raw

object[] | null

Show child attributes

raw.method

string

required

raw.url

string

required

raw.body

object

raw.response

Getting Started

Use Cases

API Reference

Authorizations

Headers

Path Parameters

Query Parameters

Response