Calamari Public API (v1)

API for Calamari, your HR tool

Download OpenAPI description

calamari-public-openapi.json

calamari-public-openapi.yaml

Overview

URL https://developers.calamari.io

Calamari Team developers@calamari.io

Servers

https://{tenantName}.calamari.io/api/

Absence requests

Operations

Absence type

Operations

Contract types

Operations

Current shift status

Operations

Get current shift status for one person.

Request

Get current shift status for one person.

Expect error codes:

INVALID_EMPLOYEE - when invalid employee id provided

Bodyapplication/json

personstringrequired

Employee identifier. You can use e-mail or external identifier in format (externalNumber:ABC123)

Example: "john.white@mycompany.com"

curl -i -X POST \
  -u <username>:<password> \
  https://awesome-company.calamari.io/api/clockin/shift/status/v1/get-current \
  -H 'Content-Type: application/json' \
  -d '{
    "person": "john.white@mycompany.com"
  }'

Responses

successful operation

Bodyapplication/json

personobject(EmployeeSimpleOut)required

person.firstNamestringrequired

Employee first name

Example: "John"

person.lastNamestringrequired

Employee last name

Example: "Williams"

person.emailstringrequired

Employee email

Example: "john.williams@domain.com"

person.externalIdstring

Employee external identifier

Example: "A12Y"

statusstringrequired

Current shift status.

Enum"STARTED""STOPPED""BREAK"

Response

application/json

{
  "person": {
    "firstName": "John",
    "lastName": "Williams",
    "email": "john.williams@domain.com",
    "externalId": "A12Y"
  },
  "status": "STARTED"
}

Get current shift status for all employees

Request

Get current shift status for all employees.

curl -i -X POST \
  -u <username>:<password> \
  https://awesome-company.calamari.io/api/clockin/shift/status/v1/get-current-for-all

Responses

successful operation

Bodyapplication/jsonArray [

personobject(EmployeeSimpleOut)required

person.firstNamestringrequired

Employee first name

Example: "John"

person.lastNamestringrequired

Employee last name

Example: "Williams"

person.emailstringrequired

Employee email

Example: "john.williams@domain.com"

person.externalIdstring

Employee external identifier

Example: "A12Y"

statusstringrequired

Current shift status.

Enum"STARTED""STOPPED""BREAK"

]

Response

application/json

[
  {
    "person": { … },
    "status": "STARTED"
  }
]

Get current presence report for all employees

Request

Get current presence report for all employees. Results are paged by employees number.

Expect error codes:

INVALID_PAGE - when invalid page provided
INVALID_LIMIT - when invalid limit provided
INVALID_DATE_FROM - when invalid date provided
INVALID_DATE_TO - when invalid date provided

Bodyapplication/json

dateFromstring(date)required

Start date of dates range to generate presence report in ISO format

Example: "2017-01-10"

dateTostring(date)required

End date of dates range to generate presence report in ISO format

Example: "2017-01-15"

pageinteger(int32)>= 0required

Number of result page

Example: 0

limitinteger(int32)[ 1 .. 100 ]required

Number of results returned in one request

Example: 100

curl -i -X POST \
  -u <username>:<password> \
  https://awesome-company.calamari.io/api/clockin/shift/status/v1/presence/report \
  -H 'Content-Type: application/json' \
  -d '{
    "dateFrom": "2017-01-10",
    "dateTo": "2017-01-15",
    "page": 0,
    "limit": 100
  }'

Responses

successful operation

Bodyapplication/jsonArray [

datestringrequired

Date of the daily report

Example: "2021-01-01"

dailyPresenceReportArray of objects(EmployeePresenceStatus)required

Daily employees presence reports

dailyPresenceReport[].employeestringrequired

Employee full name

Example: "John White"

dailyPresenceReport[].statusstringrequired

Employee presence status

Example: "PTO"

dailyPresenceReport[].emailstringrequired

Employee email

Example: "john.smith@domain.com"

]

Response

application/json

[
  {
    "date": "2021-01-01",
    "dailyPresenceReport": [ … ]
  }
]

Employees

Operations

Holidays

Operations

Positions

Operations

Projects

Operations

Shifts and breaks

Operations

Teams

Operations

Timesheet entries

Operations

Working Week

Operations

People (Beta)

Endpoints related to managing people records.

Operations