Skip to main content
Version: 1.7.3

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 requests array.
  • Depends onindividual_id values from GET /organization/directory.
POST organization/employment 

Header Parameters

FieldTypeDescription
AuthorizationstringRequired. Bearer token obtained from the Auth endpoint. Format: Bearer <access_token>.
X-TaxBandits-VersionstringAPI version string. Use 1.0.0.

Query Parameters

FieldTypeDescription
entity_idsstringThe organization ID. Must be exactly one UUID.

Request Body

FieldTypeDescription
requestsobject[]Array of individuals to look up.
   individual_idstringThe employee UUID from the directory.

Response Body

FieldTypeDescription
statusstringSUCCESS or FAILURE.
status_codenumberHTTP-style status code (e.g. 200, 400).
messagestringHuman-readable status message.
responseobject[]One entry per requested individual.
   individual_idstringThe employee UUID (mirrors body.id).
   bodyobjectEmployment details.
     idstringEmployee UUID.
     first_namestringEmployee first name.
     middle_namestringEmployee middle name. null if not set.
     last_namestringEmployee last name.
     titlestringJob title. null if not set.
     departmentobjectDepartment the employee belongs to.
       namestringDepartment name. null if not set.
     employmentobjectEmployment type details.
       typestringAlways employee.
       subtypestringEmployment subtype. One of full_time, part_time, variable, seasonal.
     start_datestringEmployment start date (YYYY-MM-DD). null if not set.
     end_datestringTermination date (YYYY-MM-DD). null if still active.
     latest_rehire_datestringMost recent rehire date (YYYY-MM-DD). null if not rehired.
     is_activebooleantrue if the employee is currently active.
     employment_statusstringactive or terminated.
     flsa_statusstringFLSA classification. One of exempt or non_exempt.
     class_codestringClassification code. Always null.
     locationobjectWork location.
       line1stringAddress line 1.
       line2stringAddress line 2. null if not set.
       citystringCity.
       statestringState code (e.g. TX).
       postal_codestringZIP code.
       countrystringAlways US.
     incomeobjectCurrent compensation.
       unitstringPay unit. One of hourly, weekly, monthly, yearly.
       amountstringPay amount as a decimal string (e.g. "95000.00").
       currencystringAlways usd.
       effective_datestringDate this compensation took effect (YYYY-MM-DD).
     income_historyobject[]Historical compensation records (same shape as income).

Request Json

SampleDescriptionAction
Sample 1
Look up employment details for one individual.
Sample 1
{
"requests": [
{
"individual_id": "7a3f1c2d-11bb-4e6a-9c0d-f83a57e12346"
}
]
}

Response Json

SampleDescriptionAction
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"
}
]
}
}
]
}