# Employees

**GET /2023-03-01/xhr/employees**

List the individuals (employees, contractors, accountants, and others)
listed in the HRIS/Payroll software



## Servers
- Production server (EU): https://api.affixapi.com (Production server (EU))
- Development server (EU): https://dev.api.affixapi.com (Development server (EU))


## Authentication methods
- Access token


## Parameters


### Query parameters
- **employment_status** (string)
  Optional query parameter. Use to enable server-side filtering of the
  `employment_status` attribute. Will only include individuals with that
  attribute explicitly set (ie if an individuals has a `null`, it will
  not be returned if this parameter is set)


## Responses
### 200
Success

#### Body: application/json (array[object])
- **id** (string)
  The Affix-assigned id of the individual
- **remote_id** (string)
  the remote system-assigned id of the individual
- **employee_number** (string | null)

- **first_name** (string)
  the first name of the individual
- **last_name** (string)
  the last name of the individual
- **display_full_name** (string | null)

- **nationality** (string | null)

- **job_title** (string | null)

- **work_email** (string | null)
  the work email of the individual
- **personal_email** (string | null)
  the personal email of the individual
- **mobile_phone_number** (string | null)
  +1234567890
- **tax_id** (string | null)

- **gender** (string | null)

- **ethnicity** (string | null)

- **marital_status** (string | null)
  `other` option can include co-habitating, civil partnership,
  separated, widowed, etc
- **date_of_birth** (string(date) | null)

- **employment_status** (string | null)

- **employment_type** (string | null)

- **start_date** (string(date) | null)

- **remote_created_at** (string(date) | null)

- **termination_date** (string(date) | null)

- **avatar** (string | null)

- **home_location** (object | null)

- **work_location** (object | null)

- **manager** (object | null)

- **bank_account** (object | null)

- **employment_history** (array[object] | null)

- **compensation_history** (array[object] | null)

- **custom_fields** (object | null)

- **groups** (array[object] | null)

- **dependents** (array[object] | null)

- **emergency_contacts** (array[object] | null)


### 202
Accepted + pending (async job started)
#### Headers
- **Retry-After** (integer)
  Retry your call after the specified amount of seconds

#### Body: application/json (object)
- **message** (string)


### 401
Authentication Error

#### Body: application/json (object)
- **error** (string)
  The type of error
- **message** (string)
  A descriptive description of the error
- **code** (string)


### 429
Rate Limited / Too Many Requests
#### Headers
- **Retry-After** (integer)
  Retry your call after the specified amount of seconds

#### Body: application/json (object)
- **message** (string)


### 500
Server Error

#### Body: application/json (object)
- **message** (string)


### 501
Not Implemented

#### Body: application/json (object)
- **message** (string)



[Powered by Bump.sh](https://bump.sh)