Employments

List all employments viewable for API user

get

Authorizations

Query parameters

pageTokenstringOptional

limitinteger · int32Optional

sinceDeltaTokenstringOptional

fieldsstring[]Optional

Responses

200

Successful request

application/json

get

HTTPcURLJavaScriptPython

GET /employments HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Successful request

{
  "results": [
    {
      "externalCode": "text",
      "remark": "text",
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "employeeNumber": "text",
      "externalId": "text",
      "firstName": "text",
      "customValues": {},
      "employmentContracts": [
        {
          "id": "550e8400-e29b-41d4-a716-446655440000",
          "interval": {},
          "externalCode": "text",
          "createdAt": "text",
          "contractTypeID": "550e8400-e29b-41d4-a716-446655440000",
          "lastModifiedAt": "text",
          "externalId": "text",
          "employmentID": "550e8400-e29b-41d4-a716-446655440000"
        }
      ],
      "email": "text",
      "createdAt": "text",
      "surname": "text",
      "initials": "text",
      "relations": [
        {
          "fromEmploymentID": "550e8400-e29b-41d4-a716-446655440000",
          "lastModifiedAt": "text",
          "createdAt": "text",
          "interval": {},
          "id": "550e8400-e29b-41d4-a716-446655440000",
          "toEmploymentID": "550e8400-e29b-41d4-a716-446655440000"
        }
      ],
      "birthDate": "2025-07-12",
      "referringRelations": [
        {
          "fromEmploymentID": "550e8400-e29b-41d4-a716-446655440000",
          "lastModifiedAt": "text",
          "createdAt": "text",
          "interval": {},
          "id": "550e8400-e29b-41d4-a716-446655440000",
          "toEmploymentID": "550e8400-e29b-41d4-a716-446655440000"
        }
      ],
      "employmentUnavailabilities": [
        {
          "reason": "text",
          "lastModifiedAt": "text",
          "createdAt": "text",
          "interval": {},
          "id": "550e8400-e29b-41d4-a716-446655440000",
          "employmentID": "550e8400-e29b-41d4-a716-446655440000"
        }
      ],
      "positions": [
        {
          "id": "550e8400-e29b-41d4-a716-446655440000",
          "interval": {},
          "externalCode": "text",
          "createdAt": "text",
          "externalId": "text",
          "lastModifiedAt": "text",
          "employmentID": "550e8400-e29b-41d4-a716-446655440000",
          "tagIDs": [
            "550e8400-e29b-41d4-a716-446655440000"
          ]
        }
      ],
      "lastModifiedAt": "text"
    }
  ],
  "deltaToken": "text",
  "pageToken": "text"
}

get

Authorizations

Path parameters

idstring · hexadecimal-integerRequiredExample: 550e8400-e29b-41d4-a716-446655440000Pattern: ^[0-9a-fA-F]{8}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{12}$

Responses

200

Successful request

application/json

get

HTTPcURLJavaScriptPython

GET /employments/{id} HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Successful request

{
  "externalCode": "text",
  "remark": "text",
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "employeeNumber": "text",
  "externalId": "text",
  "firstName": "text",
  "customValues": {},
  "employmentContracts": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "interval": {},
      "externalCode": "text",
      "createdAt": "text",
      "contractTypeID": "550e8400-e29b-41d4-a716-446655440000",
      "lastModifiedAt": "text",
      "externalId": "text",
      "employmentID": "550e8400-e29b-41d4-a716-446655440000"
    }
  ],
  "email": "text",
  "createdAt": "text",
  "surname": "text",
  "initials": "text",
  "relations": [
    {
      "fromEmploymentID": "550e8400-e29b-41d4-a716-446655440000",
      "lastModifiedAt": "text",
      "createdAt": "text",
      "interval": {},
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "toEmploymentID": "550e8400-e29b-41d4-a716-446655440000"
    }
  ],
  "birthDate": "2025-07-12",
  "referringRelations": [
    {
      "fromEmploymentID": "550e8400-e29b-41d4-a716-446655440000",
      "lastModifiedAt": "text",
      "createdAt": "text",
      "interval": {},
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "toEmploymentID": "550e8400-e29b-41d4-a716-446655440000"
    }
  ],
  "employmentUnavailabilities": [
    {
      "reason": "text",
      "lastModifiedAt": "text",
      "createdAt": "text",
      "interval": {},
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "employmentID": "550e8400-e29b-41d4-a716-446655440000"
    }
  ],
  "positions": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "interval": {},
      "externalCode": "text",
      "createdAt": "text",
      "externalId": "text",
      "lastModifiedAt": "text",
      "employmentID": "550e8400-e29b-41d4-a716-446655440000",
      "tagIDs": [
        "550e8400-e29b-41d4-a716-446655440000"
      ]
    }
  ],
  "lastModifiedAt": "text"
}