EmploymentContracts

List employmentContracts

get

List employmentContracts

Filter Syntax:

Filters use exact match only
Multiple filters are combined with AND logic
Filterable fields: contractTypeID, employeeID
Example: ?contractTypeID=123e4567-e89b-12d3-a456-426614174000&employeeID=123e4567-e89b-12d3-a456-426614174000

Authorizations

Path parameters

orgkeepIDstringRequired

Organization identifier

Query parameters

contractTypeIDstringOptional

Filter by contractTypeID (exact match)

employeeIDstringOptional

Filter by employeeID (exact match)

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

400

Bad request

application/json

401

Unauthorized

application/json

500

Internal server error

application/json

get

GET /api/orgkeep/v4/{orgkeepID}/employmentContracts HTTP/1.1
Host: matrix.ag5.com
X-API-Key: YOUR_API_KEY
Accept: */*

{
  "data": [
    {
      "activePeriod": "[2023-01-01,2023-12-31)",
      "contractTypeID": "123e4567-e89b-12d3-a456-426614174000",
      "createdAt": "2025-07-18T20:01:45.684Z",
      "employeeID": "123e4567-e89b-12d3-a456-426614174000",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "lastModifiedAt": "2025-07-18T20:01:45.684Z",
      "repositoryID": "123e4567-e89b-12d3-a456-426614174000"
    }
  ],
  "pagination": {
    "hasMore": true,
    "limit": 1,
    "nextCursor": "text",
    "total": 1
  }
}

Get EmploymentContract

get

Get a single employmentContract by ID

Authorizations

Path parameters

orgkeepIDstringRequired

Organization identifier

idstringRequired

EmploymentContract ID

Responses

200

Successful response

application/json

401

Unauthorized

application/json

404

Not found

application/json

500

Internal server error

application/json

get

GET /api/orgkeep/v4/{orgkeepID}/employmentContracts/{id} HTTP/1.1
Host: matrix.ag5.com
X-API-Key: YOUR_API_KEY
Accept: */*

{
  "activePeriod": "[2023-01-01,2023-12-31)",
  "contractTypeID": "123e4567-e89b-12d3-a456-426614174000",
  "createdAt": "2025-07-18T20:01:45.684Z",
  "employeeID": "123e4567-e89b-12d3-a456-426614174000",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "lastModifiedAt": "2025-07-18T20:01:45.684Z",
  "repositoryID": "123e4567-e89b-12d3-a456-426614174000"
}

List EmploymentContract creation proposals

get

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

Filter Syntax:

Filters use exact match only
Multiple filters are combined with AND logic
Filterable fields: contractTypeID, employeeID
Example: ?contractTypeID=123e4567-e89b-12d3-a456-426614174000&employeeID=123e4567-e89b-12d3-a456-426614174000

Authorizations

Path parameters

orgkeepIDstringRequired

Organization identifier

Query parameters

contractTypeIDstringOptional

Filter by contractTypeID (exact match)

employeeIDstringOptional

Filter by employeeID (exact match)

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

400

Bad request

application/json

401

Unauthorized

application/json

500

Internal server error

application/json

get

GET /api/orgkeep/v4/{orgkeepID}/createEmploymentContracts HTTP/1.1
Host: matrix.ag5.com
X-API-Key: YOUR_API_KEY
Accept: */*

{
  "data": [
    {
      "activePeriod": "[2023-01-01,2023-12-31)",
      "contractTypeID": "123e4567-e89b-12d3-a456-426614174000",
      "employeeID": "123e4567-e89b-12d3-a456-426614174000",
      "isProposalExecutionFailed": true,
      "isProposalResolved": true,
      "proposalExecutionErrorText": "text",
      "repositoryID": "123e4567-e89b-12d3-a456-426614174000",
      "requestID": "123e4567-e89b-12d3-a456-426614174000",
      "subjectID": "123e4567-e89b-12d3-a456-426614174000"
    }
  ],
  "pagination": {
    "hasMore": true,
    "limit": 1,
    "nextCursor": "text",
    "total": 1
  }
}

Propose creation of EmploymentContract

post

Create a new proposal to add a EmploymentContract record. The proposal may be automatically approved or require manual approval depending on system configuration.

Authorizations

Path parameters

orgkeepIDstringRequired

Organization identifier

Body

activePeriodstringRequired

Date range in PostgreSQL format [start,end)

Example: [2023-01-01,2023-12-31)

contractTypeIDstring · uuidOptional

employeeIDstring · uuidRequired

repositoryIDstring · uuidRequired

Responses

201

Created successfully

application/json

400

Bad request

application/json

401

Unauthorized

application/json

500

Internal server error

application/json

post

POST /api/orgkeep/v4/{orgkeepID}/createEmploymentContracts HTTP/1.1
Host: matrix.ag5.com
X-API-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 204

{
  "activePeriod": "[2023-01-01,2023-12-31)",
  "contractTypeID": "123e4567-e89b-12d3-a456-426614174000",
  "employeeID": "123e4567-e89b-12d3-a456-426614174000",
  "repositoryID": "123e4567-e89b-12d3-a456-426614174000"
}

{
  "activePeriod": "[2023-01-01,2023-12-31)",
  "contractTypeID": "123e4567-e89b-12d3-a456-426614174000",
  "employeeID": "123e4567-e89b-12d3-a456-426614174000",
  "isProposalExecutionFailed": true,
  "isProposalResolved": true,
  "proposalExecutionErrorText": "text",
  "repositoryID": "123e4567-e89b-12d3-a456-426614174000",
  "requestID": "123e4567-e89b-12d3-a456-426614174000",
  "subjectID": "123e4567-e89b-12d3-a456-426614174000"
}

Get EmploymentContract creation proposal

get

Get details of a specific EmploymentContract creation proposal by ID

Authorizations

Path parameters

orgkeepIDstringRequired

Organization identifier

idstringRequired

CreateEmploymentContract ID

Responses

200

Successful response

application/json

401

Unauthorized

application/json

404

Not found

application/json

500

Internal server error

application/json

get

GET /api/orgkeep/v4/{orgkeepID}/createEmploymentContracts/{id} HTTP/1.1
Host: matrix.ag5.com
X-API-Key: YOUR_API_KEY
Accept: */*

{
  "activePeriod": "[2023-01-01,2023-12-31)",
  "contractTypeID": "123e4567-e89b-12d3-a456-426614174000",
  "employeeID": "123e4567-e89b-12d3-a456-426614174000",
  "isProposalExecutionFailed": true,
  "isProposalResolved": true,
  "proposalExecutionErrorText": "text",
  "repositoryID": "123e4567-e89b-12d3-a456-426614174000",
  "requestID": "123e4567-e89b-12d3-a456-426614174000",
  "subjectID": "123e4567-e89b-12d3-a456-426614174000"
}

List EmploymentContract deletion proposals

get

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

Authorizations

Path parameters

orgkeepIDstringRequired

Organization identifier

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

400

Bad request

application/json

401

Unauthorized

application/json

500

Internal server error

application/json

get

GET /api/orgkeep/v4/{orgkeepID}/deleteEmploymentContracts HTTP/1.1
Host: matrix.ag5.com
X-API-Key: YOUR_API_KEY
Accept: */*

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

Propose creation of EmploymentContract

post

Create a new proposal to add a EmploymentContract record. The proposal may be automatically approved or require manual approval depending on system configuration.

Authorizations

Path parameters

orgkeepIDstringRequired

Organization identifier

Body

idstring · uuidRequired

repositoryIDstring · uuidRequired

Responses

201

Created successfully

application/json

400

Bad request

application/json

401

Unauthorized

application/json

500

Internal server error

application/json

post

POST /api/orgkeep/v4/{orgkeepID}/deleteEmploymentContracts HTTP/1.1
Host: matrix.ag5.com
X-API-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 99

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "repositoryID": "123e4567-e89b-12d3-a456-426614174000"
}

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

Get EmploymentContract deletion proposal

get

Get details of a specific EmploymentContract deletion proposal by ID

Authorizations

Path parameters

orgkeepIDstringRequired

Organization identifier

idstringRequired

DeleteEmploymentContract ID

Responses

200

Successful response

application/json

401

Unauthorized

application/json

404

Not found

application/json

500

Internal server error

application/json

get

GET /api/orgkeep/v4/{orgkeepID}/deleteEmploymentContracts/{id} HTTP/1.1
Host: matrix.ag5.com
X-API-Key: YOUR_API_KEY
Accept: */*

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

List EmploymentContract update proposals

get

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

Filter Syntax:

Filters use exact match only
Multiple filters are combined with AND logic
Filterable fields: contractTypeID, employeeID
Example: ?contractTypeID=123e4567-e89b-12d3-a456-426614174000&employeeID=123e4567-e89b-12d3-a456-426614174000

Authorizations

Path parameters

orgkeepIDstringRequired

Organization identifier

Query parameters

contractTypeIDstringOptional

Filter by contractTypeID (exact match)

employeeIDstringOptional

Filter by employeeID (exact match)

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

400

Bad request

application/json

401

Unauthorized

application/json

500

Internal server error

application/json

get

GET /api/orgkeep/v4/{orgkeepID}/updateEmploymentContracts HTTP/1.1
Host: matrix.ag5.com
X-API-Key: YOUR_API_KEY
Accept: */*

{
  "data": [
    {
      "activePeriod": "[2023-01-01,2023-12-31)",
      "contractTypeID": "123e4567-e89b-12d3-a456-426614174000",
      "employeeID": "123e4567-e89b-12d3-a456-426614174000",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "isProposalExecutionFailed": true,
      "isProposalResolved": true,
      "proposalExecutionErrorText": "text",
      "repositoryID": "123e4567-e89b-12d3-a456-426614174000",
      "requestID": "123e4567-e89b-12d3-a456-426614174000"
    }
  ],
  "pagination": {
    "hasMore": true,
    "limit": 1,
    "nextCursor": "text",
    "total": 1
  }
}

Propose creation of EmploymentContract

post

Create a new proposal to add a EmploymentContract record. The proposal may be automatically approved or require manual approval depending on system configuration.

Authorizations

Path parameters

orgkeepIDstringRequired

Organization identifier

Body

activePeriodstringRequired

Date range in PostgreSQL format [start,end)

Example: [2023-01-01,2023-12-31)

contractTypeIDstring · uuidOptional

employeeIDstring · uuidRequired

idstring · uuidRequired

repositoryIDstring · uuidRequired

Responses

201

Created successfully

application/json

400

Bad request

application/json

401

Unauthorized

application/json

500

Internal server error

application/json

post

POST /api/orgkeep/v4/{orgkeepID}/updateEmploymentContracts HTTP/1.1
Host: matrix.ag5.com
X-API-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 248

{
  "activePeriod": "[2023-01-01,2023-12-31)",
  "contractTypeID": "123e4567-e89b-12d3-a456-426614174000",
  "employeeID": "123e4567-e89b-12d3-a456-426614174000",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "repositoryID": "123e4567-e89b-12d3-a456-426614174000"
}

{
  "activePeriod": "[2023-01-01,2023-12-31)",
  "contractTypeID": "123e4567-e89b-12d3-a456-426614174000",
  "employeeID": "123e4567-e89b-12d3-a456-426614174000",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "isProposalExecutionFailed": true,
  "isProposalResolved": true,
  "proposalExecutionErrorText": "text",
  "repositoryID": "123e4567-e89b-12d3-a456-426614174000",
  "requestID": "123e4567-e89b-12d3-a456-426614174000"
}

Get EmploymentContract update proposal

get

Get details of a specific EmploymentContract update proposal by ID

Authorizations

Path parameters

orgkeepIDstringRequired

Organization identifier

idstringRequired

UpdateEmploymentContract ID

Responses

200

Successful response

application/json

401

Unauthorized

application/json

404

Not found

application/json

500

Internal server error

application/json

get

GET /api/orgkeep/v4/{orgkeepID}/updateEmploymentContracts/{id} HTTP/1.1
Host: matrix.ag5.com
X-API-Key: YOUR_API_KEY
Accept: */*

{
  "activePeriod": "[2023-01-01,2023-12-31)",
  "contractTypeID": "123e4567-e89b-12d3-a456-426614174000",
  "employeeID": "123e4567-e89b-12d3-a456-426614174000",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "isProposalExecutionFailed": true,
  "isProposalResolved": true,
  "proposalExecutionErrorText": "text",
  "repositoryID": "123e4567-e89b-12d3-a456-426614174000",
  "requestID": "123e4567-e89b-12d3-a456-426614174000"
}