EmployeeUnavailabilities
Operations for EmployeeUnavailabilities
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
Filter by employeeID (exact match)
Maximum number of items to return (1-1000)
10
Cursor for pagination. Use the value from the 'nextCursor' field of the previous response.
Successful response
Bad request
Unauthorized
Internal server error
GET /employeeUnavailabilities HTTP/1.1
Host:
X-API-Key: YOUR_API_KEY
Accept: */*
{
"data": [
{
"activePeriod": "[2023-01-01,2023-12-31)",
"createdAt": "2025-09-13T16:08:07.314Z",
"employeeID": "123e4567-e89b-12d3-a456-426614174000",
"id": "123e4567-e89b-12d3-a456-426614174000",
"lastModifiedAt": "2025-09-13T16:08:07.314Z",
"reason": "text",
"repositoryID": "123e4567-e89b-12d3-a456-426614174000"
}
],
"pagination": {
"count": 1,
"hasMore": true,
"limit": 1,
"nextCursor": "text",
"total": 1
}
}
Get a single EmployeeUnavailability by ID
EmployeeUnavailability ID
Successful response
Unauthorized
Not found
Internal server error
GET /employeeUnavailabilities/{id} HTTP/1.1
Host:
X-API-Key: YOUR_API_KEY
Accept: */*
{
"activePeriod": "[2023-01-01,2023-12-31)",
"createdAt": "2025-09-13T16:08:07.314Z",
"employeeID": "123e4567-e89b-12d3-a456-426614174000",
"id": "123e4567-e89b-12d3-a456-426614174000",
"lastModifiedAt": "2025-09-13T16:08:07.314Z",
"reason": "text",
"repositoryID": "123e4567-e89b-12d3-a456-426614174000"
}
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
Filter by employeeID (exact match)
Maximum number of items to return (1-1000)
10
Cursor for pagination. Use the value from the 'nextCursor' field of the previous response.
Successful response
Bad request
Unauthorized
Internal server error
GET /createEmployeeUnavailabilities HTTP/1.1
Host:
X-API-Key: YOUR_API_KEY
Accept: */*
{
"data": [
{
"activePeriod": "[2023-01-01,2023-12-31)",
"employeeID": "123e4567-e89b-12d3-a456-426614174000",
"isProposalExecutionFailed": true,
"isProposalResolved": false,
"proposalExecutionErrorText": "text",
"reason": "text",
"repositoryID": "123e4567-e89b-12d3-a456-426614174000",
"requestID": "123e4567-e89b-12d3-a456-426614174000",
"subjectID": "123e4567-e89b-12d3-a456-426614174000"
}
],
"pagination": {
"count": 1,
"hasMore": true,
"limit": 1,
"nextCursor": "text",
"total": 1
}
}
Create new proposals to add EmployeeUnavailability records. The proposals may be automatically approved or require manual approval depending on system configuration. You can submit multiple proposals in a single request.
Date range in PostgreSQL format [start,end)
[2023-01-01,2023-12-31)
Created successfully
Bad request
Unauthorized
Internal server error
POST /createEmployeeUnavailabilities HTTP/1.1
Host:
X-API-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 166
[
{
"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": false,
"proposalExecutionErrorText": "text",
"reason": "text",
"repositoryID": "123e4567-e89b-12d3-a456-426614174000",
"requestID": "123e4567-e89b-12d3-a456-426614174000",
"subjectID": "123e4567-e89b-12d3-a456-426614174000"
}
]
Get details of a specific EmployeeUnavailability creation proposal by ID
CreateEmployeeUnavailabilityProposal ID
Successful response
Unauthorized
Not found
Internal server error
GET /createEmployeeUnavailabilities/{id} HTTP/1.1
Host:
X-API-Key: YOUR_API_KEY
Accept: */*
{
"activePeriod": "[2023-01-01,2023-12-31)",
"employeeID": "123e4567-e89b-12d3-a456-426614174000",
"isProposalExecutionFailed": true,
"isProposalResolved": false,
"proposalExecutionErrorText": "text",
"reason": "text",
"repositoryID": "123e4567-e89b-12d3-a456-426614174000",
"requestID": "123e4567-e89b-12d3-a456-426614174000",
"subjectID": "123e4567-e89b-12d3-a456-426614174000"
}
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.
Maximum number of items to return (1-1000)
10
Cursor for pagination. Use the value from the 'nextCursor' field of the previous response.
Successful response
Bad request
Unauthorized
Internal server error
GET /deleteEmployeeUnavailabilities 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": {
"count": 1,
"hasMore": true,
"limit": 1,
"nextCursor": "text",
"total": 1
}
}
Create new proposals to delete EmployeeUnavailability records. The proposals may be automatically approved or require manual approval depending on system configuration. You can submit multiple proposals in a single request.
Created successfully
Bad request
Unauthorized
Internal server error
POST /deleteEmployeeUnavailabilities 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 details of a specific EmployeeUnavailability deletion proposal by ID
DeleteEmployeeUnavailabilityProposal ID
Successful response
Unauthorized
Not found
Internal server error
GET /deleteEmployeeUnavailabilities/{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 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
Filter by employeeID (exact match)
Maximum number of items to return (1-1000)
10
Cursor for pagination. Use the value from the 'nextCursor' field of the previous response.
Successful response
Bad request
Unauthorized
Internal server error
GET /updateEmployeeUnavailabilities HTTP/1.1
Host:
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": false,
"proposalExecutionErrorText": "text",
"reason": "text",
"repositoryID": "123e4567-e89b-12d3-a456-426614174000",
"requestID": "123e4567-e89b-12d3-a456-426614174000"
}
],
"pagination": {
"count": 1,
"hasMore": true,
"limit": 1,
"nextCursor": "text",
"total": 1
}
}
Create new proposals to update EmployeeUnavailability 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.
Date range in PostgreSQL format [start,end) (omit to keep current value)
[2023-01-01,2023-12-31)
Omit this field to keep current value
Omit this field to keep current value
Created successfully
Bad request
Unauthorized
Internal server error
POST /updateEmployeeUnavailabilities HTTP/1.1
Host:
X-API-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 210
[
{
"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": false,
"proposalExecutionErrorText": "text",
"reason": "text",
"repositoryID": "123e4567-e89b-12d3-a456-426614174000",
"requestID": "123e4567-e89b-12d3-a456-426614174000"
}
]
Get details of a specific EmployeeUnavailability update proposal by ID
UpdateEmployeeUnavailabilityProposal ID
Successful response
Unauthorized
Not found
Internal server error
GET /updateEmployeeUnavailabilities/{id} HTTP/1.1
Host:
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": false,
"proposalExecutionErrorText": "text",
"reason": "text",
"repositoryID": "123e4567-e89b-12d3-a456-426614174000",
"requestID": "123e4567-e89b-12d3-a456-426614174000"
}
Was this helpful?