Skip to main content
GET
Get collaborator by id

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

organizationId
string
required
collaboratorId
string
required

Query Parameters

establishmentId
string

Response

200 - application/json

Successful response

id
string
required
status
enum<string>
required

Employment status relative to today.

  • past: all contracts are inactive.
  • active: at least one contract is active.
  • future: only an upcoming contract, with no active or past contract.
Available options:
past,
active,
future
isProfileComplete
boolean
required
personnelNumber
string | null
required
title
enum<string> | null
required
Available options:
mr,
mrs
firstName
string
required
lastName
string
required
email
string<email>
required
birthName
string

Needs scope org:employee:details:read

secondaryEmail
string<email> | null

Needs scope org:employee:details:read

phoneNumber
string | null

Needs scope org:employee:details:read

birthDate
string<date-time> | null

Needs scope org:employee:details:read

birthCity
string | null

Needs scope org:employee:details:read

countryOfBirth
enum<string> | null

Needs scope org:employee:details:read

Available options:
af,
al,
dz,
ad,
ao,
ag,
ar,
am,
au,
at,
az,
bs,
bh,
bd,
bb,
by,
be,
bz,
bj,
bt,
bo,
ba,
bw,
br,
bn,
bg,
bf,
bi,
cv,
kh,
cm,
ca,
cf,
td,
cl,
cn,
co,
km,
cd,
cg,
cr,
ci,
hr,
cu,
cy,
cz,
dk,
dj,
dm,
do,
ec,
eg,
sv,
gq,
er,
ee,
sz,
et,
fj,
fi,
fr,
ga,
gm,
ge,
de,
gh,
gr,
gd,
gt,
gn,
gw,
gy,
ht,
hn,
hu,
is,
in,
id,
ir,
iq,
ie,
il,
it,
jm,
jp,
jo,
kz,
ke,
ki,
kp,
kr,
kw,
kg,
la,
lv,
lb,
ls,
lr,
ly,
li,
lt,
lu,
mg,
mw,
my,
mv,
ml,
mt,
mh,
mr,
mu,
mx,
fm,
md,
mc,
mn,
me,
ma,
mz,
mm,
na,
nr,
np,
nl,
nz,
ni,
ne,
ng,
mk,
no,
om,
pk,
pw,
pa,
pg,
py,
pe,
ph,
pl,
pt,
qa,
ro,
ru,
rw,
kn,
lc,
vc,
ws,
sm,
st,
sa,
sn,
rs,
sc,
sl,
sg,
sk,
si,
sb,
so,
za,
ss,
es,
lk,
sd,
sr,
se,
ch,
sy,
tj,
tz,
th,
tl,
tg,
to,
tt,
tn,
tr,
tm,
tv,
tw,
ug,
ua,
ae,
gb,
us,
uy,
uz,
vu,
ve,
vn,
ye,
zm,
zw
nationality
enum<string> | null

Needs scope org:employee:details:read

Available options:
af,
al,
dz,
ad,
ao,
ag,
ar,
am,
au,
at,
az,
bs,
bh,
bd,
bb,
by,
be,
bz,
bj,
bt,
bo,
ba,
bw,
br,
bn,
bg,
bf,
bi,
cv,
kh,
cm,
ca,
cf,
td,
cl,
cn,
co,
km,
cd,
cg,
cr,
ci,
hr,
cu,
cy,
cz,
dk,
dj,
dm,
do,
ec,
eg,
sv,
gq,
er,
ee,
sz,
et,
fj,
fi,
fr,
ga,
gm,
ge,
de,
gh,
gr,
gd,
gt,
gn,
gw,
gy,
ht,
hn,
hu,
is,
in,
id,
ir,
iq,
ie,
il,
it,
jm,
jp,
jo,
kz,
ke,
ki,
kp,
kr,
kw,
kg,
la,
lv,
lb,
ls,
lr,
ly,
li,
lt,
lu,
mg,
mw,
my,
mv,
ml,
mt,
mh,
mr,
mu,
mx,
fm,
md,
mc,
mn,
me,
ma,
mz,
mm,
na,
nr,
np,
nl,
nz,
ni,
ne,
ng,
mk,
no,
om,
pk,
pw,
pa,
pg,
py,
pe,
ph,
pl,
pt,
qa,
ro,
ru,
rw,
kn,
lc,
vc,
ws,
sm,
st,
sa,
sn,
rs,
sc,
sl,
sg,
sk,
si,
sb,
so,
za,
ss,
es,
lk,
sd,
sr,
se,
ch,
sy,
tj,
tz,
th,
tl,
tg,
to,
tt,
tn,
tr,
tm,
tv,
tw,
ug,
ua,
ae,
gb,
us,
uy,
uz,
vu,
ve,
vn,
ye,
zm,
zw
address
object

Needs scope org:employee:details:read

seniorityDate
string<date-time> | null

Needs scope org:employee:details:read

socialSecurityNumber
string | null

Needs scope org:employee:details:read

bankAccount
object

Needs scope org:employee:details:read

manager
object | null

Needs scope org:employee:details:read

team
object | null

Needs scope org:employee:details:read

contracts
object[]

Needs scope org:contract:details:read