Employee Variable

These endpoints let you manage employee variables in the system. It allows you to retrieve and update custom variables associated with employees.

Get Employee Variable Metadata

get

Return the employee variable metadata.

Authorizations
AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters
pageintegerOptional

Page number

Default: 0Example: 0
sizeinteger · min: 1 · max: 50Optional

Page size

Default: 10Example: 10
querystringOptional

Search Query

Supported KeysSupported OperatorsNotes
name:Equal
type:Equal
periodic:Equal
description:Like
Example: {"summary":"Search by name","value":"name:VARIABLE_A"}
Responses
chevron-right
200

OK

application/json
totalPagesintegerRequired

Total number of pages available

lastbooleanRequired

Indicates whether this is the last page

totalElementsintegerRequired

Total number of elements across all pages

numberOfElementsintegerRequired

Number of elements in the current page

firstbooleanRequired

Indicates whether this is the first page

sizeintegerRequired

Size of the page (number of elements per page)

numberintegerRequired

Current page number (zero-indexed)

get
/core/v1/employee-variable-metadata

Create Employee Variable Metadata

post

Create employee variable metadata.

Authorizations
AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body
namestringRequired
typestring · enumRequiredPossible values:
periodicbooleanRequired
descriptionstringOptional
Responses
post
/core/v1/employee-variable-metadata

Delete Employee Variable Metadata

delete

This endpoint deletes employee variable metadata. This endpoint expects a JSON array in the request body, where each item is an object containing an id field representing the employee variable metadata to delete. The array must contain between 1 and 50 items.

Request body schema: json [ { "id": "string" } ] Example payload: json [ { "id": "673d457f-1975-434c-81a4-067f79345554" }, { "id": "730e2120-96e6-4426-8bbd-c1945ce561f7" } ]

Authorizations
AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Bodyobject[]
idstringRequired

Unique identifier

Responses
chevron-right
200

OK

application/json
delete
/core/v1/employee-variable-metadata

Get Employee Variable Metadata by Id

get

Return the employee variable metadata by Id.

Authorizations
AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters
idstringRequiredExample: f47ac10b-58cc-4372-a567-0e02b2c3d479
Responses
chevron-right
200

OK

application/json
idstringOptional
namestringOptional
typestring · enumOptionalPossible values:
periodicbooleanOptional
descriptionstringOptional
get
/core/v1/employee-variable-metadata/{id}

Update Employee Variable Metadata

put

Update the employee variable metadata.

Authorizations
AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters
idstringRequiredExample: f47ac10b-58cc-4372-a567-0e02b2c3d479
Body
namestringRequired
typestring · enumRequiredPossible values:
periodicbooleanRequired
descriptionstringOptional
Responses
chevron-right
200

OK

application/json
idstringOptional
namestringOptional
typestring · enumOptionalPossible values:
periodicbooleanOptional
descriptionstringOptional
put
/core/v1/employee-variable-metadata/{id}

Get Employee Variables

get

Search Query

Supported Keys
Supported Operators
Notes

employeeId

:

Equal

employee.identificationNumber

:

Like

employee.name

:

Like

employee.active

:

Equal

name

:

Like

metadata.id

:

Equal

date

: > <

Equal Greater than or equal to Less than or equal to

Authorizations
AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses
chevron-right
200

OK

application/json
totalPagesintegerRequired

Total number of pages available

lastbooleanRequired

Indicates whether this is the last page

totalElementsintegerRequired

Total number of elements across all pages

numberOfElementsintegerRequired

Number of elements in the current page

firstbooleanRequired

Indicates whether this is the first page

sizeintegerRequired

Size of the page (number of elements per page)

numberintegerRequired

Current page number (zero-indexed)

get
/core/v1/employee-variables

Create Employee Variable

post

Create an employee variable.

Authorizations
AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body
employeeIdstringRequired
namestringRequired
datestring · dateRequired
valuestringRequired
Responses
post
/core/v1/employee-variables

Create or Update Employee Variables

put

Create or update the employee variables.

Authorizations
AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Bodyobject[]
employeeIdstringRequired
namestringRequired
datestring · dateRequired
valuestringRequired
Responses
chevron-right
200

OK

application/json
idstringOptional
employeeIdstringOptional
namestringOptional
datestring · dateOptional
valuestringOptional
createdBystringOptional
createdDatenumberOptional
updatedBystringOptional
updatedDatenumberOptional
put
/core/v1/employee-variables

Delete Employee Variables

delete

This endpoint expects a JSON array in the request body, where each item is an object containing an id field representing the employee variable to delete. The array must contain between 1 and 50 items. Request body schema: json [ { "id": "string" } ] Example payload: json [ { "id": "673d457f-1975-434c-81a4-067f79345554" }, { "id": "730e2120-96e6-4426-8bbd-c1945ce561f7" } ]

Authorizations
AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Bodyobject[]
idstringRequired

Unique identifier

Responses
chevron-right
200

OK

application/json
delete
/core/v1/employee-variables

Get Employee Variable by Id

get

Return the employee variable by Id.

Authorizations
AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters
idstringRequiredExample: f47ac10b-58cc-4372-a567-0e02b2c3d479
Responses
chevron-right
200

OK

application/json
idstringOptional
employeeIdstringOptional
namestringOptional
datestring · dateOptional
valuestringOptional
createdBystringOptional
createdDatenumberOptional
updatedBystringOptional
updatedDatenumberOptional
get
/core/v1/employee-variables/{id}

Update Employee Variable by Id

put

Update the employee variable by Id.

Authorizations
AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters
idstringRequiredExample: f47ac10b-58cc-4372-a567-0e02b2c3d479
Body
employeeIdstringRequired
namestringRequired
datestring · dateRequired
valuestringRequired
Responses
chevron-right
200

OK

application/json
idstringOptional
employeeIdstringOptional
namestringOptional
datestring · dateOptional
valuestringOptional
createdBystringOptional
createdDatenumberOptional
updatedBystringOptional
updatedDatenumberOptional
put
/core/v1/employee-variables/{id}

Get Periodic Employee Variables

get

Return the periodic employee variables.

Authorizations
AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses
chevron-right
200

OK

application/json
totalPagesintegerRequired

Total number of pages available

lastbooleanRequired

Indicates whether this is the last page

totalElementsintegerRequired

Total number of elements across all pages

numberOfElementsintegerRequired

Number of elements in the current page

firstbooleanRequired

Indicates whether this is the first page

sizeintegerRequired

Size of the page (number of elements per page)

numberintegerRequired

Current page number (zero-indexed)

get
/core/v1/employee-variables/periodic

Get Aperiodic Employee Variables

get

Return the aperiodic employee variables.

Authorizations
AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses
chevron-right
200

OK

application/json
totalPagesintegerRequired

Total number of pages available

lastbooleanRequired

Indicates whether this is the last page

totalElementsintegerRequired

Total number of elements across all pages

numberOfElementsintegerRequired

Number of elements in the current page

firstbooleanRequired

Indicates whether this is the first page

sizeintegerRequired

Size of the page (number of elements per page)

numberintegerRequired

Current page number (zero-indexed)

get
/core/v1/employee-variables/aperiodic

Delete All Aperiodic Employee Variables

delete

Search Query

Supported Keys
Supported Operators
Notes

employeeId

:

Equal

employee.identificationNumber

:

Like

employee.name

:

Like

employee.active

:

Equal

name

:

Like

metadata.id

:

Equal

date

: > <

Equal Greater than or equal to Less than or equal to

Authorizations
AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses
chevron-right
200

OK

application/json
countintegerOptional
delete
/core/v1/employee-variables/aperiodic/all

Last updated