Skip to content

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

Absence type

Absence Types API

Operations

Absence requests

Absence Requests API

Operations

Current shift status

Current Shift Status API

Operations

Projects

Projects API

Operations

Shifts and breaks

Shifts and Breaks API

Operations

Timesheet entries

Timesheet entries API

Operations

Working Week

Working Week API

Operations

Contract types

Contract Types API

Operations

Employees

Employees API

Operations

Holidays

Holidays API

Operations

Positions

Positions API

Operations

Teams

Teams API

Operations

Create a team.

Request

Create a team.

Security
basicAuth
Bodyapplication/json
namestring[ 1 .. 2147483647 ] charactersrequired

Team name.

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

Identifiers of team members.

Example: [123]
managersArray of integers(int64)required

Identifiers of team managers.

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

Responses

successful operation

Bodyapplication/json
idinteger(int64)required

Id of the created team.

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

Get all teams.

Request

Get all teams.

Security
basicAuth
curl -i -X POST \
  -u <username>:<password> \
  'https://{tenantname}.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"
  }
]

Remove chosen team.

Request

Remove chosen team.

Expect error codes:

  1. INVALID_REQUEST - when invalid team provided

Security
basicAuth
Bodyapplication/json
idinteger(int64)required

Team ID

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

Responses

The team has been successfully removed.

Response
No content

Update chosen team.

Request

Update chosen team.

Expect error codes:

  1. INVALID_REQUEST - when invalid team data provided

Security
basicAuth
Bodyapplication/json
idinteger(int64)required

Team ID

namestring[ 1 .. 2147483647 ] charactersrequired

Team name.

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

Identifiers of team members.

Example: [123]
managersArray of integers(int64)required

Identifiers of team managers.

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

Responses

The team has been successfully updated.

Response
No content

People

Endpoints related to managing people records.

Operations