AG5.comSupportRequest a demo

Employees

Operations for Employees

List employees

get

List employees

Authorizations
Query parameters
limitinteger · min: 1 · max: 1000Optional

Maximum number of items to return (1-1000)

Default: 10
cursorstringOptional

Cursor for pagination. Use the value from the 'nextCursor' field of the previous response.

Responses
200

Successful response

application/json
get
/employees
GET /employees HTTP/1.1
Host: 
X-API-Key: YOUR_API_KEY
Accept: */*

{
  "data": [
    {
      "birthDate": "2025-11-03",
      "createdAt": "2025-11-03T12:50:11.006Z",
      "customValues": {
        "department": "Engineering",
        "employeeId": "EMP-12345",
        "location": "Amsterdam"
      },
      "email": "[email protected]",
      "employeeNumber": "text",
      "firstName": "text",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "initials": "text",
      "lastModifiedAt": "2025-11-03T12:50:11.006Z",
      "remark": "text",
      "repositoryID": "123e4567-e89b-12d3-a456-426614174000",
      "surname": "text"
    }
  ],
  "pagination": {
    "hasMore": true,
    "limit": 1,
    "nextCursor": "text",
    "total": 1
  }
}

Get Employee

get

Get a single Employee by ID

Authorizations
Path parameters
idstringRequired

Employee ID

Responses
200

Successful response

application/json
get
/employees/{id}
GET /employees/{id} HTTP/1.1
Host: 
X-API-Key: YOUR_API_KEY
Accept: */*

{
  "birthDate": "2025-11-03",
  "createdAt": "2025-11-03T12:50:11.006Z",
  "customValues": {
    "department": "Engineering",
    "employeeId": "EMP-12345",
    "location": "Amsterdam"
  },
  "email": "[email protected]",
  "employeeNumber": "text",
  "firstName": "text",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "initials": "text",
  "lastModifiedAt": "2025-11-03T12:50:11.006Z",
  "remark": "text",
  "repositoryID": "123e4567-e89b-12d3-a456-426614174000",
  "surname": "text"
}

Upload document for Employee

post

Upload a binary document that will be attached to the specified resource via a proposal.

Authorizations
Path parameters
idstringRequired

Employee ID

Body
filestring · binaryRequired
Responses
202

Upload accepted

No content
post
/employees/{id}/uploadDocument
POST /employees/{id}/uploadDocument HTTP/1.1
Host: 
X-API-Key: YOUR_API_KEY
Content-Type: multipart/form-data
Accept: */*
Content-Length: 17

{
  "file": "binary"
}
No content

List documents for Employee

get

List documents for the Employee resource

Authorizations
Path parameters
idstringRequired

Employee ID

Responses
200

Successful response

application/json
get
/employees/{id}/documents
GET /employees/{id}/documents HTTP/1.1
Host: 
X-API-Key: YOUR_API_KEY
Accept: */*

[
  {
    "contentType": "text",
    "downloadUrl": "text",
    "filename": "text",
    "size": 1
  }
]

List Employee creation proposals

get

List all createEmployees proposals. These are proposed changes to create new Employee records that may be automatically approved or require manual approval depending on system configuration.

Authorizations
Query parameters
limitinteger · min: 1 · max: 1000Optional

Maximum number of items to return (1-1000)

Default: 10
cursorstringOptional

Cursor for pagination. Use the value from the 'nextCursor' field of the previous response.

Responses
200

Successful response

application/json
get
/createEmployees
GET /createEmployees HTTP/1.1
Host: 
X-API-Key: YOUR_API_KEY
Accept: */*

{
  "data": [
    {
      "birthDate": "2025-11-03",
      "customValues": {
        "department": "Engineering",
        "employeeId": "EMP-12345",
        "location": "Amsterdam"
      },
      "email": "[email protected]",
      "employeeNumber": "text",
      "firstName": "text",
      "initials": "text",
      "isProposalExecutionFailed": true,
      "isProposalResolved": false,
      "proposalExecutionErrorText": "text",
      "remark": "text",
      "repositoryID": "123e4567-e89b-12d3-a456-426614174000",
      "requestID": "123e4567-e89b-12d3-a456-426614174000",
      "subjectID": "123e4567-e89b-12d3-a456-426614174000",
      "surname": "text"
    }
  ],
  "pagination": {
    "hasMore": true,
    "limit": 1,
    "nextCursor": "text",
    "total": 1
  }
}

Propose creation of Employees

post

Create new proposals to add Employee records. The proposals may be automatically approved or require manual approval depending on system configuration. You can submit multiple proposals in a single request.

Authorizations
Bodyobject[]
birthDatestring · dateOptional
emailstring · emailOptional
employeeNumberstringOptional
firstNamestringOptional
initialsstringOptional
remarkstringOptional
repositoryIDstring · uuidRequired
surnamestringRequired
Responses
201

Created successfully

application/json
post
/createEmployees
POST /createEmployees HTTP/1.1
Host: 
X-API-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 293

[
  {
    "birthDate": "2025-11-03",
    "customValues": {
      "department": "Engineering",
      "employeeId": "EMP-12345",
      "location": "Amsterdam"
    },
    "email": "[email protected]",
    "employeeNumber": "text",
    "firstName": "text",
    "initials": "text",
    "remark": "text",
    "repositoryID": "123e4567-e89b-12d3-a456-426614174000",
    "surname": "text"
  }
]
[
  {
    "birthDate": "2025-11-03",
    "customValues": {
      "department": "Engineering",
      "employeeId": "EMP-12345",
      "location": "Amsterdam"
    },
    "email": "[email protected]",
    "employeeNumber": "text",
    "firstName": "text",
    "initials": "text",
    "isProposalExecutionFailed": true,
    "isProposalResolved": false,
    "proposalExecutionErrorText": "text",
    "remark": "text",
    "repositoryID": "123e4567-e89b-12d3-a456-426614174000",
    "requestID": "123e4567-e89b-12d3-a456-426614174000",
    "subjectID": "123e4567-e89b-12d3-a456-426614174000",
    "surname": "text"
  }
]

Get Employee creation proposal

get

Get details of a specific Employee creation proposal by ID

Authorizations
Path parameters
idstringRequired

CreateEmployeeProposal ID

Responses
200

Successful response

application/json
get
/createEmployees/{id}
GET /createEmployees/{id} HTTP/1.1
Host: 
X-API-Key: YOUR_API_KEY
Accept: */*

{
  "birthDate": "2025-11-03",
  "customValues": {
    "department": "Engineering",
    "employeeId": "EMP-12345",
    "location": "Amsterdam"
  },
  "email": "[email protected]",
  "employeeNumber": "text",
  "firstName": "text",
  "initials": "text",
  "isProposalExecutionFailed": true,
  "isProposalResolved": false,
  "proposalExecutionErrorText": "text",
  "remark": "text",
  "repositoryID": "123e4567-e89b-12d3-a456-426614174000",
  "requestID": "123e4567-e89b-12d3-a456-426614174000",
  "subjectID": "123e4567-e89b-12d3-a456-426614174000",
  "surname": "text"
}

List Employee deletion proposals

get

List all deleteEmployees proposals. These are proposed changes to delete Employee records that may be automatically approved or require manual approval depending on system configuration.

Authorizations
Query parameters
limitinteger · min: 1 · max: 1000Optional

Maximum number of items to return (1-1000)

Default: 10
cursorstringOptional

Cursor for pagination. Use the value from the 'nextCursor' field of the previous response.

Responses
200

Successful response

application/json
get
/deleteEmployees
GET /deleteEmployees HTTP/1.1
Host: 
X-API-Key: YOUR_API_KEY
Accept: */*

{
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "isProposalExecutionFailed": true,
      "isProposalResolved": false,
      "proposalExecutionErrorText": "text",
      "repositoryID": "123e4567-e89b-12d3-a456-426614174000",
      "requestID": "123e4567-e89b-12d3-a456-426614174000"
    }
  ],
  "pagination": {
    "hasMore": true,
    "limit": 1,
    "nextCursor": "text",
    "total": 1
  }
}

Propose deletion of Employees

post

Create new proposals to delete Employee records. The proposals may be automatically approved or require manual approval depending on system configuration. You can submit multiple proposals in a single request.

Authorizations
Bodyobject[]
idstring · uuidRequired
repositoryIDstring · uuidRequired
Responses
201

Created successfully

application/json
post
/deleteEmployees
POST /deleteEmployees HTTP/1.1
Host: 
X-API-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 101

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "repositoryID": "123e4567-e89b-12d3-a456-426614174000"
  }
]
[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "isProposalExecutionFailed": true,
    "isProposalResolved": false,
    "proposalExecutionErrorText": "text",
    "repositoryID": "123e4567-e89b-12d3-a456-426614174000",
    "requestID": "123e4567-e89b-12d3-a456-426614174000"
  }
]

Get Employee deletion proposal

get

Get details of a specific Employee deletion proposal by ID

Authorizations
Path parameters
idstringRequired

DeleteEmployeeProposal ID

Responses
200

Successful response

application/json
get
/deleteEmployees/{id}
GET /deleteEmployees/{id} HTTP/1.1
Host: 
X-API-Key: YOUR_API_KEY
Accept: */*

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "isProposalExecutionFailed": true,
  "isProposalResolved": false,
  "proposalExecutionErrorText": "text",
  "repositoryID": "123e4567-e89b-12d3-a456-426614174000",
  "requestID": "123e4567-e89b-12d3-a456-426614174000"
}

List Employee update proposals

get

List all updateEmployees proposals. These are proposed changes to update existing Employee records that may be automatically approved or require manual approval depending on system configuration.

Authorizations
Query parameters
limitinteger · min: 1 · max: 1000Optional

Maximum number of items to return (1-1000)

Default: 10
cursorstringOptional

Cursor for pagination. Use the value from the 'nextCursor' field of the previous response.

Responses
200

Successful response

application/json
get
/updateEmployees
GET /updateEmployees HTTP/1.1
Host: 
X-API-Key: YOUR_API_KEY
Accept: */*

{
  "data": [
    {
      "birthDate": "2025-11-03",
      "customValues": {
        "department": "Engineering",
        "employeeId": "EMP-12345",
        "location": "Amsterdam"
      },
      "email": "[email protected]",
      "employeeNumber": "text",
      "firstName": "text",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "initials": "text",
      "isProposalExecutionFailed": true,
      "isProposalResolved": false,
      "proposalExecutionErrorText": "text",
      "remark": "text",
      "repositoryID": "123e4567-e89b-12d3-a456-426614174000",
      "requestID": "123e4567-e89b-12d3-a456-426614174000",
      "surname": "text"
    }
  ],
  "pagination": {
    "hasMore": true,
    "limit": 1,
    "nextCursor": "text",
    "total": 1
  }
}

Propose update of Employees

post

Create new proposals to update Employee records. All fields are optional - omitted fields will not be changed. Only include fields you want to update. Setting a field to null will clear its value (where applicable). The proposals may be automatically approved or require manual approval depending on system configuration. You can submit multiple proposals in a single request.

Authorizations
Bodyobject[]
birthDatestring · dateOptional

Omit this field to keep current value

emailstring · emailOptional

Omit this field to keep current value

employeeNumberstringOptional

Omit this field to keep current value

firstNamestringOptional

Omit this field to keep current value

idstring · uuidRequired
initialsstringOptional

Omit this field to keep current value

remarkstringOptional

Omit this field to keep current value

repositoryIDstring · uuidRequired
surnamestringOptional

Omit this field to keep current value

Responses
201

Created successfully

application/json
post
/updateEmployees
POST /updateEmployees HTTP/1.1
Host: 
X-API-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 337

[
  {
    "birthDate": "2025-11-03",
    "customValues": {
      "department": "Engineering",
      "employeeId": "EMP-12345",
      "location": "Amsterdam"
    },
    "email": "[email protected]",
    "employeeNumber": "text",
    "firstName": "text",
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "initials": "text",
    "remark": "text",
    "repositoryID": "123e4567-e89b-12d3-a456-426614174000",
    "surname": "text"
  }
]
[
  {
    "birthDate": "2025-11-03",
    "customValues": {
      "department": "Engineering",
      "employeeId": "EMP-12345",
      "location": "Amsterdam"
    },
    "email": "[email protected]",
    "employeeNumber": "text",
    "firstName": "text",
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "initials": "text",
    "isProposalExecutionFailed": true,
    "isProposalResolved": false,
    "proposalExecutionErrorText": "text",
    "remark": "text",
    "repositoryID": "123e4567-e89b-12d3-a456-426614174000",
    "requestID": "123e4567-e89b-12d3-a456-426614174000",
    "surname": "text"
  }
]

Get Employee update proposal

get

Get details of a specific Employee update proposal by ID

Authorizations
Path parameters
idstringRequired

UpdateEmployeeProposal ID

Responses
200

Successful response

application/json
get
/updateEmployees/{id}
GET /updateEmployees/{id} HTTP/1.1
Host: 
X-API-Key: YOUR_API_KEY
Accept: */*

{
  "birthDate": "2025-11-03",
  "customValues": {
    "department": "Engineering",
    "employeeId": "EMP-12345",
    "location": "Amsterdam"
  },
  "email": "[email protected]",
  "employeeNumber": "text",
  "firstName": "text",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "initials": "text",
  "isProposalExecutionFailed": true,
  "isProposalResolved": false,
  "proposalExecutionErrorText": "text",
  "remark": "text",
  "repositoryID": "123e4567-e89b-12d3-a456-426614174000",
  "requestID": "123e4567-e89b-12d3-a456-426614174000",
  "surname": "text"
}
PreviousEmployeeUnavailabilitiesNextEmploymentContractTypes

Last updated

Was this helpful?