v1

latestOpenAPI 3.0.02026-07-24310185.2 KB

Collaborator

Get a collaborator 🌍

Returns the collaborator by ID.
Required scopes: collaborators:read

get/companies/{companyId}/collaborators/{collaboratorId}

Path parameters

companyIdstring required

The id of the company

collaboratorIdstring required

The id of collaborator to fetch

Response

The collaborator with the given ID.

idstring required

Id of the collaborator.

matriculestring nullable required

Custom ID that can be set to a collaborator to ease their synchronization with external software.

firstNamestring required

Firstname of the collaborator.

lastNamestring required

Lastname of the collaborator.

secondLastNamestring nullable required

Second lastname of the collaborator. For now, it is possible that this field may be contained inside lastName field.

birthNamestring nullable required

Birth name of the collaborator.

birthDatestring date nullable required

Birth date of the collaborator in the format YYYY-MM-DD

terminationDatestring date nullable required

Date of the end of last active or current contract of the collaborator in the format YYYY-MM-DD

gender'male' | 'female' | 'other' | 'null' nullable required

The gender of the collaborator.

nationalitystring nullable

Nationality of the collaborator. It will be available if collaborators:legal-identity:read scope is set on the token. Possible values: AD,AF,ZA,AX,AL,DZ,DE,AO,AI,AQ,AG,SA,AR,AM,AW,AU,AT,AZ,BS,BH,BD,BB,BE,BZ,BJ,BM,BT,BY,BO,BQ,BA,BW,BV,BR,BN,BG,BF,BI,KY,KH,CM,CA,CV,CF,CL,CN,CX,CY,CC,CO,KM,CG,CD,CK,KR,KP,CR,CI,HR,CU,CW,DK,DJ,DO,DM,EG,SV,AE,EC,ER,ES,EE,US,ET,FK,FO,FJ,FI,FR,GA,GM,GE,GS,GH,GI,GR,GD,GL,GP,GU,GT,GG,GN,GQ,GW,GY,GF,HT,HM,HN,HK,HU,IM,UM,VG,VI,IN,ID,IR,IQ,IE,IS,IL,IT,JM,JP,JE,JO,KZ,KE,KG,KIXK,``,KW,LA,LS,LV,LB,LR,LY,LI,LT,LU,MO,MK,MG,MY,MW,MV,ML,MT,MP,MA,MH,MQ,MU,MR,YT,MX,FM,MD,MC,MN,ME,MS,MZ,MM,NA,NR,NP,NI,NE,NG,NU,NF,NO,NC,NZ,IO,OM,UG,UZ,PK,PW,PS,PA,PG,PY,NL,PE,PH,PN,PL,PF,PR,PT,QA,RE,RO,GB,RU,RW,EH,BL,KN,SM,MF,SX,PM,VA,VC,SH,LC,SB,WS,AS,ST,SN,RS,SC,SL,SG,SK,SI,SO,SD,SS,LK,SE,CH,SR,SJ,SZ,SY,TJ,TW,TZ,TD,CZ,TF,TH,TL,TG,TK,TO,TT,TN,TM,TC,TR,TV,UA,UY,VU,VE,VN,WF,YE,ZM,ZW.

countryOfBirthstring nullable

Country of birth of the collaborator. It will be available if collaborators:legal-identity:read scope is set on the token.

socialSecurityNumberstring nullable

"social Security number" of the collaborator. It will be available if collaborators:social-security:read scope is set on the token.

temporaryTechnicalNumberstring nullable

"numero technique temporaire" of the collaborator. It is used only for France, as a replacement for the social security number when not available yet for the collaborator. It will be available if collaborators:social-security:read scope is set on the token.

bicstring nullable

The collaborator's BIC (Bank Identifier Code). It will be available if collaborators:bank-info:read scope is set on the token.'

ibanstring nullable

The collaborator's IBAN (International Bank Account Number). It will be available if collaborators:bank-info:read scope is set on the token.'

managerIdstring nullable

The manager collaborator's id of the collaborator. If the collaborator does not have a manager this field will be null. Only available if collaborators:management:read scope is set on the token.

teamNamestring nullable

The team name of the collaborator. If the collaborator doesn't belong to a team, null will be returned. Only available if collaborators:management:read scope is set on the token.

Example response

{
  "birthDate": "2000-03-25",
  "terminationDate": "2022-03-25",
  "contracts": [
    {
      "startDate": "2022-03-25",
      "endDate": "2022-08-25"
    }
  ]
}