EndpointsEmployees

Get employee from organization integrated with external benefits vendor

Get employee from organization integrated with external benefits vendor Token scopes: people:read

Authentication

AuthorizationBearer
## Authentication Deel API uses API tokens to authenticate requests. A bearer token is required to authenticate all API requests. All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. ``` curl -X GET 'api.letsdeel.com/rest/v2/contracts' \ -H 'Authorization: Bearer YOUR-TOKEN-HERE' ``` ### Generating Access Tokens 1. Navigate to **Apps & Perks > Developer Center**. 2. Click on the “Generate New Token” button. 3. In the popup, click “Generate Token” button to generate a new token. Your newly generated token is visible on the screen. 4. Make sure to copy and save your token once is generated. You won't be able to see it again!
OR
AuthorizationBearer
Standard OAuth2 security scheme based on https://swagger.io/docs/specification/authentication/

Path parameters

idstringRequired
Id from the legal entity to fetch data
employee_idstringRequired
Employee id from the legal entity to fetch data

Query parameters

active_contractsbooleanOptionalDefaults to true
Fetch only active contracts for employees

Response

Successful operation.
idstring or null
Unique identifier for the employee.
phoneslist of objects or null
List of phone numbers associated with the employee.
statusstring or null
The employee status given his contracts.
addresseslist of objects or null
List of addresses associated with the employee.
contractslist of objects or null
List of contracts associated with the employee.
hire_datestring or null
Employee date of first contract.
work_emailstring or null
Employee work email address.
date_of_birthstring or null
Employee date of birth.
marital_statusenum or null
The marital status of the employee.
personal_emailstring or null
Employee personal email address.
document_numberstring or null
Document number of employee identification document.
legal_last_namestring or null
Employee legal last name.
legal_first_namestring or null
Employee legal first name.
legal_middle_namestring or null
Employee legal middle name.
takes_owners_drawboolean or null
Indicates if the employee takes an owner draw.
ownership_percentagedouble or null
The percentage of business ownership by the employee.

Errors