Get Employment Details
Get Employment Details
Use this endpoint to retrieve full employment details — job title, employment type, compensation history, work location, and status — for one or more employees in a single batch call.
Key Points
- Batch request — Request multiple individuals in one call by adding multiple objects to the
requestsarray. - Depends on —
individual_idvalues from GET /organization/directory.
POST organization/employment Header Parameters
| Field | Type | Description |
|---|---|---|
| Authorization | string | Required. Bearer token obtained from the Auth endpoint. Format: Bearer <access_token>. |
| X-TaxBandits-Version | string | API version string. Use 1.0.0. |
Query Parameters
| Field | Type | Description |
|---|---|---|
| entity_ids | string | The organization ID. Must be exactly one UUID. |
Request Body
| Field | Type | Description |
|---|---|---|
| requests | object[] | Array of individuals to look up. |
| individual_id | string | The employee UUID from the directory. |
Response Body
| Field | Type | Description |
|---|---|---|
| status | string | SUCCESS or FAILURE. |
| status_code | number | HTTP-style status code (e.g. 200, 400). |
| message | string | Human-readable status message. |
| response | object[] | One entry per requested individual. |
| individual_id | string | The employee UUID (mirrors body.id). |
| body | object | Employment details. |
| id | string | Employee UUID. |
| first_name | string | Employee first name. |
| middle_name | string | Employee middle name. null if not set. |
| last_name | string | Employee last name. |
| title | string | Job title. null if not set. |
| department | object | Department the employee belongs to. |
| name | string | Department name. null if not set. |
| employment | object | Employment type details. |
| type | string | Always employee. |
| subtype | string | Employment subtype. One of full_time, part_time, variable, seasonal. |
| start_date | string | Employment start date (YYYY-MM-DD). null if not set. |
| end_date | string | Termination date (YYYY-MM-DD). null if still active. |
| latest_rehire_date | string | Most recent rehire date (YYYY-MM-DD). null if not rehired. |
| is_active | boolean | true if the employee is currently active. |
| employment_status | string | active or terminated. |
| flsa_status | string | FLSA classification. One of exempt or non_exempt. |
| class_code | string | Classification code. Always null. |
| location | object | Work location. |
| line1 | string | Address line 1. |
| line2 | string | Address line 2. null if not set. |
| city | string | City. |
| state | string | State code (e.g. TX). |
| postal_code | string | ZIP code. |
| country | string | Always US. |
| income | object | Current compensation. |
| unit | string | Pay unit. One of hourly, weekly, monthly, yearly. |
| amount | string | Pay amount as a decimal string (e.g. "95000.00"). |
| currency | string | Always usd. |
| effective_date | string | Date this compensation took effect (YYYY-MM-DD). |
| income_history | object[] | Historical compensation records (same shape as income). |
Payload
Request Json
| Sample | Description | Action |
|---|---|---|
| Sample 1 | Look up employment details for one individual. |
Sample 1
{
"requests": [
{
"individual_id": "7a3f1c2d-11bb-4e6a-9c0d-f83a57e12346"
}
]
}
Response Json
| Sample | Description | Action |
|---|---|---|
| 200 | Success Response - This is a sample response for successful API requests. | |
| 400 | Bad Request Response - You'll get the below response when the request body fails validation. |
{
"status": "SUCCESS",
"status_code": 200,
"message": "Request processed successfully",
"response": [
{
"individual_id": "7a3f1c2d-11bb-4e6a-9c0d-f83a57e12346",
"body": {
"id": "7a3f1c2d-11bb-4e6a-9c0d-f83a57e12346",
"first_name": "John",
"middle_name": null,
"last_name": "Doe",
"title": "Senior Engineer",
"department": {
"name": "Engineering"
},
"employment": {
"type": "employee",
"subtype": "full_time"
},
"start_date": "2020-01-15",
"end_date": null,
"latest_rehire_date": null,
"is_active": true,
"employment_status": "active",
"flsa_status": "exempt",
"class_code": null,
"location": {
"line1": "100 Congress Ave",
"line2": null,
"city": "Austin",
"state": "TX",
"postal_code": "78701",
"country": "US"
},
"income": {
"unit": "yearly",
"amount": "95000.00",
"currency": "usd",
"effective_date": "2024-01-01"
},
"income_history": [
{
"unit": "yearly",
"amount": "85000.00",
"currency": "usd",
"effective_date": "2020-01-15"
}
]
}
}
]
}