Alladdin

Work in progress

Site en construction

الموقع قيد الإنشاء

Alladdin
GET

Get an employee

Scope: team:employees.read https://api.alladdin.com/api/v2/employees/{employeeId}

Returns a single employee by its ID.

Parameters

Path parameters

employeeId string required

Employee ID

Request

python
import requests

url = "https://api.alladdin.com/api/v2/employees/{employeeId}"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
    "Accept": "application/json",
}

response = requests.get(url, headers=headers)
print(response.json())

Responses

Response

json
{
  "id": "507f1f77bcf86cd799439011",
  "alladdin_user_id": "string",
  "name": "string",
  "last_name": "string",
  "full_name": "string",
  "date_of_birth": "string",
  "nationality": "string",
  "social_security_number": "string",
  "academic_level": "string",
  "languages": [
    "string"
  ],
  "main_language": "string",
  "code": "string",
  "gender": "string",
  "email": "string",
  "secondary_email": "string",
  "phone": "string",
  "mobile": "string",
  "address": {
    "address": "string",
    "city": "string",
    "postal_code": "string",
    "province": "string",
    "country": "string"
  },
  "team_ids": [
    "string"
  ],
  "workplace_id": "string",
  "iban": "string",
  "notes": "string",
  "current_contract": {
    "id": "string",
    "type": "string",
    "start_date": "2024-01-15",
    "end_date": "2024-01-15",
    "job_title": "string",
    "schedule_hours": 0,
    "schedule_mode": "string",
    "working_days": [
      "string"
    ],
    "salary": "30000.00",
    "salary_interval": "string",
    "salary_payments": 0,
    "salary_extra": [
      {}
    ]
  },
  "reporting_to": "string",
  "time_off_supervisors": [
    "string"
  ],
  "time_off_policy_id": "string",
  "terminated": 0,
  "terminated_type": "string",
  "terminated_reason": "string",
  "fiscal_residence": false,
  "fiscal_address": {
    "id_number": "string",
    "address": "string",
    "city": "string",
    "postal_code": "string",
    "province": "string",
    "country": "string",
    "deadline": "string",
    "city_of_birth": "string",
    "country_of_birth": "string"
  },
  "job_title": "string",
  "tags": [
    "string"
  ],
  "company_phone": "string",
  "custom_fields": [
    {}
  ],
  "payroll_accounts": {
    "es_nomina": {
      "salary": "507f1f77bcf86cd799439012",
      "tax": null,
      "companytax": null,
      "retention": null,
      "result": "507f1f77bcf86cd799439013"
    }
  }
}

Success responses

200 Employee found application/json object id string required

Unique identifier

alladdin_user_id string | null required

Linked Alladdin user ID

name string required

First name

last_name string required

Last name

full_name string required

Full name (first name + last name). Use this field to search or filter employees by name.

date_of_birth string | null required

Date of birth

nationality string required

Nationality code

social_security_number string required

Social security number

academic_level string required

Academic level

languages[] string[] required

Languages spoken

main_language string required

Main language code

code string required

Employee code

gender string required

Gender

email string required

Primary email

secondary_email string required

Secondary email

phone string | null required

Phone number

mobile string | null required

Mobile number

address object required

Employee address

address string

Street address

city string

City

postal_code string

Postal code

province string

Province or state

country string

Country code

team_ids[] string[] required

Team IDs

workplace_id string required

Workplace ID

iban string required

IBAN

notes string required

Notes

current_contract object | null required

Current employment contract

id string

Contract ID

type string

Contract type

start_date string<date> | null

Start date in ISO 8601 format (YYYY-MM-DD)

end_date string<date> | null

End date in ISO 8601 format (YYYY-MM-DD)

job_title string

Job title

schedule_hours integer | null

Schedule hours per week

schedule_mode string

Schedule mode

working_days[] string[]

Working days

salary string | null

Salary amount as a decimal string

salary_interval string

Salary interval (monthly, yearly)

salary_payments integer | null

Number of salary payments per year

salary_extra[] object[]

Extra salary components

reporting_to string | null required

Reporting-to employee ID

time_off_supervisors[] string[] required

Time-off supervisor IDs

time_off_policy_id string | null required

Time-off policy ID

terminated integer | null required

Termination timestamp

terminated_type string | null required

Termination type

terminated_reason string | null required

Termination reason

fiscal_residence boolean | null required

Fiscal residence flag

fiscal_address object required

Fiscal address for tax purposes

id_number string

Tax identification number

address string

Street address

city string

City

postal_code string

Postal code

province string

Province or state

country string

Country code

deadline string

Deadline

city_of_birth string

City of birth

country_of_birth string

Country of birth

job_title string required

Job title

tags[] string[] required

Tags

company_phone string required

Company phone

custom_fields[] object[] required

Custom fields

payroll_accounts object required

Per-scheme payroll accounting account IDs, empty when none are configured. Keys are scheme identifiers; each maps line types (salary, tax, companytax, retention, result) to accounting account IDs. The result account is the top-level accounting_account_id for a salary record. When populated, takes precedence over the salary-record form data defaults.

Error responses

401 Invalid or missing API key application/json 403 Insufficient permissions application/json 404 Employee not found application/json 429 Rate limit exceeded application/json

← PreviousList all employees →

Next →Get active contract →