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
Languages
Servers
https://{tenantName}.calamari.io/api/

Absence requests

Operations

Absence type

Operations

Contract types

Operations

Current shift status

Operations

Employees

Operations

Holidays

Operations

Positions

Operations

Projects

Operations

Shifts and breaks

Operations

Teams

Operations

Get all teams.

Request

Get all teams.

curl -i -X POST \
  -u <username>:<password> \
  https://awesome-company.calamari.io/api/teams/v1/all

Responses

successful operation

Bodyapplication/jsonArray [
idinteger(int64)required

Team ID

namestringrequired

Team name

Example: "Primary team"
]
Response
application/json
[
  {
    "id": 0,
    "name": "Primary team"
  }
]

Create a team.

Request

Create a team.

Bodyapplication/json
namestring[ 1 .. 2147483647 ] charactersrequired

Team name.

Example: "Marketing"
membersArray of integers(int64)required

Identifiers of team members.

managersArray of integers(int64)required

Identifiers of team managers.

curl -i -X POST \
  -u <username>:<password> \
  https://awesome-company.calamari.io/api/teams/v1/create \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "Marketing",
    "members": [
      0
    ],
    "managers": [
      0
    ]
  }'

Responses

successful operation

Bodyapplication/json
idinteger(int64)required

Id of the created team.

Example: 1
Response
application/json
{
  "id": 1
}

Remove chosen team.

Request

Remove chosen team.

Expect error codes:

  1. INVALID_REQUEST - when invalid team provided

Bodyapplication/json
idinteger(int64)required

Team ID

curl -i -X POST \
  -u <username>:<password> \
  https://awesome-company.calamari.io/api/teams/v1/remove \
  -H 'Content-Type: application/json' \
  -d '{
    "id": 0
  }'

Responses

Invalid input. Reason and description is returned in json response.

Bodyapplication/json
messagestring

Human readable error explanation.

Example: "Api error"
codestring

Error code.

Example: "INVALID_JSON_PAYLOAD"
fieldstring

Which field of payload object caused error. NULL when error is not related to particular field

Example: "field"
Response
application/json
{
  "message": "Api error",
  "code": "INVALID_JSON_PAYLOAD",
  "field": "field"
}

Timesheet entries

Operations

Working Week

Operations

People (Beta)

Endpoints related to managing people records.

Operations