GET
/
organizations
/
{organization_id}
/
employees
List Employees
curl --request GET \
  --url https://sandbox.intermezzo.ai/organizations/{organization_id}/employees \
  --header 'Authorization: Bearer <token>'
{
  "items": [
    {
      "id": "emp_01h455vb4pex5vsknk084sn02q",
      "organizationId": "org_01h455vb4pex5vsknk084sn02q",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "employeeData": {
        "employmentCountry": "DE",
        "externalRef": "<string>",
        "startDate": "2023-12-25",
        "endDate": "2023-12-25",
        "birthDate": "2023-12-25",
        "birthPlace": "<string>",
        "birthCountry": "<string>",
        "personalEmail": "jsmith@example.com",
        "workEmail": "jsmith@example.com",
        "phoneNumbers": [
          {
            "phoneNumber": "<string>",
            "phoneType": "mobile",
            "isPrimary": true
          }
        ],
        "personalData": {
          "id": 123,
          "employeeId": "emp_01h455vb4pex5vsknk084sn02q",
          "createdAt": "2023-11-07T05:31:56Z",
          "updatedAt": "2023-11-07T05:31:56Z",
          "employmentCountry": "DE",
          "employeeName": {
            "familyName": "<string>",
            "givenName": "<string>",
            "familyNamePrefix": "<string>",
            "givenNameSuffix": "<string>",
            "birthName": "<string>",
            "birthFamilyNamePrefix": "<string>",
            "birthGivenNameSuffix": "<string>",
            "title": "<string>"
          },
          "gender": "M",
          "maritalStatus": "<string>",
          "nationality": "<string>",
          "residenceAddress": "<string>",
          "validFrom": "2023-12-25",
          "validTo": "2023-12-25"
        },
        "relatedPersons": {
          "id": 123,
          "employeeId": "emp_01h455vb4pex5vsknk084sn02q",
          "createdAt": "2023-11-07T05:31:56Z",
          "updatedAt": "2023-11-07T05:31:56Z",
          "employmentCountry": "DE",
          "dependentName": {
            "familyName": "<string>",
            "givenName": "<string>",
            "familyNamePrefix": "<string>",
            "givenNameSuffix": "<string>",
            "birthName": "<string>",
            "birthFamilyNamePrefix": "<string>",
            "birthGivenNameSuffix": "<string>",
            "title": "<string>"
          },
          "dependentBirthDate": "2023-12-25",
          "validFrom": "2023-12-25",
          "validTo": "2023-12-25"
        },
        "jobDetails": {
          "id": 123,
          "employeeId": "emp_01h455vb4pex5vsknk084sn02q",
          "createdAt": "2023-11-07T05:31:56Z",
          "updatedAt": "2023-11-07T05:31:56Z",
          "employmentCountry": "DE",
          "jobType": "Full Time Indefinite Term",
          "employmentStatus": "Employee",
          "jobTitle": "<string>",
          "jobDescription": "<string>",
          "occupationCode": "<string>",
          "contractedWeeklyHours": 123,
          "contractedToOtherCompany": false,
          "worksiteId": "wst_01h455vb4pex5vsknk084sn02q",
          "department": "<string>",
          "validFrom": "2023-12-25",
          "validTo": "2023-12-25"
        },
        "insuranceDetails": {
          "id": 123,
          "employeeId": "emp_01h455vb4pex5vsknk084sn02q",
          "createdAt": "2023-11-07T05:31:56Z",
          "updatedAt": "2023-11-07T05:31:56Z",
          "employmentCountry": "DE",
          "insuranceNumber": "<string>",
          "contributionGroup": "<string>",
          "personGroup": 123,
          "insuranceProvider": "<string>",
          "alternateCollectionAgency": "<string>",
          "privateInsuranceHealthMonthly": "<string>",
          "privateInsuranceCareMonthly": "<string>",
          "careInsuranceChildren": 123,
          "u1Exempt": true,
          "u2Exempt": true,
          "uvRiskTariff": [
            {
              "tariffCode": "<string>",
              "tariffDescription": "<string>",
              "tariffPercentage": "<string>"
            }
          ],
          "validFrom": "2023-12-25",
          "validTo": "2023-12-25"
        },
        "taxDetails": {
          "id": 123,
          "employeeId": "emp_01h455vb4pex5vsknk084sn02q",
          "createdAt": "2023-11-07T05:31:56Z",
          "updatedAt": "2023-11-07T05:31:56Z",
          "employmentCountry": "DE",
          "taxId": "<string>",
          "taxClass": "1",
          "childAllowances": "0.0",
          "churchConfession": "AK",
          "churchConfessionPartner": "AK",
          "factorProcedure": false,
          "factor": 123,
          "taxAllowanceAmount": "<string>",
          "additionalTaxableAmount": "<string>",
          "validFrom": "2023-12-25",
          "validTo": "2023-12-25",
          "churchMember": false,
          "churchTaxState": "Baden-Württemberg"
        }
      },
      "bankAccounts": [
        {
          "financialInstitutionName": "<string>",
          "accountNumber": "<string>",
          "routingNumber": "<string>",
          "iban": "<string>",
          "isActive": true,
          "isPrimary": false,
          "id": "ban_01h455vb4pex5vsknk084sn02q",
          "createdAt": "2023-11-07T05:31:56Z",
          "updatedAt": "2023-11-07T05:31:56Z"
        }
      ]
    }
  ],
  "meta": {
    "total": 123,
    "page": 123,
    "size": 123,
    "pages": 123,
    "has_next": true,
    "has_prev": true
  }
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

organization_id
string
required

TypeID with prefix 'org'

Example:

"org_01h455vb4pex5vsknk084sn02q"

Query Parameters

employment_country
string | null

Filter by employment country

page
integer
default:1
Required range: x >= 1
size
integer
default:10
Required range: 1 <= x <= 100
sort_by
string | null
sort_order
enum<string>
Available options:
asc,
desc

Response

Successful Response

The response is of type object.