---
title: "Get a collaborator 🌍"
method: GET
path: "/companies/{companyId}/collaborators/{collaboratorId}"
tags: ["Collaborator"]
---

# Get a collaborator 🌍

`GET /companies/{companyId}/collaborators/{collaboratorId}`

## Request

- Base URL: `https://partner-api.payfit.com`
- URL: `https://partner-api.payfit.com/companies/{companyId}/collaborators/{collaboratorId}`
- Auth: OAuth 2
  - Authorization code: `https://oauth.payfit.com/authorize`
  - Token URL: `https://oauth.payfit.com/token` scopes: `collaborators:read`
- TypeScript: <https://skmtc.dev/payfit/apis/partner-api/docs/companies/:companyId/collaborators/:collaboratorId/get.ts> (a function with typed inputs; its response is checked against the schema)

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

## Path parameters

- `companyId` string, required
- `collaboratorId` string, uuid, required

## Response `200`

The collaborator with the given ID.

- object
  - `id` string, required: Id of the collaborator.
  - `matricule` string, nullable, required: Custom ID that can be set to a collaborator to ease their synchronization with external software.
  - `firstName` string, required: Firstname of the collaborator.
  - `lastName` string, required: Lastname of the collaborator.
  - `secondLastName` string, nullable, required: Second lastname of the collaborator. For now, it is possible that this field may be contained inside lastName field.
  - `birthName` string, nullable, required: Birth name of the collaborator.
  - `birthDate` string, date, nullable, required: Birth date of the collaborator in the format YYYY-MM-DD
  - `terminationDate` string, 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.
  - `nationality` string, 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`.
  - `countryOfBirth` string, nullable: Country of birth of the collaborator. It will be available if `collaborators:legal-identity:read` scope is set on the token.
  - `socialSecurityNumber` string, nullable: "social Security number" of the collaborator. It will be available if `collaborators:social-security:read` scope is set on the token.
  - `temporaryTechnicalNumber` string, 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.
  - `bic` string, nullable: The collaborator's BIC (Bank Identifier Code). It will be available if `collaborators:bank-info:read` scope is set on the token.'
  - `iban` string, nullable: The collaborator's IBAN (International Bank Account Number). It will be available if `collaborators:bank-info:read` scope is set on the token.'
  - `emails` object[], required: List of emails of the collaborator.
    - `email` string, required: Email of the collaborator.
    - `type` 'professional' | 'personal' | 'unknown', required: Indicates whether this is a personal or a professional email. For historical reasons, we can't always tell with certitude if an address is personal or professional, so in some cases the type might be 'unknown'.
  - `phoneNumbers` object[]: List of phone numbers of the collaborator. Personal phone number will be available if `collaborators:personal:read` scope is set on the token.
    - `phoneNumber` string, required: Phone number of the collaborator.
    - `type` 'personal', required: Type of the phone number.
  - `addresses` object[]: List of addresses of the collaborator. Personal address will be available if `collaborators:personal:read` scope is set on the token.
    - `address` string, required: Address of the collaborator containing the streetNumber, streetType and streetName.
    - `postcode` string, required: Postcode of the collaborator's address.
    - `city` string, required: City of the collaborator's address.
    - `country` string: Country of the collaborator's address.
    - `type` 'personal', required: Type of the address.
  - `managerId` string, 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.
  - `teamName` string, 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.
  - `contracts` object[]: The list of contracts of the collaborator. Only available if `collaborators:contracts:read` scope is set on the token.
    - `id` string, required: Id of the contract.
    - `startDate` string, date, nullable, required: Start date of a contract in the format YYYY-MM-DD.
    - `endDate` string, date, nullable, required: End date of a contract in the format YYYY-MM-DD. **Warning**: In some cases, a contract can have status `ARCHIVED` but no contract end date.
    - `status` 'ACTIVE' | 'ARCHIVED' | 'PENDING', required: The status of the contract.

## Other responses

- `400`: Bad Request
- `401`: Unauthorized
- `403`: Forbidden
- `404`: Not Found

## Changes

- **2026-11-03** `4ad2186afd5e`: 1 breaking
  - for the `path` request parameter `collaboratorId`, the format changed from no format to `uuid`

[Operation history](https://skmtc.dev/payfit/apis/partner-api/changes/companies/:companyId/collaborators/:collaboratorId/get.md)

---

[API](https://skmtc.dev/payfit/apis/partner-api.md) - [All operations](https://skmtc.dev/payfit/apis/partner-api/llms.txt) - [OpenAPI document](https://skmtc.dev/payfit/apis/partner-api/revisions/4ad2186afd5e?raw)