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 Keys	Supported Operators	Notes
name	:	Equal
type	:	Equal
periodic	:	Equal
description	:	Like

Example: {"summary":"Search by name","value":"name:VARIABLE_A"}

Responses

200

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)

400

Bad Request

get

/core/v1/employee-variable-metadata

curl -X GET \
  "https://api.catapa.com/core/v1/employee-variable-metadata?page=0&size=10&query=name%3AVARIABLE_A" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Tenant: your-tenant-id"

{
  "content": [
    {
      "id": "673d457f-1975-434c-81a4-067f79345554",
      "name": "VARIABLE_A",
      "type": "STRING",
      "periodic": true,
      "description": "description",
      "validations": [
        {
          "type": "MIN",
          "value": 10
        },
        {
          "type": "MAX",
          "value": 1000
        },
        {
          "type": "OPTION",
          "options": [
            "Option 1",
            "Option 2"
          ]
        }
      ]
    }
  ],
  "totalPages": 1,
  "last": true,
  "totalElements": 1,
  "numberOfElements": 1,
  "sort": [
    {
      "direction": "DESC",
      "property": "updatedDate",
      "ignoreCase": false,
      "nullHandling": "NATIVE",
      "ascending": false,
      "descending": true
    },
    {
      "direction": "DESC",
      "property": "id",
      "ignoreCase": false,
      "nullHandling": "NATIVE",
      "ascending": false,
      "descending": true
    }
  ],
  "first": true,
  "size": 10,
  "number": 0
}

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

201

CREATED

application/json

400

Bad Request

post

/core/v1/employee-variable-metadata

curl -X POST \
  "https://api.catapa.com/core/v1/employee-variable-metadata" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Tenant: your-tenant-id" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "VARIABLE_B",
  "type": "NUMBER",
  "periodic": true,
  "description": "description",
  "validations": [
    {
      "type": "MIN",
      "value": 10
    },
    {
      "type": "MAX",
      "value": 1000
    },
    {
      "type": "OPTION",
      "options": [
        "Option 1",
        "Option 2"
      ]
    }
  ]
}'

{
  "id": "673d457f-1975-434c-81a4-067f79345554",
  "name": "VARIABLE_B",
  "type": "NUMBER",
  "periodic": true,
  "description": "description",
  "validations": [
    {
      "type": "MIN",
      "value": 10
    },
    {
      "type": "MAX",
      "value": 1000
    },
    {
      "type": "OPTION",
      "options": [
        "Option 1",
        "Option 2"
      ]
    }
  ]
}

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

200

application/json

400

Bad Request

delete

/core/v1/employee-variable-metadata

curl -X DELETE \
  "https://api.catapa.com/core/v1/employee-variable-metadata" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Tenant: your-tenant-id" \
  -H "Content-Type: application/json" \
  -d '[
  {
    "id": "673d457f-1975-434c-81a4-067f79345554"
  },
  {
    "id": "730e2120-96e6-4426-8bbd-c1945ce561f7"
  }
]'

{
  "successes": [
    {
      "id": "673d457f-1975-434c-81a4-067f79345554"
    }
  ],
  "failures": [
    {
      "code": "COM-UNKNOWN_ERROR",
      "params": {
        "id": "730e2120-96e6-4426-8bbd-c1945ce561f7"
      }
    }
  ]
}

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

200

application/json

idstringOptional

namestringOptional

typestring · enumOptionalPossible values:

periodicbooleanOptional

descriptionstringOptional

400

Bad Request

get

/core/v1/employee-variable-metadata/{id}

curl -X GET \
  "https://api.catapa.com/core/v1/employee-variable-metadata/f47ac10b-58cc-4372-a567-0e02b2c3d479" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Tenant: your-tenant-id"

{
  "id": "673d457f-1975-434c-81a4-067f79345554",
  "name": "VARIABLE_A",
  "type": "STRING",
  "periodic": true,
  "description": "description",
  "validations": [
    {
      "type": "MIN",
      "value": 10
    },
    {
      "type": "MAX",
      "value": 1000
    },
    {
      "type": "OPTION",
      "options": [
        "Option 1",
        "Option 2"
      ]
    }
  ]
}

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

200

application/json

idstringOptional

namestringOptional

typestring · enumOptionalPossible values:

periodicbooleanOptional

descriptionstringOptional

400

Bad Request

put

/core/v1/employee-variable-metadata/{id}

curl -X PUT \
  "https://api.catapa.com/core/v1/employee-variable-metadata/f47ac10b-58cc-4372-a567-0e02b2c3d479" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Tenant: your-tenant-id" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "VARIABLE_B",
  "type": "NUMBER",
  "periodic": true,
  "description": "description",
  "validations": [
    {
      "type": "MIN",
      "value": 10
    },
    {
      "type": "MAX",
      "value": 1000
    },
    {
      "type": "OPTION",
      "options": [
        "Option 1",
        "Option 2"
      ]
    }
  ]
}'

{
  "id": "673d457f-1975-434c-81a4-067f79345554",
  "name": "VARIABLE_B",
  "type": "NUMBER",
  "periodic": true,
  "description": "description",
  "validations": [
    {
      "type": "MIN",
      "value": 10
    },
    {
      "type": "MAX",
      "value": 1000
    },
    {
      "type": "OPTION",
      "options": [
        "Option 1",
        "Option 2"
      ]
    }
  ]
}

Get Employee Variables

get

Search Query

Supported Keys

Supported Operators

Notes

employeeId

Equal

employee.identificationNumber

employee.name

employee.active

Equal

name

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

200

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)

400

Bad Request

get

/core/v1/employee-variables

curl -X GET \
  "https://api.catapa.com/core/v1/employee-variables" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Tenant: your-tenant-id"

{
  "content": [
    {
      "id": "673d457f-1975-434c-81a4-067f79345554",
      "employeeId": "773d457f-1975-434c-81a4-067f79345554",
      "employee": {
        "id": "773d457f-1975-434c-81a4-067f79345554",
        "identificationNumber": "0001",
        "name": "Employee 1"
      },
      "name": "VARIABLE_A",
      "date": "2022-01-01",
      "value": "100",
      "createdBy": "system",
      "createdDate": 1641047355000,
      "updatedBy": "system",
      "updatedDate": 1641047356000
    }
  ],
  "totalPages": 1,
  "last": true,
  "totalElements": 1,
  "numberOfElements": 1,
  "sort": [
    {
      "direction": "DESC",
      "property": "updatedDate",
      "ignoreCase": false,
      "nullHandling": "NATIVE",
      "ascending": false,
      "descending": true
    },
    {
      "direction": "DESC",
      "property": "id",
      "ignoreCase": false,
      "nullHandling": "NATIVE",
      "ascending": false,
      "descending": true
    }
  ],
  "first": true,
  "size": 10,
  "number": 0
}

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

201

application/json

400

Bad Request

post

/core/v1/employee-variables

curl -X POST \
  "https://api.catapa.com/core/v1/employee-variables" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Tenant: your-tenant-id" \
  -H "Content-Type: application/json" \
  -d '{
  "employeeId": "773d457f-1975-434c-81a4-067f79345554",
  "name": "VARIABLE_B",
  "date": "2022-01-01",
  "value": "100"
}'

{
  "id": "673d457f-1975-434c-81a4-067f79345554",
  "employeeId": "773d457f-1975-434c-81a4-067f79345554",
  "employee": {
    "id": "773d457f-1975-434c-81a4-067f79345554",
    "identificationNumber": "0001",
    "name": "Employee 1"
  },
  "name": "VARIABLE_B",
  "date": "2022-01-01",
  "value": "100",
  "createdBy": "system",
  "createdDate": 1641047355000,
  "updatedBy": "system",
  "updatedDate": 1641047356000
}

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

200

application/json

idstringOptional

employeeIdstringOptional

namestringOptional

datestring · dateOptional

valuestringOptional

createdBystringOptional

createdDatenumberOptional

updatedBystringOptional

updatedDatenumberOptional

400

Bad Request

put

/core/v1/employee-variables

curl -X PUT \
  "https://api.catapa.com/core/v1/employee-variables" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Tenant: your-tenant-id" \
  -H "Content-Type: application/json" \
  -d '[
  {
    "employeeId": "773d457f-1975-434c-81a4-067f79345554",
    "name": "VARIABLE_B",
    "date": "2022-01-01",
    "value": "200"
  }
]'

[
  {
    "id": "673d457f-1975-434c-81a4-067f79345554",
    "employeeId": "773d457f-1975-434c-81a4-067f79345554",
    "employee": {
      "id": "773d457f-1975-434c-81a4-067f79345554",
      "identificationNumber": "0001",
      "name": "Employee 1"
    },
    "name": "VARIABLE_B",
    "date": "2022-01-01",
    "value": "200",
    "createdBy": "system",
    "createdDate": 1641047355000,
    "updatedBy": "system",
    "updatedDate": 1641047356000
  }
]

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

200

application/json

400

Bad Request

delete

/core/v1/employee-variables

curl -X DELETE \
  "https://api.catapa.com/core/v1/employee-variables" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Tenant: your-tenant-id" \
  -H "Content-Type: application/json" \
  -d '[
  {
    "id": "673d457f-1975-434c-81a4-067f79345554"
  },
  {
    "id": "730e2120-96e6-4426-8bbd-c1945ce561f7"
  }
]'

{
  "successes": [
    {
      "id": "673d457f-1975-434c-81a4-067f79345554"
    }
  ],
  "failures": [
    {
      "code": "COM-UNKNOWN_ERROR",
      "params": {
        "id": "730e2120-96e6-4426-8bbd-c1945ce561f7"
      }
    }
  ]
}

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

200

application/json

idstringOptional

employeeIdstringOptional

namestringOptional

datestring · dateOptional

valuestringOptional

createdBystringOptional

createdDatenumberOptional

updatedBystringOptional

updatedDatenumberOptional

400

Bad Request

get

/core/v1/employee-variables/{id}

curl -X GET \
  "https://api.catapa.com/core/v1/employee-variables/f47ac10b-58cc-4372-a567-0e02b2c3d479" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Tenant: your-tenant-id"

{
  "id": "673d457f-1975-434c-81a4-067f79345554",
  "employeeId": "773d457f-1975-434c-81a4-067f79345554",
  "employee": {
    "id": "773d457f-1975-434c-81a4-067f79345554",
    "identificationNumber": "0001",
    "name": "Employee 1"
  },
  "name": "VARIABLE_A",
  "date": "2022-01-01",
  "value": "100",
  "createdBy": "system",
  "createdDate": 1641047355000,
  "updatedBy": "system",
  "updatedDate": 1641047356000
}

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

200

application/json

idstringOptional

employeeIdstringOptional

namestringOptional

datestring · dateOptional

valuestringOptional

createdBystringOptional

createdDatenumberOptional

updatedBystringOptional

updatedDatenumberOptional

400

Bad Request

put

/core/v1/employee-variables/{id}

curl -X PUT \
  "https://api.catapa.com/core/v1/employee-variables/f47ac10b-58cc-4372-a567-0e02b2c3d479" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Tenant: your-tenant-id" \
  -H "Content-Type: application/json" \
  -d '{
  "employeeId": "773d457f-1975-434c-81a4-067f79345554",
  "name": "VARIABLE_B",
  "date": "2022-01-01",
  "value": "200"
}'

{
  "id": "673d457f-1975-434c-81a4-067f79345554",
  "employeeId": "773d457f-1975-434c-81a4-067f79345554",
  "employee": {
    "id": "773d457f-1975-434c-81a4-067f79345554",
    "identificationNumber": "0001",
    "name": "Employee 1"
  },
  "name": "VARIABLE_B",
  "date": "2022-01-01",
  "value": "200",
  "createdBy": "system",
  "createdDate": 1641047355000,
  "updatedBy": "system",
  "updatedDate": 1641047356000
}

Get Periodic Employee Variables

get

Return the periodic employee variables.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

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)

400

Bad Request

get

/core/v1/employee-variables/periodic

curl -X GET \
  "https://api.catapa.com/core/v1/employee-variables/periodic" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Tenant: your-tenant-id"

{
  "content": [
    {
      "id": "673d457f-1975-434c-81a4-067f79345554",
      "employeeId": "773d457f-1975-434c-81a4-067f79345554",
      "employee": {
        "id": "773d457f-1975-434c-81a4-067f79345554",
        "identificationNumber": "0001",
        "name": "Employee 1"
      },
      "name": "VARIABLE_A",
      "date": "2022-01-01",
      "value": "100",
      "createdBy": "system",
      "createdDate": 1641047355000,
      "updatedBy": "system",
      "updatedDate": 1641047356000
    }
  ],
  "totalPages": 1,
  "last": true,
  "totalElements": 1,
  "numberOfElements": 1,
  "sort": [
    {
      "direction": "DESC",
      "property": "updatedDate",
      "ignoreCase": false,
      "nullHandling": "NATIVE",
      "ascending": false,
      "descending": true
    },
    {
      "direction": "DESC",
      "property": "id",
      "ignoreCase": false,
      "nullHandling": "NATIVE",
      "ascending": false,
      "descending": true
    }
  ],
  "first": true,
  "size": 10,
  "number": 0
}

Get Aperiodic Employee Variables

get

Return the aperiodic employee variables.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

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)

400

Bad Request

get

/core/v1/employee-variables/aperiodic

curl -X GET \
  "https://api.catapa.com/core/v1/employee-variables/aperiodic" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Tenant: your-tenant-id"

{
  "content": [
    {
      "id": "673d457f-1975-434c-81a4-067f79345554",
      "employeeId": "773d457f-1975-434c-81a4-067f79345554",
      "employee": {
        "id": "773d457f-1975-434c-81a4-067f79345554",
        "identificationNumber": "0001",
        "name": "Employee 1"
      },
      "name": "VARIABLE_A",
      "date": "2022-01-01",
      "value": "100",
      "createdBy": "system",
      "createdDate": 1641047355000,
      "updatedBy": "system",
      "updatedDate": 1641047356000
    }
  ],
  "totalPages": 1,
  "last": true,
  "totalElements": 1,
  "numberOfElements": 1,
  "sort": [
    {
      "direction": "DESC",
      "property": "updatedDate",
      "ignoreCase": false,
      "nullHandling": "NATIVE",
      "ascending": false,
      "descending": true
    },
    {
      "direction": "DESC",
      "property": "id",
      "ignoreCase": false,
      "nullHandling": "NATIVE",
      "ascending": false,
      "descending": true
    }
  ],
  "first": true,
  "size": 10,
  "number": 0
}

Delete All Aperiodic Employee Variables

delete

Search Query

Supported Keys

Supported Operators

Notes

employeeId

Equal

employee.identificationNumber

employee.name

employee.active

Equal

name

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

200

application/json

countintegerOptional

400

Bad Request

delete

/core/v1/employee-variables/aperiodic/all

curl -X DELETE \
  "https://api.catapa.com/core/v1/employee-variables/aperiodic/all" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Tenant: your-tenant-id"

{
  "count": 1
}

Last updated 16 days ago

hashtagGet Employee Variable Metadata

Search Query

hashtagCreate Employee Variable Metadata

hashtagDelete Employee Variable Metadata

hashtagGet Employee Variable Metadata by Id

hashtagUpdate Employee Variable Metadata

hashtagGet Employee Variables

hashtagSearch Query

hashtagCreate Employee Variable

hashtagCreate or Update Employee Variables

hashtagDelete Employee Variables

hashtagGet Employee Variable by Id

hashtagUpdate Employee Variable by Id

hashtagGet Periodic Employee Variables

hashtagGet Aperiodic Employee Variables

hashtagDelete All Aperiodic Employee Variables

hashtagSearch Query

Get Employee Variable Metadata

Create Employee Variable Metadata

Delete Employee Variable Metadata

Get Employee Variable Metadata by Id

Update Employee Variable Metadata

Get Employee Variables

Search Query

Create Employee Variable

Create or Update Employee Variables

Delete Employee Variables

Get Employee Variable by Id

Update Employee Variable by Id

Get Periodic Employee Variables

Get Aperiodic Employee Variables

Delete All Aperiodic Employee Variables

Search Query