curl --request GET \
--url https://api.example.com/organizations/{organization_id}/employees \
--header 'Authorization: Bearer <token>'{
"items": [
{
"id": "<string>",
"organizationId": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"employeeData": {
"birthDate": "2023-12-25",
"personalData": {
"id": 123,
"employeeId": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"employeeName": {
"familyName": "<string>",
"givenName": "<string>",
"familyNamePrefix": "<string>",
"givenNameSuffix": "<string>",
"birthName": "<string>",
"birthFamilyNamePrefix": "<string>",
"birthGivenNameSuffix": "<string>",
"title": "<string>"
},
"employmentCountry": "DE",
"gender": "M",
"maritalStatus": "Single",
"nationality": "<string>",
"residenceAddress": "<string>",
"statusIndicator": "managing_partner_gmbh_ug",
"validFrom": "2023-12-25",
"validTo": "2023-12-25"
},
"relatedPersons": {
"id": 123,
"employeeId": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"persons": [
{}
],
"employmentCountry": "DE",
"validFrom": "2023-12-25",
"validTo": "2023-12-25"
},
"jobDetails": {
"id": 123,
"employeeId": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"employmentCountry": "DE",
"jobType": "Full Time Indefinite Term",
"employmentStatus": "Employee",
"isSeasonalWorker": true,
"jobTitle": "<string>",
"jobDescription": "<string>",
"schoolEducation": "Ohne Schulabschluss",
"professionalEducation": "Ohne beruflichen Ausbildungsabschluss",
"occupationCode": "<string>",
"contractedWeeklyHours": 40,
"contractedWeekdays": [
"Monday"
],
"contractedToOtherCompany": false,
"worksiteId": "<string>",
"department": "<string>",
"otherJobs": [
{
"employmentCountry": "DE",
"employerName": "<string>",
"employmentStartDate": "2023-12-25",
"monthlyGrossIncome": "<string>"
}
],
"validFrom": "2023-12-25",
"validTo": "2023-12-25"
},
"insuranceDetails": {
"id": 123,
"employeeId": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"employmentCountry": "DE",
"insuranceNumber": "<string>",
"contributionGroup": "<string>",
"personGroup": 101,
"insuranceProvider": "<string>",
"alternateCollectionAgency": "<string>",
"privateInsuranceHealthMonthly": "0",
"privateInsuranceCareMonthly": "0",
"careInsuranceChildren": 0,
"u1Exempt": false,
"u2Exempt": false,
"uvRiskTariff": [
{
"tariffCode": "<string>",
"tariffDescription": "<string>",
"tariffPercentage": "0"
}
],
"pensionDetails": {
"employmentCountry": "DE",
"receivedMiningAdjustmentPayments": false,
"pensionType": "full_old_age_pension_eu_eea_sva",
"pensionStartDate": "2023-12-25",
"waiverDeclarationStatus": "default",
"waiverReceiptDate": "2023-12-25",
"waiverValidityDate": "2023-12-25"
},
"validFrom": "2023-12-25",
"validTo": "2023-12-25"
},
"taxDetails": {
"id": 123,
"employeeId": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"taxId": "<string>",
"taxClass": "1",
"employmentCountry": "DE",
"childAllowances": "0.0",
"churchConfession": "AK",
"churchConfessionPartner": "AK",
"factorProcedure": false,
"factor": 123,
"taxAllowanceAmount": "0.00",
"additionalTaxableAmount": "0.00",
"validFrom": "2023-12-25",
"validTo": "2023-12-25",
"churchMember": false,
"churchTaxState": "Baden-Württemberg"
},
"employmentCountry": "DE",
"externalRef": "<string>",
"startDate": "2023-12-25",
"endDate": "2023-12-25",
"birthPlace": "<string>",
"birthCountry": "<string>",
"personalEmail": "jsmith@example.com",
"workEmail": "jsmith@example.com",
"phoneNumbers": [
{
"phoneNumber": "<string>",
"phoneType": "mobile",
"isPrimary": false
}
],
"previousEmployeeId": "<string>",
"nextEmployeeId": "<string>"
},
"bankAccounts": [
{
"financialInstitutionName": "<string>",
"id": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"accountNumber": "DE: DE89370400440532013000",
"routingNumber": "DE: 370400440",
"iban": "DE: DE89370400440532013000",
"swiftCode": "DE: COBADEFFXXX",
"isActive": true,
"isPrimary": false
}
]
}
],
"meta": {
"total": 123,
"page": 123,
"size": 123,
"pages": 123,
"has_next": true,
"has_prev": true
}
}List employees for an organization with pagination and filtering support.
curl --request GET \
--url https://api.example.com/organizations/{organization_id}/employees \
--header 'Authorization: Bearer <token>'{
"items": [
{
"id": "<string>",
"organizationId": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"employeeData": {
"birthDate": "2023-12-25",
"personalData": {
"id": 123,
"employeeId": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"employeeName": {
"familyName": "<string>",
"givenName": "<string>",
"familyNamePrefix": "<string>",
"givenNameSuffix": "<string>",
"birthName": "<string>",
"birthFamilyNamePrefix": "<string>",
"birthGivenNameSuffix": "<string>",
"title": "<string>"
},
"employmentCountry": "DE",
"gender": "M",
"maritalStatus": "Single",
"nationality": "<string>",
"residenceAddress": "<string>",
"statusIndicator": "managing_partner_gmbh_ug",
"validFrom": "2023-12-25",
"validTo": "2023-12-25"
},
"relatedPersons": {
"id": 123,
"employeeId": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"persons": [
{}
],
"employmentCountry": "DE",
"validFrom": "2023-12-25",
"validTo": "2023-12-25"
},
"jobDetails": {
"id": 123,
"employeeId": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"employmentCountry": "DE",
"jobType": "Full Time Indefinite Term",
"employmentStatus": "Employee",
"isSeasonalWorker": true,
"jobTitle": "<string>",
"jobDescription": "<string>",
"schoolEducation": "Ohne Schulabschluss",
"professionalEducation": "Ohne beruflichen Ausbildungsabschluss",
"occupationCode": "<string>",
"contractedWeeklyHours": 40,
"contractedWeekdays": [
"Monday"
],
"contractedToOtherCompany": false,
"worksiteId": "<string>",
"department": "<string>",
"otherJobs": [
{
"employmentCountry": "DE",
"employerName": "<string>",
"employmentStartDate": "2023-12-25",
"monthlyGrossIncome": "<string>"
}
],
"validFrom": "2023-12-25",
"validTo": "2023-12-25"
},
"insuranceDetails": {
"id": 123,
"employeeId": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"employmentCountry": "DE",
"insuranceNumber": "<string>",
"contributionGroup": "<string>",
"personGroup": 101,
"insuranceProvider": "<string>",
"alternateCollectionAgency": "<string>",
"privateInsuranceHealthMonthly": "0",
"privateInsuranceCareMonthly": "0",
"careInsuranceChildren": 0,
"u1Exempt": false,
"u2Exempt": false,
"uvRiskTariff": [
{
"tariffCode": "<string>",
"tariffDescription": "<string>",
"tariffPercentage": "0"
}
],
"pensionDetails": {
"employmentCountry": "DE",
"receivedMiningAdjustmentPayments": false,
"pensionType": "full_old_age_pension_eu_eea_sva",
"pensionStartDate": "2023-12-25",
"waiverDeclarationStatus": "default",
"waiverReceiptDate": "2023-12-25",
"waiverValidityDate": "2023-12-25"
},
"validFrom": "2023-12-25",
"validTo": "2023-12-25"
},
"taxDetails": {
"id": 123,
"employeeId": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"taxId": "<string>",
"taxClass": "1",
"employmentCountry": "DE",
"childAllowances": "0.0",
"churchConfession": "AK",
"churchConfessionPartner": "AK",
"factorProcedure": false,
"factor": 123,
"taxAllowanceAmount": "0.00",
"additionalTaxableAmount": "0.00",
"validFrom": "2023-12-25",
"validTo": "2023-12-25",
"churchMember": false,
"churchTaxState": "Baden-Württemberg"
},
"employmentCountry": "DE",
"externalRef": "<string>",
"startDate": "2023-12-25",
"endDate": "2023-12-25",
"birthPlace": "<string>",
"birthCountry": "<string>",
"personalEmail": "jsmith@example.com",
"workEmail": "jsmith@example.com",
"phoneNumbers": [
{
"phoneNumber": "<string>",
"phoneType": "mobile",
"isPrimary": false
}
],
"previousEmployeeId": "<string>",
"nextEmployeeId": "<string>"
},
"bankAccounts": [
{
"financialInstitutionName": "<string>",
"id": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"accountNumber": "DE: DE89370400440532013000",
"routingNumber": "DE: 370400440",
"iban": "DE: DE89370400440532013000",
"swiftCode": "DE: COBADEFFXXX",
"isActive": true,
"isPrimary": false
}
]
}
],
"meta": {
"total": 123,
"page": 123,
"size": 123,
"pages": 123,
"has_next": true,
"has_prev": true
}
}Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Filter by employment country Enum for CountryAlpha2 codes
DE, IE, GB, US, GB x >= 11 <= x <= 100asc, desc