Connecteam

Connecteam

This connector reads and updates Connecteam, the app for deskless teams, through its REST API: users and their custom fields, the time clock (clocked shifts, breaks, timesheet totals, clock in and out), the job scheduler (shifts), jobs, forms and submissions, quick tasks, time off and chat messages.

Personal data: users carry names, phone numbers, emails and custom profile fields (birthday, address, IDs); time activities can carry GPS positions. Read only what the task needs.

Setup (2 minutes, needs an owner or admin)

1. In Connecteam open Settings > API Keys and click Add API key. Copy the key into CONNECTEAM_API_KEY; it gives access to the whole account, treat it like a password.
2. Set CONNECTEAM_API_HOST to https://api.connecteam.com, or to https://api-au.connecteam.com if you sign in at app-au.connecteam.com (Australian accounts).
3. API access needs the Expert plan or higher, per hub: Operations (time clock, scheduler, jobs, tasks), Communications (chat), HR & Skills (time off). Users, account and publishers work with any eligible hub. connecteam_get_account is the install check.

Ids first: every time clock, scheduler and task board is its own app instance. Get their ids with connecteam_list_time_clocks, connecteam_list_schedulers and connecteam_list_task_boards before calling the tools that need timeClockId, schedulerId or taskBoardId.

Workflow

• Account and people: connecteam_get_account, connecteam_list_users (filter by ids, names, emails, phones, status, change time), connecteam_list_custom_fields, connecteam_list_custom_field_categories, connecteam_list_smart_groups.
• Time clock: connecteam_list_time_activities (clocked shifts, manual breaks and time off per user, at most 92 days per call) and connecteam_get_timesheet_totals (hours per user and day with approval state). Live punching: connecteam_clock_in, connecteam_clock_out. Corrections: connecteam_create_time_activities, connecteam_update_time_activities.
• Scheduling: connecteam_list_shifts (time range in Unix seconds), connecteam_get_shift, connecteam_list_shift_custom_fields, connecteam_list_user_unavailabilities. Plan with connecteam_create_shifts and connecteam_update_shifts; set isPublished true and notifyUsers true to tell the staff.
• Jobs: connecteam_list_jobs, connecteam_get_job, connecteam_list_job_custom_fields, connecteam_create_jobs, connecteam_update_job.
• Forms: connecteam_list_forms, connecteam_get_form (questions), connecteam_list_form_submissions, connecteam_get_form_submission.
• Tasks: connecteam_list_tasks, connecteam_list_task_labels, connecteam_create_task, connecteam_update_task (send userIds, status and title every time; status completed closes it).
• Time off: connecteam_list_time_off_policy_types, connecteam_list_time_off_balances, connecteam_list_time_off_requests (approved only unless you pass statuses), connecteam_create_time_off_request, connecteam_update_time_off_request (approve or deny with status).
• Users: connecteam_create_users, connecteam_update_users, connecteam_archive_users (reversible: update with isArchived false), connecteam_create_user_note.
• Chat: connecteam_list_conversations and connecteam_list_publishers, then connecteam_send_message to a conversation or connecteam_send_private_message to one user, with a publisher id as senderId. Messages are delivered at once.

Switched off at install: connecteam_delete_user, connecteam_delete_shift and connecteam_delete_task; they cannot be undone, so an admin switches them on when the team needs them.

Reading the answers

• Answers are { "requestId": "...", "data": {...}, "paging": { "offset": n } }.
• Shift, clock and task times are Unix timestamps in seconds with a separate IANA timezone; dates in filters are YYYY-MM-DD. User ids are integers; shift, job, task and request ids are strings.
• Batch writes (connecteam_create_users, connecteam_create_shifts, connecteam_create_jobs and the updates) take a list and answer per item.

Paging: limit (default 10; the maximum is in each tool, up to 500) and offset. Raise offset by limit until a page returns fewer items than limit.

Limits and errors: rate limits are per account and plan (Expert 100 per minute and 10,000 per day) and answer 429. 401 or 403 means a wrong key, the wrong API address (global versus Australian) or a plan or hub without API access, 404 an unknown id, 422 a validation error (the body names the field); locked or approved timesheet days refuse time activity changes.