Credentials
Create a credential in the node settings. Connecteam requires an Expert plan or higher for API access; each API area also depends on its hub subscription.API key
In Connecteam, open Settings → API Keys → Add API key. Paste the key into the NoClick credential. Connecteam authentication guide.OAuth client credentials
In Connecteam, open Your Name → Integration Center → OAuth 2.0, create an app, select the scopes you need, and copy its client ID and secret. Enter both in the NoClick credential. NoClick obtains a bearer token and renews it before expiry. This is a server-to-server client credentials grant, so there is no interactive sign-in button. OAuth setup. Choose Australia for accounts that sign in atapp-au.connecteam.com; the node then uses the Australian API host. Region guide.
Working with operations
The node accepts JSON text for request bodies, including arrays where the endpoint expects a list. Optional query fields are omitted when blank. Responses includestatus, action, data, and request timing. API errors include the HTTP status code and response body.
Connecteam supports pagination with limit and offset on applicable endpoints. Its rate limits depend on the plan.
Connecteam also publishes incoming webhook events. This node includes the webhook settings API operations; receiving those events uses a separate webhook trigger.
Operations (154)
Account (1)
| Operation | ID | Method | Reference |
|---|---|---|---|
| Get account information | get_account_information_me_get | GET | API reference |
Assets (1)
| Operation | ID | Method | Reference |
|---|---|---|---|
| Get asset metadata | get_metadata_per_asset_assets_v1_asset__assetId__get | GET | API reference |
Attachments (4)
| Operation | ID | Method | Reference |
|---|---|---|---|
| Generate upload url | generate_upload_url_attachments_v1_files_generate_upload_url_post | POST | API reference |
| Finalize upload | finalize_upload_attachments_v1_files_complete_upload__fileId__put | PUT | API reference |
| Get file metadata | get_file_url_attachments_v1_files__fileId__get | GET | API reference |
| Generate download URL | generate_download_url_attachments_v1_files_download_url_post | POST | API reference |
Breadcrumbs (3)
| Operation | ID | Method | Reference |
|---|---|---|---|
| Download breadcrumbs report | download_breadcrumbs_report_time_clock_breadcrumbs_v1_report__fileId__download_get | GET | API reference |
| Get breadcrumbs report status | get_report_status_time_clock_breadcrumbs_v1_report__fileId__get | GET | API reference |
| Generate breadcrumbs report | generate_breadcrumbs_report_time_clock_breadcrumbs_v1_report_post | POST | API reference |
Chat (4)
| Operation | ID | Method | Reference |
|---|---|---|---|
| Get conversations | get_conversations_chat_v1_conversations_get | GET | API reference |
| Create conversation | create_conversation_chat_v1_conversations_post | POST | API reference |
| Send message | send_message_to_conversation_chat_v1_conversations__conversationId__message_post | POST | API reference |
| Send private message | send_message_to_private_conversation_chat_v1_conversations_privateMessage__userId__post | POST | API reference |
Company Policies (18)
| Operation | ID | Method | Reference |
|---|---|---|---|
| Get scheduling rule policies | get_scheduling_rule_policies_company_policies_v1_scheduling_rule_policies_get | GET | API reference |
| Get user scheduling rule policies | get_user_scheduling_rule_policies_company_policies_v1_users__userId__scheduling_rule_policies_get | GET | API reference |
| List scheduling rule policy assignments | list_assignments_company_policies_v1_scheduling_rule_policies__schedulingRulePolicyId__assignments_get | GET | API reference |
| Delete scheduling rule policy | delete_scheduling_rule_policy_company_policies_v1_scheduling_rule_policies__schedulingRulePolicyId__delete | DELETE | API reference |
| Assign users to scheduling rule policy | assign_users_to_policy_company_policies_v1_scheduling_rule_policies__schedulingRulePolicyId__assignments_put | PUT | API reference |
| Get working hours policies | get_working_hours_policies_company_policies_v1_working_hours_policies_get | GET | API reference |
| Get user working hours | get_user_working_hours_company_policies_v1_users__userId__working_hours_get | GET | API reference |
| Assign users to working hours policy | assign_users_to_policy_company_policies_v1_working_hours_policies__workingHoursPolicyId__assignments_put | PUT | API reference |
| Set user custom working hours | set_user_custom_working_hours_company_policies_v1_users__userId__working_hours_put | PUT | API reference |
| Delete user custom working hours | delete_user_custom_working_hours_company_policies_v1_users__userId__working_hours_delete | DELETE | API reference |
| Unassign user from working hours policy | unassign_user_from_policy_company_policies_v1_working_hours_policies__workingHoursPolicyId__assignments__userId__delete | DELETE | API reference |
| List pay rule policy assignments | list_assignments_company_policies_v1_pay_rule_policies__payRulePolicyId__assignments_get | GET | API reference |
| Get company pay rules | get_pay_rules_company_policies_v1_pay_rules_get | GET | API reference |
| Get company pay rule policies | get_pay_rule_policies_company_policies_v1_pay_rule_policies_get | GET | API reference |
| Add pay rule to pay rule policy | add_pay_rule_to_policy_company_policies_v1_pay_rule_policies__payRulePolicyId__pay_rules__payRuleId__put | PUT | API reference |
| Assign user to pay rule policy | assign_user_to_policy_company_policies_v1_pay_rule_policies__payRulePolicyId__assignments_put | PUT | API reference |
| Remove pay rule policy assignment | delete_assignment_company_policies_v1_pay_rule_policies__payRulePolicyId__assignments__assignmentId__delete | DELETE | API reference |
| Remove pay rule from pay rule policy | remove_pay_rule_from_policy_company_policies_v1_pay_rule_policies__payRulePolicyId__pay_rules__payRuleId__delete | DELETE | API reference |
DailyNote (4)
| Operation | ID | Method | Reference |
|---|---|---|---|
| Get note | get_note_daily_info_v1_daily_note__noteId__get | GET | API reference |
| Create daily note | create_note_daily_info_v1_daily_notes_post | POST | API reference |
| Update note | update_note_daily_info_v1_daily_note__noteId__put | PUT | API reference |
| Delete note | delete_note_daily_info_v1_daily_note__noteId__delete | DELETE | API reference |
Forms (9)
| Operation | ID | Method | Reference |
|---|---|---|---|
| Get form | get_form_forms_v1_forms__formId__get | GET | API reference |
| Get form submissions | get_form_submissions_forms_v1_forms__formId__form_submissions_get | GET | API reference |
| Get forms | get_forms_forms_v1_forms_get | GET | API reference |
| Get form submission | get_form_submission_forms_v1_forms__formId__form_submissions__formSubmissionId__get | GET | API reference |
| Update form submission | update_form_submissions_forms_v1_forms__formId__form_submissions__formSubmissionId__put | PUT | API reference |
| Add dropdown options | add_dropdown_options_forms_v1_forms__formId__questions__questionId__post | POST | API reference |
| Get dropdown question options | get_dropdown_question_options_forms_v1_forms__formId__questions__questionId__get | GET | API reference |
| Update dropdown option | update_dropdown_options_forms_v1_forms__formId__questions__questionId__options__optionId__put | PUT | API reference |
| Delete dropdown option | delete_dropdown_option_forms_v1_forms__formId__questions__questionId__options__optionId__delete | DELETE | API reference |
Jobs (6)
| Operation | ID | Method | Reference |
|---|---|---|---|
| Get jobs | get_jobs_jobs_v1_jobs_get | GET | API reference |
| Get job | get_job_jobs_v1_jobs__jobId__get | GET | API reference |
| Create jobs | create_jobs_jobs_v1_jobs_post | POST | API reference |
| Update job | update_job_jobs_v1_jobs__jobId__put | PUT | API reference |
| Delete job | delete_job_jobs_v1_jobs__jobId__delete | DELETE | API reference |
| Get resource custom fields | get_resource_custom_fields_jobs_v1_custom_fields_get | GET | API reference |
Onboarding (3)
| Operation | ID | Method | Reference |
|---|---|---|---|
| Get onboarding packs | get_packs_onboarding_v1_packs_get | GET | API reference |
| Get pack assignments | get_pack_assignments_onboarding_v1_packs__packId__assignments_get | GET | API reference |
| Assign users to pack | create_pack_assignments_onboarding_v1_packs__packId__assignments_post | POST | API reference |
Pay Rates (3)
| Operation | ID | Method | Reference |
|---|---|---|---|
| Set pay rates | set_pay_rates_pay_rates_v1_pay_rates_put | PUT | API reference |
| Get pay rates | get_pay_rates_pay_rates_v1_pay_rates_get | GET | API reference |
| Delete pay rate | delete_pay_rate_pay_rates_v1_pay_rates_users__userId___effectiveDate__delete | DELETE | API reference |
Publishers (1)
| Operation | ID | Method | Reference |
|---|---|---|---|
| Get publishers | get_publishers_publishers_v1_publishers_get | GET | API reference |
Sales (7)
| Operation | ID | Method | Reference |
|---|---|---|---|
| Get daily sales | get_daily_sales_sales_v1_daily_sales_get | GET | API reference |
| Get locations | get_locations_sales_v1_locations_get | GET | API reference |
| Create transactions | create_transactions_sales_v1_transactions_post | POST | API reference |
| Create location | create_location_sales_v1_locations_post | POST | API reference |
| Set projected sales | update_projected_sales_sales_v1_locations__locationId__daily_sales_put | PUT | API reference |
| Delete transaction | delete_transaction_sales_v1_transactions__transactionId__delete | DELETE | API reference |
| Delete transactions | delete_transactions_by_period_sales_v1_transactions_delete | DELETE | API reference |
Schedule (25)
| Operation | ID | Method | Reference |
|---|---|---|---|
| Get schedulers | get_schedulers_scheduler_v1_schedulers_get | GET | API reference |
| Get user unavailabilities | get_unavailabilities_scheduler_v1_schedulers_user_unavailability_get | GET | API reference |
| Get shifts | get_shifts_scheduler_v1_schedulers__schedulerId__shifts_get | GET | API reference |
| Get shift | get_shift_by_id_scheduler_v1_schedulers__schedulerId__shifts__shiftId__get | GET | API reference |
| Delete shifts | delete_shifts_by_ids_scheduler_v1_schedulers__schedulerId__shifts_delete | DELETE | API reference |
| Create shifts | create_shifts_scheduler_v1_schedulers__schedulerId__shifts_post | POST | API reference |
| Update shifts | update_shifts_scheduler_v1_schedulers__schedulerId__shifts_put | PUT | API reference |
| Delete shift | delete_shift_by_id_scheduler_v1_schedulers__schedulerId__shifts__shiftId__delete | DELETE | API reference |
| Get user unavailabilities | get_unavailabilities_scheduler_v2_schedulers_user_unavailability_get | GET | API reference |
| Get auto-assign status | get_autofill_status_scheduler_v2_schedulers__schedulerId__shifts_auto_assign__autoAssignRequestId__get | GET | API reference |
| Get shifts | get_shifts_scheduler_v2_schedulers__schedulerId__shifts_get | GET | API reference |
| Get shift | get_shift_by_id_scheduler_v2_schedulers__schedulerId__shifts__shiftId__get | GET | API reference |
| Create auto-assign request | create_autofill_request_scheduler_v2_schedulers__schedulerId__shifts_auto_assign_post | POST | API reference |
| Create shifts | create_shifts_scheduler_v2_schedulers__schedulerId__shifts_post | POST | API reference |
| Update shifts | update_shifts_scheduler_v2_schedulers__schedulerId__shifts_put | PUT | API reference |
| Delete shifts | delete_shifts_by_ids_scheduler_v2_schedulers__schedulerId__shifts_delete | DELETE | API reference |
| Delete shift | delete_shift_by_id_scheduler_v2_schedulers__schedulerId__shifts__shiftId__delete | DELETE | API reference |
| Get shift custom fields | get_shift_custom_fields_scheduler_v1_schedulers__schedulerId__custom_fields_get | GET | API reference |
| Create schedule unavailability | create_scheduler_unavailability_scheduler_v1_schedulers__schedulerId__unavailability_post | POST | API reference |
| Get schedule unavailabilities | get_unavailabilities_scheduler_v1_schedulers__schedulerId__unavailabilities_get | GET | API reference |
| Delete schedule unavailability | delete_scheduler_unavailability_scheduler_v1_schedulers__schedulerId__unavailability__unavailabilityId__delete | DELETE | API reference |
| Create auto-assign request | create_autofill_request_scheduler_v1_schedulers__schedulerId__shifts_auto_assign_post | POST | API reference |
| Get auto-assign status | get_autofill_status_scheduler_v1_schedulers__schedulerId__shifts_auto_assign__autoAssignRequestId__get | GET | API reference |
| Get shift layers | get_shift_layers_scheduler_v1_schedulers__schedulerId__shift_layers_get | GET | API reference |
| Get shift layer values | get_shift_layer_values_scheduler_v1_schedulers__schedulerId__shift_layers__layerId__values_get | GET | API reference |
Settings (5)
| Operation | ID | Method | Reference |
|---|---|---|---|
| Get webhook | get_webhook_settings_v1_webhooks__webhookId__get | GET | API reference |
| Update Webhook | update_webhook_settings_v1_webhooks__webhookId__put | PUT | API reference |
| Delete webhook | delete_webhook_settings_v1_webhooks__webhookId__delete | DELETE | API reference |
| Get webhooks | get_webhooks_by_type_settings_v1_webhooks_get | GET | API reference |
| Create webhook | create_webhook_settings_v1_webhooks_post | POST | API reference |
Tasks (10)
| Operation | ID | Method | Reference |
|---|---|---|---|
| Get task boards | get_tasks_boards_tasks_v1_taskboards_get | GET | API reference |
| Get task labels | get_task_labels_tasks_v1_taskboards__taskBoardId__labels_get | GET | API reference |
| Update task | update_task_tasks_v1_taskboards__taskBoardId__tasks__taskId__put | PUT | API reference |
| Delete task | delete_task_tasks_v1_taskboards__taskBoardId__tasks__taskId__delete | DELETE | API reference |
| Get tasks | get_tasks_tasks_v1_taskboards__taskBoardId__tasks_get | GET | API reference |
| Create task | create_task_tasks_v1_taskboards__taskBoardId__tasks_post | POST | API reference |
| Create sub-task | create_subtask_tasks_v1_taskboards__taskBoardId__tasks__taskId__sub_tasks_post | POST | API reference |
| Get sub-tasks | get_subtasks_tasks_v1_taskboards__taskBoardId__tasks__taskId__sub_tasks_get | GET | API reference |
| Update sub-task | update_subtask_tasks_v1_taskboards__taskBoardId__tasks__taskId__sub_tasks__subTaskId__put | PUT | API reference |
| Delete sub-task | delete_subtask_tasks_v1_taskboards__taskBoardId__tasks__taskId__sub_tasks__subTaskId__delete | DELETE | API reference |
Time Clock (17)
| Operation | ID | Method | Reference |
|---|---|---|---|
| Get timesheet totals | get_timesheet_total_hours_time_clock_v1_time_clocks__timeClockId__timesheet_get | GET | API reference |
| Get time clocks | get_time_clocks_time_clock_v1_time_clocks_get | GET | API reference |
| Get time activities | get_time_activities_time_clock_v1_time_clocks__timeClockId__time_activities_get | GET | API reference |
| Get shift attachments | get_shift_attachments_time_clock_v1_time_clocks__timeClockId__shift_attachments_get | GET | API reference |
| Get manual breaks | get_manual_breaks_time_clock_v1_time_clocks__timeClockId__manual_breaks_get | GET | API reference |
| Clock in | clock_user_in_time_clock_v1_time_clocks__timeClockId__clock_in_post | POST | API reference |
| Clock out | clock_user_out_time_clock_v1_time_clocks__timeClockId__clock_out_post | POST | API reference |
| Update time activities | update_time_activities_time_clock_v1_time_clocks__timeClockId__time_activities_put | PUT | API reference |
| Create time activities | create_time_activities_time_clock_v1_time_clocks__timeClockId__time_activities_post | POST | API reference |
| Update user lock days | update_user_lock_days_time_clock_v1_time_clocks__timeClockId__users__userId__lock_days_put | PUT | API reference |
| Delete time activity | delete_time_activity_time_clock_v1_time_clocks__timeClockId__time_activities__timeActivityId__delete | DELETE | API reference |
| Get geofences | get_geofences_time_clock_v1_time_clocks__timeClockId__geofences_get | GET | API reference |
| Create geofences | create_geofences_time_clock_v1_time_clocks__timeClockId__geofences_post | POST | API reference |
| Get geofence | get_geofence_time_clock_v1_time_clocks__timeClockId__geofences__fenceId__get | GET | API reference |
| Delete geofence | delete_geo_fence_time_clock_v1_time_clocks__timeClockId__geofences__fenceId__delete | DELETE | API reference |
| Clock out from a manual break | clock_out_manual_break_time_clock_v1_time_clocks__timeClockId__manual_breaks_clock_out_post | POST | API reference |
| Clock in to a manual break | clock_in_manual_break_time_clock_v1_time_clocks__timeClockId__manual_breaks__manualBreakId__clock_in_post | POST | API reference |
Time Off (7)
| Operation | ID | Method | Reference |
|---|---|---|---|
| Get policy types | get_policy_groups_time_off_v1_policy_types_get | GET | API reference |
| Get user balances | get_balances_time_off_v1_policy_types__policyTypeId__balances_get | GET | API reference |
| Get time off requests | list_time_off_requests_time_off_v1_requests_get | GET | API reference |
| Create time off request | post_time_off_request_time_off_v1_requests_post | POST | API reference |
| Update time off request | put_time_off_request_time_off_v1_requests__requestId__put | PUT | API reference |
| Update user balance | put_user_balance_time_off_v1_policy_types__policyTypeId__balances__userId__put | PUT | API reference |
| Assign user to time-off policy | assign_user_to_policy_time_off_v1_time_off_policies__timeOffPolicyId__assignments_put | PUT | API reference |
Users (26)
| Operation | ID | Method | Reference |
|---|---|---|---|
| Get users | get_users_users_v1_users_get | GET | API reference |
| Update users | edit_users_users_v1_users_put | PUT | API reference |
| Create users | create_users_users_v1_users_post | POST | API reference |
| Archive users | archive_users_users_v1_users_delete | DELETE | API reference |
| Delete user | delete_user_users_v1_users__userId__delete | DELETE | API reference |
| Get custom fields | get_custom_fields_users_v1_custom_fields_get | GET | API reference |
| Get custom field categories | get_custom_fields_users_v1_custom_field_categories_get | GET | API reference |
| Update custom fields | update_custom_fields_users_v1_custom_fields_put | PUT | API reference |
| Create custom fields | create_custom_fields_users_v1_custom_fields_post | POST | API reference |
| Delete custom fields | delete_custom_fields_users_v1_custom_fields_delete | DELETE | API reference |
| Get custom field options | get_custom_field_options_users_v1_custom_fields__customFieldId__options_get | GET | API reference |
| Create custom field option | create_custom_field_option_users_v1_custom_fields__customFieldId__options_post | POST | API reference |
| Update custom field option | edit_custom_field_option_users_v1_custom_fields__customFieldId__options__optionId__put | PUT | API reference |
| Delete custom field option | delete_custom_field_option_users_v1_custom_fields__customFieldId__options__optionId__delete | DELETE | API reference |
| Create smart group segment | create_smart_group_segment_users_v1_smart_group_segments_post | POST | API reference |
| Create smart group | create_smart_group_users_v1_smart_groups_post | POST | API reference |
| Get smart groups | get_smart_groups_users_v1_smart_groups_get | GET | API reference |
| Get smart group segments | get_smart_group_segments_users_v1_smart_group_segments_get | GET | API reference |
| Update smart group | update_smart_group_users_v1_smart_groups__smartGroupId__put | PUT | API reference |
| Delete smart group | delete_smart_group_users_v1_smart_groups__smartGroupId__delete | DELETE | API reference |
| Promote to admin | invite_admin_users_v1_admins_post | POST | API reference |
| Create user note | create_note_users_v1_users__userId__notes_post | POST | API reference |
| Upload a payslip | create_payslip_users_v1_users__userId__payslips_post | POST | API reference |
| Update performance data | update_performance_users_v1_users__userId__performance__date__put | PUT | API reference |
| Get indicators | get_indicators_users_v1_performance_indicators_get | GET | API reference |
| Get user assignments | get_user_assignments_users_v1_users__userId__assignments_get | GET | API reference |