API docs by Redocly

IT Corpo API (2.0.0)

Download OpenAPI specification:Download

API for managing IT corporation resources. For full documentation, please visit the readme.

Auth

Authentication operations

Get JWT authentication token

Responses

Response samples

Content type
application/json
{
  • "token": "string"
}

Benefits

Benefit subscriptions, services and charges

List all available benefit services

Responses

Response samples

Content type
application/json
[
  • {
    }
]

List all benefits subscriptions

query Parameters
serviceName
string
Example: serviceName=MultiSport

Filter benefits by service name

categories
string
Example: categories=HEALTHCARE,SPORT_WELLNESS

Filter benefits by categories

employeeId
string
Example: employeeId=91720

Filter benefits by employee ID

feeFrom
string
Example: feeFrom=100

Minimum monthly fee amount

feeTo
string
Example: feeTo=500.50

Maximum monthly fee amount

status
string (BenefitSubscriptionSearchStatus)
Enum: "ALL" "ACTIVE" "CANCELLED"
Example: status=ACTIVE

Filter benefits by status

_page
number
Example: _page=1

Specify the page number to retrieve

_pageSize
number [ 1 .. 50 ]
Example: _pageSize=1

Specify the number of items per page

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new benefit

Request Body schema: application/json
required
required
object
country
required
string
city
required
string
service
required
string
monthlyFee
required
number (Money)

Monetary value in EUR

subscribedAtDate
required
string <date>
cancelledAtDate
string <date>

Responses

Request samples

Content type
application/json
{
  • "beneficiary": {
    },
  • "country": "string",
  • "city": "string",
  • "service": "string",
  • "monthlyFee": 0,
  • "subscribedAtDate": "2019-08-24",
  • "cancelledAtDate": "2019-08-24"
}

Response samples

Content type
application/json
{
  • "id": "60965cfccf2844a6",
  • "beneficiary": {
    },
  • "city": "Utrecht",
  • "country": "Netherlands",
  • "service": {
    },
  • "monthlyFee": 250,
  • "subscribedAtDate": "2016-01-01",
  • "cancelledAtDate": "2016-05-31"
}

Get total number of benefits

query Parameters
serviceName
string
Example: serviceName=MultiSport

Filter benefits by service name

categories
string
Example: categories=HEALTHCARE,SPORT_WELLNESS

Filter benefits by categories

employeeId
string
Example: employeeId=91720

Filter benefits by employee ID

feeFrom
string
Example: feeFrom=100

Minimum monthly fee amount

feeTo
string
Example: feeTo=500.50

Maximum monthly fee amount

status
string (BenefitSubscriptionSearchStatus)
Enum: "ALL" "ACTIVE" "CANCELLED"
Example: status=ACTIVE

Filter benefits by status

Responses

Response samples

Content type
application/json
42

Get benefit by ID

path Parameters
benefitId
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "60965cfccf2844a6",
  • "beneficiary": {
    },
  • "city": "Utrecht",
  • "country": "Netherlands",
  • "service": {
    },
  • "monthlyFee": 250,
  • "subscribedAtDate": "2016-01-01",
  • "cancelledAtDate": "2016-05-31"
}

Update benefit

path Parameters
benefitId
required
string
Request Body schema: application/json
required
required
object
country
required
string
city
required
string
service
required
string
monthlyFee
required
number (Money)

Monetary value in EUR

subscribedAtDate
required
string <date>
cancelledAtDate
string <date>

Responses

Request samples

Content type
application/json
{
  • "beneficiary": {
    },
  • "country": "string",
  • "city": "string",
  • "service": "string",
  • "monthlyFee": 0,
  • "subscribedAtDate": "2019-08-24",
  • "cancelledAtDate": "2019-08-24"
}

Response samples

Content type
application/json
{
  • "id": "60965cfccf2844a6",
  • "beneficiary": {
    },
  • "city": "Utrecht",
  • "country": "Netherlands",
  • "service": {
    },
  • "monthlyFee": 250,
  • "subscribedAtDate": "2016-01-01",
  • "cancelledAtDate": "2016-05-31"
}

Cancel or renew benefit subscription

path Parameters
benefitId
required
string
Request Body schema: application/json
required
operation
required
string
Enum: "CANCEL" "RENEW"

Responses

Request samples

Content type
application/json
{
  • "operation": "CANCEL"
}

Response samples

Content type
application/json
{
  • "id": "60965cfccf2844a6",
  • "beneficiary": {
    },
  • "city": "Utrecht",
  • "country": "Netherlands",
  • "service": {
    },
  • "monthlyFee": 250,
  • "subscribedAtDate": "2016-01-01",
  • "cancelledAtDate": "2016-05-31"
}

List all benefit charges for a specific subscription

path Parameters
benefitId
required
string
query Parameters
providerServiceCode
string
Example: providerServiceCode=MEDICOVER_PREMIUM

Filter charges by provider service code

status
string (BenefitChargeStatus)
Enum: "PENDING" "PAID" "OVERDUE" "CANCELLED" "REFUNDED"

Filter charges by status

billingPeriodFrom
string <date>
Example: billingPeriodFrom=2023-01-01

Filter charges with billing period starting from this date

billingPeriodTo
string <date>
Example: billingPeriodTo=2023-12-31

Filter charges with billing period ending before this date

_page
number
Example: _page=1

Specify the page number to retrieve

_pageSize
number [ 1 .. 50 ]
Example: _pageSize=1

Specify the number of items per page

Responses

Response samples

Content type
application/json
[
  • {
    }
]

List all benefit charges

query Parameters
subscriptionId
string
Example: subscriptionId=zc9b3b4c-1b1d-4b3e-8b3b-4c1b1d4b3e8b

Filter charges by subscription ID

employeeId
string
Example: employeeId=91720

Filter benefits by employee ID

providerServiceCode
string
Example: providerServiceCode=MEDICOVER_PREMIUM

Filter charges by provider service code

status
string (BenefitChargeStatus)
Enum: "PENDING" "PAID" "OVERDUE" "CANCELLED" "REFUNDED"

Filter charges by status

billingPeriodFrom
string <date>
Example: billingPeriodFrom=2023-01-01

Filter charges with billing period starting from this date

billingPeriodTo
string <date>
Example: billingPeriodTo=2023-12-31

Filter charges with billing period ending before this date

_page
number
Example: _page=1

Specify the page number to retrieve

_pageSize
number [ 1 .. 50 ]
Example: _pageSize=1

Specify the number of items per page

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Departments

Departments management

List all departments

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new department

Request Body schema: application/json
required
name
required
string

Responses

Request samples

Content type
application/json
{
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "id": 1,
  • "name": "Management"
}

Get total number of departments

Responses

Response samples

Content type
application/json
8

Get department by ID

path Parameters
departmentId
required
integer

Responses

Response samples

Content type
application/json
{
  • "id": 1,
  • "name": "Management"
}

Update department

path Parameters
departmentId
required
integer
Request Body schema: application/json
required
name
required
string

Responses

Request samples

Content type
application/json
{
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "id": 1,
  • "name": "Management"
}

Delete department

path Parameters
departmentId
required
integer

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string"
}

Employees

Employees management

List all employees

query Parameters
employeeName
string
Example: employeeName=John Doe

Filter employees by name

departmentId
string
Example: departmentId=123

Filter employees by department ID

skills
string
Example: skills=JavaScript,React

Filter employees by skills

skillsFiltering
string
Default: "ANY"
Enum: "ANY" "ALL"
Example: skillsFiltering=ALL

How to match employee skills

salaryFrom
string
Example: salaryFrom=5000

Minimum salary amount

salaryTo
string
Example: salaryTo=10000

Maximum salary amount

_page
number
Example: _page=1

Specify the page number to retrieve

_pageSize
number [ 1 .. 50 ]
Example: _pageSize=1

Specify the number of items per page

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new employee

Request Body schema: application/json
required
nationality
required
string (Nationality)
Enum: "US" "UK" "FR" "DE" "NL" "PL" "IT" "ES" "IN"

Nationality of employee as an ISO 3166-1 alpha-2 country code

departmentId
required
number
keycardId
required
string
account
required
string
salary
required
number (Money)

Monetary value in EUR

office
required
Array of strings = 2 items
firstName
required
string
lastName
required
string
title
required
string
contractType
required
string (ContractType)
Enum: "CONTRACT" "PERMANENT"

Type of employment contract

email
required
string <email> (Email)

Email address string

hiredAt
required
string <date-time> (DateString)

ISO 8601 date-time string

expiresAt
required
string <date-time> (DateString)

ISO 8601 date-time string

required
object
skills
required
Array of strings (Skill)
bio
required
string
imgURL
string

Responses

Request samples

Content type
application/json
{
  • "nationality": "US",
  • "departmentId": 0,
  • "keycardId": "string",
  • "account": "string",
  • "salary": 0,
  • "office": [
    ],
  • "firstName": "string",
  • "lastName": "string",
  • "title": "string",
  • "contractType": "PERMANENT",
  • "email": "user@example.com",
  • "hiredAt": "2019-08-24T14:15:22Z",
  • "expiresAt": "2019-08-24T14:15:22Z",
  • "personalInfo": {
    },
  • "skills": [
    ],
  • "bio": "string",
  • "imgURL": "string"
}

Response samples

Content type
application/json
{
  • "id": 1234,
  • "nationality": "DE",
  • "department": "Marketing",
  • "keycardId": "KC-9876",
  • "account": "DE89 3704 0044 0532 0130 00",
  • "salary": 75000,
  • "office": [
    ],
  • "firstName": "Hans",
  • "lastName": "Schmidt",
  • "title": "Senior Developer",
  • "contractType": "PERMANENT",
  • "email": "hans.schmidt@itcorpo.com",
  • "hiredAt": "2020-01-15T00:00:00.000Z",
  • "expiresAt": "2025-01-14T23:59:59.999Z",
  • "personalInfo": {
    },
  • "skills": [
    ],
  • "bio": "Experienced developer with focus on frontend technologies",
  • "imgURL": "hans-schmidt-profile.jpg"
}

Get total number of employees

query Parameters
employeeName
string
Example: employeeName=John Doe

Filter employees by name

departmentId
string
Example: departmentId=123

Filter employees by department ID

skills
string
Example: skills=JavaScript,React

Filter employees by skills

skillsFiltering
string
Default: "ANY"
Enum: "ANY" "ALL"
Example: skillsFiltering=ALL

How to match employee skills

salaryFrom
string
Example: salaryFrom=5000

Minimum salary amount

salaryTo
string
Example: salaryTo=10000

Maximum salary amount

Responses

Response samples

Content type
application/json
1250

Get employee by ID

path Parameters
employeeId
required
integer
Example: 91720

Responses

Response samples

Content type
application/json
{
  • "id": 1234,
  • "nationality": "DE",
  • "department": "Marketing",
  • "keycardId": "KC-9876",
  • "account": "DE89 3704 0044 0532 0130 00",
  • "salary": 75000,
  • "office": [
    ],
  • "firstName": "Hans",
  • "lastName": "Schmidt",
  • "title": "Senior Developer",
  • "contractType": "PERMANENT",
  • "email": "hans.schmidt@itcorpo.com",
  • "hiredAt": "2020-01-15T00:00:00.000Z",
  • "expiresAt": "2025-01-14T23:59:59.999Z",
  • "personalInfo": {
    },
  • "skills": [
    ],
  • "bio": "Experienced developer with focus on frontend technologies",
  • "imgURL": "hans-schmidt-profile.jpg"
}

Update employee

path Parameters
employeeId
required
integer
Request Body schema: application/json
required
nationality
required
string (Nationality)
Enum: "US" "UK" "FR" "DE" "NL" "PL" "IT" "ES" "IN"

Nationality of employee as an ISO 3166-1 alpha-2 country code

departmentId
required
number
keycardId
required
string
account
required
string
salary
required
number (Money)

Monetary value in EUR

office
required
Array of strings = 2 items
firstName
required
string
lastName
required
string
title
required
string
contractType
required
string (ContractType)
Enum: "CONTRACT" "PERMANENT"

Type of employment contract

email
required
string <email> (Email)

Email address string

hiredAt
required
string <date-time> (DateString)

ISO 8601 date-time string

expiresAt
required
string <date-time> (DateString)

ISO 8601 date-time string

required
object
skills
required
Array of strings (Skill)
bio
required
string
imgURL
string

Responses

Request samples

Content type
application/json
{
  • "nationality": "US",
  • "departmentId": 0,
  • "keycardId": "string",
  • "account": "string",
  • "salary": 0,
  • "office": [
    ],
  • "firstName": "string",
  • "lastName": "string",
  • "title": "string",
  • "contractType": "PERMANENT",
  • "email": "user@example.com",
  • "hiredAt": "2019-08-24T14:15:22Z",
  • "expiresAt": "2019-08-24T14:15:22Z",
  • "personalInfo": {
    },
  • "skills": [
    ],
  • "bio": "string",
  • "imgURL": "string"
}

Response samples

Content type
application/json
{
  • "id": 1234,
  • "nationality": "DE",
  • "department": "Marketing",
  • "keycardId": "KC-9876",
  • "account": "DE89 3704 0044 0532 0130 00",
  • "salary": 75000,
  • "office": [
    ],
  • "firstName": "Hans",
  • "lastName": "Schmidt",
  • "title": "Senior Developer",
  • "contractType": "PERMANENT",
  • "email": "hans.schmidt@itcorpo.com",
  • "hiredAt": "2020-01-15T00:00:00.000Z",
  • "expiresAt": "2025-01-14T23:59:59.999Z",
  • "personalInfo": {
    },
  • "skills": [
    ],
  • "bio": "Experienced developer with focus on frontend technologies",
  • "imgURL": "hans-schmidt-profile.jpg"
}

Delete employee

path Parameters
employeeId
required
integer

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string"
}

Get projects which employee is assigned to

Returns a list of projects that the employee is assigned to.

path Parameters
employeeId
required
integer
Example: 91720

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Expenses

Financial operations

List all expenses

query Parameters
_page
number
Example: _page=1

Specify the page number to retrieve

_pageSize
number [ 1 .. 50 ]
Example: _pageSize=1

Specify the number of items per page

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new expense

Request Body schema: application/json
required
amount
required
number (Money)

Monetary value in EUR

title
required
string
payerAccount
required
string
beneficiaryAccount
required
string
beneficiaryAddress
required
string
scheduledAt
required
string <date-time>

Responses

Request samples

Content type
application/json
{
  • "amount": 0,
  • "title": "string",
  • "payerAccount": "string",
  • "beneficiaryAccount": "string",
  • "beneficiaryAddress": "string",
  • "scheduledAt": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "id": "f1c436a7-d9f5-4214-9be1-79766750b53b",
  • "amount": 10927,
  • "title": "salary",
  • "payerAccount": "DE89 3704 0044 0532 0130 00",
  • "beneficiaryAccount": "PL61 1090 1014 0000 0712 1981 2874",
  • "beneficiaryAddress": "445 Mount Eden Road, Mount Eden, Auckland",
  • "scheduledAt": "2017-02-17T22:01:36.530Z"
}

Get total number of expenses

Responses

Response samples

Content type
application/json
523

Get expense by ID

path Parameters
expenseId
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "f1c436a7-d9f5-4214-9be1-79766750b53b",
  • "amount": 10927,
  • "title": "salary",
  • "payerAccount": "DE89 3704 0044 0532 0130 00",
  • "beneficiaryAccount": "PL61 1090 1014 0000 0712 1981 2874",
  • "beneficiaryAddress": "445 Mount Eden Road, Mount Eden, Auckland",
  • "scheduledAt": "2017-02-17T22:01:36.530Z"
}

Update expense

path Parameters
expenseId
required
string
Request Body schema: application/json
required
amount
required
number (Money)

Monetary value in EUR

title
required
string
payerAccount
required
string
beneficiaryAccount
required
string
beneficiaryAddress
required
string
scheduledAt
required
string <date-time>

Responses

Request samples

Content type
application/json
{
  • "amount": 0,
  • "title": "string",
  • "payerAccount": "string",
  • "beneficiaryAccount": "string",
  • "beneficiaryAddress": "string",
  • "scheduledAt": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "id": "f1c436a7-d9f5-4214-9be1-79766750b53b",
  • "amount": 10927,
  • "title": "salary",
  • "payerAccount": "DE89 3704 0044 0532 0130 00",
  • "beneficiaryAccount": "PL61 1090 1014 0000 0712 1981 2874",
  • "beneficiaryAddress": "445 Mount Eden Road, Mount Eden, Auckland",
  • "scheduledAt": "2017-02-17T22:01:36.530Z"
}

Delete expense

path Parameters
expenseId
required
string

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string"
}

Geo

Geographical data

Get geographical data

Returns a dictionary of country codes and country names

Responses

Response samples

Content type
application/json
{
  • "US": "United States",
  • "UK": "United Kingdom",
  • "DE": "Germany"
}

Offices

Offices management

Retrieve list of possible office amenities

Returns an array of office amenity objects that can be assigned to offices

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get total number of office amenities

Responses

Response samples

Content type
application/json
15

List all offices

query Parameters
phrase
string
Example: phrase=Amsterdam

Full text search across office fields

countries
string
Example: countries=PL,US

Filter offices by country codes

amenities
string
Example: amenities=FREE_PARKING,SHOWER

Filter offices by amenities

amenitiesFiltering
string
Default: "ANY"
Enum: "ANY" "ALL"
Example: amenitiesFiltering=ALL

How to match office amenities ('ANY' or 'ALL')

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new office

Request Body schema: application/json
required
code
required
string
country
required
string
city
required
string
address
required
string
capacity
required
integer >= 1
monthlyRental
required
number (Money)

Monetary value in EUR

required
object
required
Array of objects (OfficeAmenity)
imgURL
string

Responses

Request samples

Content type
application/json
{
  • "code": "string",
  • "country": "string",
  • "city": "string",
  • "address": "string",
  • "capacity": 1,
  • "monthlyRental": 0,
  • "estate": {
    },
  • "amenities": [
    ],
  • "imgURL": "string"
}

Response samples

Content type
application/json
{
  • "country": "Netherlands",
  • "city": "Amsterdam",
  • "address": "Damrak 81",
  • "capacity": 150,
  • "monthlyRental": 10000,
  • "estate": {
    },
  • "amenities": [
    ],
  • "imgURL": "amsterdam-6Uf6-XCKJ-qTKq-ISt2-B3SE.jpg"
}

Get total number of offices

query Parameters
phrase
string
Example: phrase=Amsterdam

Full text search across office fields

countries
string
Example: countries=PL,US

Filter offices by country codes

amenities
string
Example: amenities=FREE_PARKING,SHOWER

Filter offices by amenities

amenitiesFiltering
string
Default: "ANY"
Enum: "ANY" "ALL"
Example: amenitiesFiltering=ALL

How to match office amenities ('ANY' or 'ALL')

Responses

Response samples

Content type
application/json
25

Get office by office code

path Parameters
officeCode
required
string

Responses

Response samples

Content type
application/json
{
  • "country": "Netherlands",
  • "city": "Amsterdam",
  • "address": "Damrak 81",
  • "capacity": 150,
  • "monthlyRental": 10000,
  • "estate": {
    },
  • "amenities": [
    ],
  • "imgURL": "amsterdam-6Uf6-XCKJ-qTKq-ISt2-B3SE.jpg"
}

Update office

path Parameters
officeCode
required
string
Request Body schema: application/json
required
code
required
string
country
required
string
city
required
string
address
required
string
capacity
required
integer >= 1
monthlyRental
required
number (Money)

Monetary value in EUR

required
object
required
Array of objects (OfficeAmenity)
imgURL
string

Responses

Request samples

Content type
application/json
{
  • "code": "string",
  • "country": "string",
  • "city": "string",
  • "address": "string",
  • "capacity": 1,
  • "monthlyRental": 0,
  • "estate": {
    },
  • "amenities": [
    ],
  • "imgURL": "string"
}

Response samples

Content type
application/json
{
  • "country": "Netherlands",
  • "city": "Amsterdam",
  • "address": "Damrak 81",
  • "capacity": 150,
  • "monthlyRental": 10000,
  • "estate": {
    },
  • "amenities": [
    ],
  • "imgURL": "amsterdam-6Uf6-XCKJ-qTKq-ISt2-B3SE.jpg"
}

Delete office

path Parameters
officeCode
required
string

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string"
}

Projects

Projects management

List all projects

query Parameters
projectName
string
Example: projectName=Cloud migration

Filter projects by name

status
string (ProjectStatus)
Enum: "PLANNING" "ACTIVE" "COMPLETED" "ON_HOLD"
Example: status=ACTIVE

Filter projects by status

teamMembers
string
Example: teamMembers=123,456,789

Filter projects by team member IDs

teamMembersFiltering
string
Default: "ANY"
Enum: "ANY" "ALL"
Example: teamMembersFiltering=ALL

How to match team members

budgetFrom
string
Example: budgetFrom=10000

Minimum project budget

budgetTo
string
Example: budgetTo=50000

Maximum project budget

_page
number
Example: _page=1

Specify the page number to retrieve

_pageSize
number [ 1 .. 50 ]
Example: _pageSize=1

Specify the number of items per page

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new project

Request Body schema: application/json
required
name
required
string
status
required
string (ProjectStatus)
Enum: "PLANNING" "ACTIVE" "COMPLETED" "ON_HOLD"

Status of the ongoing project's workflow

budget
required
number (Money)

Monetary value in EUR

startDate
required
string <date>
endDate
required
string <date>
required
Array of objects
manager
required
integer
description
required
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "status": "ACTIVE",
  • "budget": 0,
  • "startDate": "2019-08-24",
  • "endDate": "2019-08-24",
  • "team": [
    ],
  • "manager": 0,
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "id": "579ef28f-c539-41ff-abe2-e4f6b1c1afed",
  • "name": "Licensed Cotton Pants",
  • "status": "on-hold",
  • "budget": 490000,
  • "startDate": "2013-04-16",
  • "endDate": "2019-04-27",
  • "team": [
    ],
  • "manager": 67429059,
  • "description": "Deleniti rerum impedit.\nCum sed eaque quo accusantium."
}

Get total number of projects

query Parameters
projectName
string
Example: projectName=Cloud migration

Filter projects by name

status
string (ProjectStatus)
Enum: "PLANNING" "ACTIVE" "COMPLETED" "ON_HOLD"
Example: status=ACTIVE

Filter projects by status

teamMembers
string
Example: teamMembers=123,456,789

Filter projects by team member IDs

teamMembersFiltering
string
Default: "ANY"
Enum: "ANY" "ALL"
Example: teamMembersFiltering=ALL

How to match team members

budgetFrom
string
Example: budgetFrom=10000

Minimum project budget

budgetTo
string
Example: budgetTo=50000

Maximum project budget

Responses

Response samples

Content type
application/json
156

Get project by ID

path Parameters
projectId
required
string
Example: 579ef28f-c539-41ff-abe2-e4f6b1c1afed

Responses

Response samples

Content type
application/json
{
  • "id": "579ef28f-c539-41ff-abe2-e4f6b1c1afed",
  • "name": "Licensed Cotton Pants",
  • "status": "on-hold",
  • "budget": 490000,
  • "startDate": "2013-04-16",
  • "endDate": "2019-04-27",
  • "team": [
    ],
  • "manager": 67429059,
  • "description": "Deleniti rerum impedit.\nCum sed eaque quo accusantium."
}

Update project

path Parameters
projectId
required
string
Request Body schema: application/json
required
name
required
string
status
required
string (ProjectStatus)
Enum: "PLANNING" "ACTIVE" "COMPLETED" "ON_HOLD"

Status of the ongoing project's workflow

budget
required
number (Money)

Monetary value in EUR

startDate
required
string <date>
endDate
required
string <date>
required
Array of objects
manager
required
integer
description
required
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "status": "ACTIVE",
  • "budget": 0,
  • "startDate": "2019-08-24",
  • "endDate": "2019-08-24",
  • "team": [
    ],
  • "manager": 0,
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "id": "579ef28f-c539-41ff-abe2-e4f6b1c1afed",
  • "name": "Licensed Cotton Pants",
  • "status": "on-hold",
  • "budget": 490000,
  • "startDate": "2013-04-16",
  • "endDate": "2019-04-27",
  • "team": [
    ],
  • "manager": 67429059,
  • "description": "Deleniti rerum impedit.\nCum sed eaque quo accusantium."
}

Delete project

path Parameters
projectId
required
string

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string"
}

Get project team (employees assigned to the project)

Returns a list of employees that are assigned to the project.

path Parameters
projectId
required
string
Example: 579ef28f-c539-41ff-abe2-e4f6b1c1afed

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Pagination

Fetched collection results are paginated

List all benefits subscriptions

query Parameters
serviceName
string
Example: serviceName=MultiSport

Filter benefits by service name

categories
string
Example: categories=HEALTHCARE,SPORT_WELLNESS

Filter benefits by categories

employeeId
string
Example: employeeId=91720

Filter benefits by employee ID

feeFrom
string
Example: feeFrom=100

Minimum monthly fee amount

feeTo
string
Example: feeTo=500.50

Maximum monthly fee amount

status
string (BenefitSubscriptionSearchStatus)
Enum: "ALL" "ACTIVE" "CANCELLED"
Example: status=ACTIVE

Filter benefits by status

_page
number
Example: _page=1

Specify the page number to retrieve

_pageSize
number [ 1 .. 50 ]
Example: _pageSize=1

Specify the number of items per page

Responses

Response samples

Content type
application/json
[
  • {
    }
]

List all benefit charges for a specific subscription

path Parameters
benefitId
required
string
query Parameters
providerServiceCode
string
Example: providerServiceCode=MEDICOVER_PREMIUM

Filter charges by provider service code

status
string (BenefitChargeStatus)
Enum: "PENDING" "PAID" "OVERDUE" "CANCELLED" "REFUNDED"

Filter charges by status

billingPeriodFrom
string <date>
Example: billingPeriodFrom=2023-01-01

Filter charges with billing period starting from this date

billingPeriodTo
string <date>
Example: billingPeriodTo=2023-12-31

Filter charges with billing period ending before this date

_page
number
Example: _page=1

Specify the page number to retrieve

_pageSize
number [ 1 .. 50 ]
Example: _pageSize=1

Specify the number of items per page

Responses

Response samples

Content type
application/json
[
  • {
    }
]

List all benefit charges

query Parameters
subscriptionId
string
Example: subscriptionId=zc9b3b4c-1b1d-4b3e-8b3b-4c1b1d4b3e8b

Filter charges by subscription ID

employeeId
string
Example: employeeId=91720

Filter benefits by employee ID

providerServiceCode
string
Example: providerServiceCode=MEDICOVER_PREMIUM

Filter charges by provider service code

status
string (BenefitChargeStatus)
Enum: "PENDING" "PAID" "OVERDUE" "CANCELLED" "REFUNDED"

Filter charges by status

billingPeriodFrom
string <date>
Example: billingPeriodFrom=2023-01-01

Filter charges with billing period starting from this date

billingPeriodTo
string <date>
Example: billingPeriodTo=2023-12-31

Filter charges with billing period ending before this date

_page
number
Example: _page=1

Specify the page number to retrieve

_pageSize
number [ 1 .. 50 ]
Example: _pageSize=1

Specify the number of items per page

Responses

Response samples

Content type
application/json
[
  • {
    }
]

List all employees

query Parameters
employeeName
string
Example: employeeName=John Doe

Filter employees by name

departmentId
string
Example: departmentId=123

Filter employees by department ID

skills
string
Example: skills=JavaScript,React

Filter employees by skills

skillsFiltering
string
Default: "ANY"
Enum: "ANY" "ALL"
Example: skillsFiltering=ALL

How to match employee skills

salaryFrom
string
Example: salaryFrom=5000

Minimum salary amount

salaryTo
string
Example: salaryTo=10000

Maximum salary amount

_page
number
Example: _page=1

Specify the page number to retrieve

_pageSize
number [ 1 .. 50 ]
Example: _pageSize=1

Specify the number of items per page

Responses

Response samples

Content type
application/json
[
  • {
    }
]

List all expenses

query Parameters
_page
number
Example: _page=1

Specify the page number to retrieve

_pageSize
number [ 1 .. 50 ]
Example: _pageSize=1

Specify the number of items per page

Responses

Response samples

Content type
application/json
[
  • {
    }
]

List all projects

query Parameters
projectName
string
Example: projectName=Cloud migration

Filter projects by name

status
string (ProjectStatus)
Enum: "PLANNING" "ACTIVE" "COMPLETED" "ON_HOLD"
Example: status=ACTIVE

Filter projects by status

teamMembers
string
Example: teamMembers=123,456,789

Filter projects by team member IDs

teamMembersFiltering
string
Default: "ANY"
Enum: "ANY" "ALL"
Example: teamMembersFiltering=ALL

How to match team members

budgetFrom
string
Example: budgetFrom=10000

Minimum project budget

budgetTo
string
Example: budgetTo=50000

Maximum project budget

_page
number
Example: _page=1

Specify the page number to retrieve

_pageSize
number [ 1 .. 50 ]
Example: _pageSize=1

Specify the number of items per page

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Search

Fetched collection results allow specifying detailed search criteria

List all benefits subscriptions

query Parameters
serviceName
string
Example: serviceName=MultiSport

Filter benefits by service name

categories
string
Example: categories=HEALTHCARE,SPORT_WELLNESS

Filter benefits by categories

employeeId
string
Example: employeeId=91720

Filter benefits by employee ID

feeFrom
string
Example: feeFrom=100

Minimum monthly fee amount

feeTo
string
Example: feeTo=500.50

Maximum monthly fee amount

status
string (BenefitSubscriptionSearchStatus)
Enum: "ALL" "ACTIVE" "CANCELLED"
Example: status=ACTIVE

Filter benefits by status

_page
number
Example: _page=1

Specify the page number to retrieve

_pageSize
number [ 1 .. 50 ]
Example: _pageSize=1

Specify the number of items per page

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get total number of benefits

query Parameters
serviceName
string
Example: serviceName=MultiSport

Filter benefits by service name

categories
string
Example: categories=HEALTHCARE,SPORT_WELLNESS

Filter benefits by categories

employeeId
string
Example: employeeId=91720

Filter benefits by employee ID

feeFrom
string
Example: feeFrom=100

Minimum monthly fee amount

feeTo
string
Example: feeTo=500.50

Maximum monthly fee amount

status
string (BenefitSubscriptionSearchStatus)
Enum: "ALL" "ACTIVE" "CANCELLED"
Example: status=ACTIVE

Filter benefits by status

Responses

Response samples

Content type
application/json
42

List all benefit charges

query Parameters
subscriptionId
string
Example: subscriptionId=zc9b3b4c-1b1d-4b3e-8b3b-4c1b1d4b3e8b

Filter charges by subscription ID

employeeId
string
Example: employeeId=91720

Filter benefits by employee ID

providerServiceCode
string
Example: providerServiceCode=MEDICOVER_PREMIUM

Filter charges by provider service code

status
string (BenefitChargeStatus)
Enum: "PENDING" "PAID" "OVERDUE" "CANCELLED" "REFUNDED"

Filter charges by status

billingPeriodFrom
string <date>
Example: billingPeriodFrom=2023-01-01

Filter charges with billing period starting from this date

billingPeriodTo
string <date>
Example: billingPeriodTo=2023-12-31

Filter charges with billing period ending before this date

_page
number
Example: _page=1

Specify the page number to retrieve

_pageSize
number [ 1 .. 50 ]
Example: _pageSize=1

Specify the number of items per page

Responses

Response samples

Content type
application/json
[
  • {
    }
]

List all employees

query Parameters
employeeName
string
Example: employeeName=John Doe

Filter employees by name

departmentId
string
Example: departmentId=123

Filter employees by department ID

skills
string
Example: skills=JavaScript,React

Filter employees by skills

skillsFiltering
string
Default: "ANY"
Enum: "ANY" "ALL"
Example: skillsFiltering=ALL

How to match employee skills

salaryFrom
string
Example: salaryFrom=5000

Minimum salary amount

salaryTo
string
Example: salaryTo=10000

Maximum salary amount

_page
number
Example: _page=1

Specify the page number to retrieve

_pageSize
number [ 1 .. 50 ]
Example: _pageSize=1

Specify the number of items per page

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get total number of employees

query Parameters
employeeName
string
Example: employeeName=John Doe

Filter employees by name

departmentId
string
Example: departmentId=123

Filter employees by department ID

skills
string
Example: skills=JavaScript,React

Filter employees by skills

skillsFiltering
string
Default: "ANY"
Enum: "ANY" "ALL"
Example: skillsFiltering=ALL

How to match employee skills

salaryFrom
string
Example: salaryFrom=5000

Minimum salary amount

salaryTo
string
Example: salaryTo=10000

Maximum salary amount

Responses

Response samples

Content type
application/json
1250

List all expenses

query Parameters
_page
number
Example: _page=1

Specify the page number to retrieve

_pageSize
number [ 1 .. 50 ]
Example: _pageSize=1

Specify the number of items per page

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get total number of expenses

Responses

Response samples

Content type
application/json
523

List all offices

query Parameters
phrase
string
Example: phrase=Amsterdam

Full text search across office fields

countries
string
Example: countries=PL,US

Filter offices by country codes

amenities
string
Example: amenities=FREE_PARKING,SHOWER

Filter offices by amenities

amenitiesFiltering
string
Default: "ANY"
Enum: "ANY" "ALL"
Example: amenitiesFiltering=ALL

How to match office amenities ('ANY' or 'ALL')

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get total number of offices

query Parameters
phrase
string
Example: phrase=Amsterdam

Full text search across office fields

countries
string
Example: countries=PL,US

Filter offices by country codes

amenities
string
Example: amenities=FREE_PARKING,SHOWER

Filter offices by amenities

amenitiesFiltering
string
Default: "ANY"
Enum: "ANY" "ALL"
Example: amenitiesFiltering=ALL

How to match office amenities ('ANY' or 'ALL')

Responses

Response samples

Content type
application/json
25

List all projects

query Parameters
projectName
string
Example: projectName=Cloud migration

Filter projects by name

status
string (ProjectStatus)
Enum: "PLANNING" "ACTIVE" "COMPLETED" "ON_HOLD"
Example: status=ACTIVE

Filter projects by status

teamMembers
string
Example: teamMembers=123,456,789

Filter projects by team member IDs

teamMembersFiltering
string
Default: "ANY"
Enum: "ANY" "ALL"
Example: teamMembersFiltering=ALL

How to match team members

budgetFrom
string
Example: budgetFrom=10000

Minimum project budget

budgetTo
string
Example: budgetTo=50000

Maximum project budget

_page
number
Example: _page=1

Specify the page number to retrieve

_pageSize
number [ 1 .. 50 ]
Example: _pageSize=1

Specify the number of items per page

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get total number of projects

query Parameters
projectName
string
Example: projectName=Cloud migration

Filter projects by name

status
string (ProjectStatus)
Enum: "PLANNING" "ACTIVE" "COMPLETED" "ON_HOLD"
Example: status=ACTIVE

Filter projects by status

teamMembers
string
Example: teamMembers=123,456,789

Filter projects by team member IDs

teamMembersFiltering
string
Default: "ANY"
Enum: "ANY" "ALL"
Example: teamMembersFiltering=ALL

How to match team members

budgetFrom
string
Example: budgetFrom=10000

Minimum project budget

budgetTo
string
Example: budgetTo=50000

Maximum project budget

Responses

Response samples

Content type
application/json
156

System

Health Check

Endpoint to check the health of the API

Responses

Response samples

Content type
application/json
{
  • "status": "HEALTHY",
  • "message": "All systems operational",
  • "property1": "string",
  • "property2": "string"
}

Get license information

Returns the license text for the API

header Parameters
Content-Type
required
string
Value: "text/plain"

Must be text/plain

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string"
}