API for Calamari, your HR tool
URL https://developers.calamari.io
Calamari Team developers@calamari.io
API for Calamari, your HR tool
Find employees working time balances in dates range.
If you provide more than one value in one filter attribute there is OR relation between them. For instance: if you put in a filter: {employees: ["john@mycompany.com", "kevin@mycompany.com"]} it returns all John's and all Kevin's balances.
When you fill more than one attribute in filter all conditions have to be fulfilled. There is AND relation between attributes. For instance: if you provide in filter {contractTypes: ["Full-time"], teams: ["DevTeam"]} then you receive balances of employees from Dev and Full-time
Expect error codes:
Start date of dates range to search request in ISO format
List of teams names or identifiers to search. As a result there will be absence requests of employees who are members of at least one of provided teams. Example: ["First Team", "Second Team", "Third Team"]
List of positions names or identifiers to search. As a result there will be absence requests of employees who have one of provided positions. Example: ["Developer", "Support", "Architect"]
List of contract types names or identifiers to search. As a result there will be absence requests of employees who have one of contract type. Example: ["firstContract", "secondContract"]
curl -i -X POST \
-u <username>:<password> \
https://awesome-company.calamari.io/api/clockin/timesheetentries/v1/balance \
-H 'Content-Type: application/json' \
-d '{
"from": "2020-01-10",
"to": "2020-01-15",
"teams": [
"string"
],
"positions": [
"string"
],
"contractTypes": [
"string"
],
"employees": [
"string"
]
}'[ { "person": { … }, "balance": -3600 } ]
Add employee shift.
Expect error codes:
Employee identifier. You can use e-mail or external identifier in format (externalNumber:ABC123)
curl -i -X POST \
-u <username>:<password> \
https://awesome-company.calamari.io/api/clockin/timesheetentries/v1/create \
-H 'Content-Type: application/json' \
-d '{
"person": "john.white@mycompany.com",
"shiftStart": "2020-03-15T08:30:00",
"shiftEnd": "2020-03-15T16:30:00",
"breaks": [
{
"breakType": 1,
"breakStart": "2020-03-15T09:30:00",
"breakEnd": "2020-03-15T10:30:00"
}
],
"projects": [
{
"projectType": 1,
"projectStart": "2020-03-15T09:30:00",
"projectEnd": "2020-03-15T10:30:00"
}
],
"description": "string"
}'successful operation
Date and time of timesheet entry finished. Has null value if employee does not clock out
Duration of timesheet entry in seconds. Has 0 value if employee does not clock out
List of breaks
Date and time when break was finished. Has null value if break was not finished
Duration of a break in seconds. Has null value if break was not finished.
List of projects
Date and time when employee finished working on project. Has null value if work on project was not finished
Duration of time spent on a project in seconds. Has null value if work on project was not finished
{ "id": 0, "started": "2019-08-24T14:15:22Z", "finished": "2019-08-24T14:15:22Z", "startedTimeZone": { "displayName": "string", "id": "string", "dstsavings": 0, "rawOffset": 0 }, "finishedTimeZone": { "displayName": "string", "id": "string", "dstsavings": 0, "rawOffset": 0 }, "duration": 28800, "person": { "firstName": "John", "lastName": "Williams", "email": "john.williams@domain.com", "externalId": "A12Y" }, "breaks": [ { … } ], "projects": [ { … } ], "closed": true, "description": "string" }
curl -i -X POST \
-u <username>:<password> \
https://awesome-company.calamari.io/api/clockin/timesheetentries/v1/delete \
-H 'Content-Type: application/json' \
-d '{
"id": 0
}'Find timesheet entries in dates range.
If you provide more than one value in one filter attribute there is OR relation between them. For instance: if you put in a filter: {employees: ["john@mycompany.com", "kevin@mycompany.com"]} it returns all John's and all Kevin's timesheet entries.
When you fill more than one attribute in filter all conditions have to be fulfilled. There is AND relation between attributes. For instance: if you provide in filter {contractTypes: ["Full-time"], teams: ["DevTeam"]} then timesheet entries of employees from Dev and Full-time
Expect error codes:
Start date of dates range to search timesheet entries in ISO format
End date of dates range to search timesheet entries in ISO format
List of teams names or identifiers to search. As a result there will be timesheet entries of employees who are members of at least one of provided teams. Example: ["First Team", "Second Team"]
List of positions names or identifiers to search. As a result there will be timesheet entries of employees who have one of provided positions. Example: ["Developer", "Support"]
List of contract types names or identifiers to search. As a result there will be timesheet entries of employees who have one of contract type. Example: ["Full Time"]
curl -i -X POST \
-u <username>:<password> \
https://awesome-company.calamari.io/api/clockin/timesheetentries/v1/find \
-H 'Content-Type: application/json' \
-d '{
"from": "2018-10-01",
"to": "2018-10-01",
"teams": [
"string"
],
"positions": [
"string"
],
"contractTypes": [
"string"
],
"employees": [
"string"
]
}'successful operation
Date and time of timesheet entry finished. Has null value if employee does not clock out
Duration of timesheet entry in seconds. Has 0 value if employee does not clock out
List of breaks
Date and time when break was finished. Has null value if break was not finished
Duration of a break in seconds. Has null value if break was not finished.
List of projects
Date and time when employee finished working on project. Has null value if work on project was not finished
Duration of time spent on a project in seconds. Has null value if work on project was not finished
[ { "id": 0, "started": "2019-08-24T14:15:22Z", "finished": "2019-08-24T14:15:22Z", "startedTimeZone": { … }, "finishedTimeZone": { … }, "duration": 28800, "person": { … }, "breaks": [ … ], "projects": [ … ], "closed": true, "description": "string" } ]
curl -i -X POST \
-u <username>:<password> \
https://awesome-company.calamari.io/api/clockin/timesheetentries/v1/get-projects[ { "id": 0, "name": "Primary project" } ]
curl -i -X POST \
-u <username>:<password> \
https://awesome-company.calamari.io/api/clockin/timesheetentries/v1/get-projects-for-person \
-H 'Content-Type: application/json' \
-d '{
"person": "john.white@mycompany.com"
}'[ { "id": 0, "name": "Primary project" } ]
Update employee shift.
Expect error codes:
Employee identifier. You can use e-mail or external identifier in format (externalNumber:ABC123)
curl -i -X POST \
-u <username>:<password> \
https://awesome-company.calamari.io/api/clockin/timesheetentries/v1/update \
-H 'Content-Type: application/json' \
-d '{
"person": "john.white@mycompany.com",
"shiftStart": "2020-03-15T08:30:00",
"shiftEnd": "2020-03-15T16:30:00",
"breaks": [
{
"breakType": 1,
"breakStart": "2020-03-15T09:30:00",
"breakEnd": "2020-03-15T10:30:00"
}
],
"projects": [
{
"projectType": 1,
"projectStart": "2020-03-15T09:30:00",
"projectEnd": "2020-03-15T10:30:00"
}
],
"description": "string",
"id": 0
}'successful operation
Date and time of timesheet entry finished. Has null value if employee does not clock out
Duration of timesheet entry in seconds. Has 0 value if employee does not clock out
List of breaks
Date and time when break was finished. Has null value if break was not finished
Duration of a break in seconds. Has null value if break was not finished.
List of projects
Date and time when employee finished working on project. Has null value if work on project was not finished
Duration of time spent on a project in seconds. Has null value if work on project was not finished
{ "id": 0, "started": "2019-08-24T14:15:22Z", "finished": "2019-08-24T14:15:22Z", "startedTimeZone": { "displayName": "string", "id": "string", "dstsavings": 0, "rawOffset": 0 }, "finishedTimeZone": { "displayName": "string", "id": "string", "dstsavings": 0, "rawOffset": 0 }, "duration": 28800, "person": { "firstName": "John", "lastName": "Williams", "email": "john.williams@domain.com", "externalId": "A12Y" }, "breaks": [ { … } ], "projects": [ { … } ], "closed": true, "description": "string" }