ConnectCloud HR API
Employees, roles and groups, absences and vacation accounts, working time, travel expenses and the organisation chart. Also issues the access tokens for every other API.
The interactive reference needs JavaScript. Every operation also has its own page:
Configuration
Employees
Access
Absences
Working time
GET /employees/{id}/schedules Working-time models of an employee, oldest first (hr:read, the person themself, or their managers and deputies)POST /employees/{id}/schedules Save the working-time model valid from a date (hr:write)DELETE /employees/{id}/schedules/{scheduleId} Remove a working-time model (hr:write)POST /employees/{id}/time-adjustments Correct a time account, e.g. opening balance or payout (hr:time:manage, or the person's managers and deputies)GET /time-entries Time entries of an employee (own, or any with hr:time:manage)POST /time-entries Book working time manuallyDELETE /time-entries/{id} Delete an entry (kept in the change history)PATCH /time-entries/{id} Correct an entryGET /time-entries/{id}/history Change history of an entryPOST /time-stamps Add one stamp (Kommen, Pause, Pause beenden, Gehen) to a day (own, or the team's with responsibility or hr:time:manage)GET /timesheet An employee's month with target, actual, breaks, absences, ArbZG warnings and time accountGET /attendance/status Today's attendance of the signed-in userPOST /attendance/{action} Clock in/out or start/end a break for the signed-in userGET /time-accounts Monthly overview (hr:time:manage for everybody, managers for their team)POST /time-periods/close Close a past month (hr:time:manage, or managers for their team)POST /time-periods/reopen Reopen a closed month of the given employees (hr:time:manage, or managers for their team)GET /time-export Export a month as CSV for payroll (hr:time:manage)
Travel expenses
Work entries
GET /work-entries Work entries of an employee (tenant:access – own; a team member's as line manager or deputy; anyone's with hr:work:manage)POST /work-entries Book own work (tenant:access and an active employee record)GET /work-entries/{id} One work entry (tenant:access – own; a team member's as line manager or deputy; anyone's with hr:work:manage)PUT /work-entries/{id} Change an own entry (tenant:access)DELETE /work-entries/{id} Delete an own entry (tenant:access)GET /work-entries/summary The caller's booked, billable and internal minutes of a day (tenant:access)GET /work-entries/approvals Entries the caller may approve (line managers and deputies for their team, hr:work:manage for everyone)GET /work-entries/stopwatch The caller's running stopwatch (tenant:access)POST /work-entries/stopwatch Start the caller's stopwatch (tenant:access)DELETE /work-entries/stopwatch Stop or discard the caller's stopwatch (tenant:access)POST /work-entries/approve Approve confirmed entries (line managers and deputies for their team, hr:work:manage for everyone)POST /work-entries/unapprove Take approvals back (line managers and deputies for their team, hr:work:manage for everyone)POST /work-entries/{id}/corrections Correct an approved or billed entry (its owner, line manager or deputy, or hr:work:manage)GET /employees/{id}/work-entries Work entries of a team member (line managers and deputies, hr:work:manage)GET /my-day The caller's day – attendance, work entries, totals and what is not booked yet (tenant:access)GET /calendar A person's calendar – attendance, work, absences, calls (tenant:access)GET /calendar/shares Whom I share my calendar with and who shares theirs with me (tenant:access)GET /calendar/shares/candidates Search colleagues to share my calendar with (tenant:access)PUT /calendar/shares/{employeeId} Share my calendar with a colleague (tenant:access)DELETE /calendar/shares/{employeeId} Stop sharing my calendar with a colleague (tenant:access)GET /employees/{id}/my-day A team member's day (line managers and deputies, hr:work:manage)GET /work-entry-settings Work kinds, billing types and the tenant's work rules (tenant:access or hr:work:manage)PUT /work-entry-settings Save the work settings (hr:work:manage)GET /work-contracts A customer's active contracts for the booking form (tenant:access)
Work billing
Recruiting
GET /recruiting/bootstrap Stages, application forms and what the caller may do (hr:recruiting:* or named on a posting)PUT /recruiting/settings Save retention, consent and the applicant mailbox (hr:recruiting:manage)PUT /recruiting/stages Replace the pipeline (hr:recruiting:manage)POST /recruiting/form-templates Create an application form (hr:recruiting:manage)PUT /recruiting/form-templates/{id} Change or archive an application form (hr:recruiting:manage)GET /recruiting/postings Job postings the caller sees (tenant:access; hr:recruiting:* sees all, others the postings they are named on)POST /recruiting/postings Create a draft posting (hr:recruiting:manage)GET /recruiting/postings/{id} One posting with the caller's role (its access list for managers of the posting)DELETE /recruiting/postings/{id} Delete a draft without applications (hr:recruiting:manage)PATCH /recruiting/postings/{id} Change a posting (managers of the posting; not when archived)POST /recruiting/postings/{id}/{action} Publish, close, archive or reopen a posting (managers of the posting)PUT /recruiting/postings/{id}/access Replace who works on a posting (managers of the posting)GET /recruiting/postings/{id}/form The questions of a posting (its form template's, then its own)GET /recruiting/applications Applications to the postings the caller seesPOST /recruiting/applications Enter an application by hand (managers of the posting)GET /recruiting/applications/{id} One application with its files and ratingPATCH /recruiting/applications/{id} Change the applicant's data (managers of the posting)POST /recruiting/applications/{id}/move Move an application to a stage of the open phases, or reopen a rejected or withdrawn one (managers of the posting)POST /recruiting/applications/{id}/reject Reject an application, optionally with a mail to the applicant (managers of the posting)POST /recruiting/applications/{id}/withdraw Record that the applicant withdrew (managers of the posting)GET /recruiting/applications/{id}/hire Employee data pre-filled from an application (managers of the posting)POST /recruiting/applications/{id}/hire Complete a hire with the employee created from the application (managers of the posting)GET /recruiting/applications/{id}/history What happened to an applicationPOST /recruiting/applications/{id}/files Add a file to an application (managers of the posting)DELETE /recruiting/applications/{id}/files/{fileId} Remove a file from an application (managers of the posting)GET /recruiting/applications/{id}/files/{fileId}/content The content of a file the malware scan clearedGET /recruiting/applications/{id}/notes Internal notes of an application (reviewers and managers of the posting)POST /recruiting/applications/{id}/notes Add an internal note (reviewers and managers of the posting)DELETE /recruiting/applications/{id}/notes/{noteId} Delete one of the caller's own notesGET /recruiting/applications/{id}/ratings The reviewers' ratings of an application (reviewers and managers of the posting)GET /recruiting/applications/{id}/mail-draft The default text of a mail to the applicant (managers of the posting)GET /recruiting/applications/{id}/messages The mail conversation with the applicantPOST /recruiting/applications/{id}/messages Mail the applicant from the recruiting mailbox (managers of the posting)GET /recruiting/applications/{id}/interviews Interviews of an application (reviewers and managers of the posting)POST /recruiting/applications/{id}/interviews Schedule an interview of an open application (managers of the posting)POST /recruiting/applications/{id}/interviews/{interviewId}/{action} Reschedule or cancel an interview (managers of the posting)GET /recruiting/interviews/mine Upcoming interviews the caller takes part inGET /recruiting/people Active employees by name or e-mail for access lists, contacts and interviewers (hr:recruiting:manage or managers of a posting)GET /recruiting/unmatched-mail Received mail of the recruiting mailbox no application claimed (hr:recruiting:manage)POST /recruiting/unmatched-mail/{mailId} File an unmatched mail on an application, or drop it without applicationId (hr:recruiting:manage)
Careers
Organisation
Auth