AG5.comSupportRequest a demo

EmployeeUnavailabilities

Operations for EmployeeUnavailabilities

List employeeUnavailabilities

get

List employeeUnavailabilities

Filter Syntax:

  • Filters use exact match only

  • Multiple filters are combined with AND logic

  • Filterable fields: employeeID

  • Example: ?employeeID=123e4567-e89b-12d3-a456-426614174000

Authorizations
Path parameters
orgkeepIDstringRequired

Organization identifier

Query parameters
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
get
GET /api/orgkeep/v4/{orgkeepID}/employeeUnavailabilities HTTP/1.1
Host: matrix.ag5.com
X-API-Key: YOUR_API_KEY
Accept: */*

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

Get EmployeeUnavailability

get

Get a single employeeUnavailability by ID

Authorizations
Path parameters
orgkeepIDstringRequired

Organization identifier

idstringRequired

EmployeeUnavailability ID

Responses
200
Successful response
application/json
get
GET /api/orgkeep/v4/{orgkeepID}/employeeUnavailabilities/{id} HTTP/1.1
Host: matrix.ag5.com
X-API-Key: YOUR_API_KEY
Accept: */*

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

List EmployeeUnavailability creation proposals

get

List all createEmployeeUnavailabilities proposals. These are proposed changes to create new EmployeeUnavailability 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: employeeID

  • Example: ?employeeID=123e4567-e89b-12d3-a456-426614174000

Authorizations
Path parameters
orgkeepIDstringRequired

Organization identifier

Query parameters
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
get
GET /api/orgkeep/v4/{orgkeepID}/createEmployeeUnavailabilities HTTP/1.1
Host: matrix.ag5.com
X-API-Key: YOUR_API_KEY
Accept: */*

{
  "data": [
    {
      "activePeriod": "[2023-01-01,2023-12-31)",
      "employeeID": "123e4567-e89b-12d3-a456-426614174000",
      "isProposalExecutionFailed": true,
      "isProposalResolved": true,
      "proposalExecutionErrorText": "text",
      "reason": "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 EmployeeUnavailability

post

Create a new proposal to add a EmployeeUnavailability 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)
employeeIDstring · uuidRequired
reasonstringOptional
repositoryIDstring · uuidRequired
Responses
201
Created successfully
application/json
post
POST /api/orgkeep/v4/{orgkeepID}/createEmployeeUnavailabilities HTTP/1.1
Host: matrix.ag5.com
X-API-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 164

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

Get EmployeeUnavailability creation proposal

get

Get details of a specific EmployeeUnavailability creation proposal by ID

Authorizations
Path parameters
orgkeepIDstringRequired

Organization identifier

idstringRequired

CreateEmployeeUnavailability ID

Responses
200
Successful response
application/json
get
GET /api/orgkeep/v4/{orgkeepID}/createEmployeeUnavailabilities/{id} HTTP/1.1
Host: matrix.ag5.com
X-API-Key: YOUR_API_KEY
Accept: */*

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

List EmployeeUnavailability deletion proposals

get

List all deleteEmployeeUnavailabilities proposals. These are proposed changes to delete EmployeeUnavailability 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
get
GET /api/orgkeep/v4/{orgkeepID}/deleteEmployeeUnavailabilities 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 EmployeeUnavailability

post

Create a new proposal to add a EmployeeUnavailability 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
post
POST /api/orgkeep/v4/{orgkeepID}/deleteEmployeeUnavailabilities 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 EmployeeUnavailability deletion proposal

get

Get details of a specific EmployeeUnavailability deletion proposal by ID

Authorizations
Path parameters
orgkeepIDstringRequired

Organization identifier

idstringRequired

DeleteEmployeeUnavailability ID

Responses
200
Successful response
application/json
get
GET /api/orgkeep/v4/{orgkeepID}/deleteEmployeeUnavailabilities/{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 EmployeeUnavailability update proposals

get

List all updateEmployeeUnavailabilities proposals. These are proposed changes to update existing EmployeeUnavailability 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: employeeID

  • Example: ?employeeID=123e4567-e89b-12d3-a456-426614174000

Authorizations
Path parameters
orgkeepIDstringRequired

Organization identifier

Query parameters
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
get
GET /api/orgkeep/v4/{orgkeepID}/updateEmployeeUnavailabilities HTTP/1.1
Host: matrix.ag5.com
X-API-Key: YOUR_API_KEY
Accept: */*

{
  "data": [
    {
      "activePeriod": "[2023-01-01,2023-12-31)",
      "employeeID": "123e4567-e89b-12d3-a456-426614174000",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "isProposalExecutionFailed": true,
      "isProposalResolved": true,
      "proposalExecutionErrorText": "text",
      "reason": "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 EmployeeUnavailability

post

Create a new proposal to add a EmployeeUnavailability 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)
employeeIDstring · uuidRequired
idstring · uuidRequired
reasonstringOptional
repositoryIDstring · uuidRequired
Responses
201
Created successfully
application/json
post
POST /api/orgkeep/v4/{orgkeepID}/updateEmployeeUnavailabilities HTTP/1.1
Host: matrix.ag5.com
X-API-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 208

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

Get EmployeeUnavailability update proposal

get

Get details of a specific EmployeeUnavailability update proposal by ID

Authorizations
Path parameters
orgkeepIDstringRequired

Organization identifier

idstringRequired

UpdateEmployeeUnavailability ID

Responses
200
Successful response
application/json
get
GET /api/orgkeep/v4/{orgkeepID}/updateEmployeeUnavailabilities/{id} HTTP/1.1
Host: matrix.ag5.com
X-API-Key: YOUR_API_KEY
Accept: */*

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

Was this helpful?