Employments | AG5.com

AG5.com Support Request a demo

List all employments viewable for API user

get

/employments

Authorizations

Query parameters

pageTokenstring

limitinteger · int32

sinceDeltaTokenstring

fieldsstring[]

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/employments' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

{
  "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-03-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"
}

Successful request

get

/employments/{id}

Authorizations

Path parameters

idstring · hexadecimal-integerrequired

Example: 550e8400-e29b-41d4-a716-446655440000

Pattern: ^[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}$