Connecteam
connecteamConnecteam is a comprehensive workforce management platform designed to streamline operations, enhance communication, and improve HR processes for deskless teams.
Acciones disponibles (15)
Cada acción es una operación que el agente puede ejecutar contra este conector. Haz clic en una acción para ver sus parámetros.
Archive UsersCONNECTEAM_ARCHIVE_USERSAcciónTool to archive one or more users by their unique ids. use when you need to deactivate users without deleting their records.
CONNECTEAM_ARCHIVE_USERSAcciónTool to archive one or more users by their unique ids. use when you need to deactivate users without deleting their records.
Parámetros de entrada
userIdsinteger[]ObligatorioList of unique user IDs to archive.
Parámetros de salida
dataobjectObligatorioResponse data including operation success status.
errorstringError if any occurred during the execution of the action
requestIdstringObligatorioUnique identifier for this request.
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create UsersCONNECTEAM_CREATE_USERSAcciónTool to create multiple users in connecteam. use when you need to add several staff or admin accounts at once.
CONNECTEAM_CREATE_USERSAcciónTool to create multiple users in connecteam. use when you need to add several staff or admin accounts at once.
Parámetros de entrada
usersobject[]ObligatorioList of users to create in batch
Parámetros de salida
dataobjectObligatorioContainer for created user objects
errorstringError if any occurred during the execution of the action
requestIdstringObligatorioUnique request identifier
successfulbooleanObligatorioWhether or not the action execution was successful or not
Generate Upload URLCONNECTEAM_GENERATE_UPLOAD_URLAcciónTool to generate a pre-signed url for uploading a file. use when you need a secure, time-limited url prior to file upload.
CONNECTEAM_GENERATE_UPLOAD_URLAcciónTool to generate a pre-signed url for uploading a file. use when you need a secure, time-limited url prior to file upload.
Parámetros de entrada
fileNamestringObligatorioName of the file to be uploaded, e.g., 'document.pdf'
featureTypestringObligatorioApplication feature associated with the file, such as 'chat'
fileTypeHintstringOptional MIME type hint for the file, e.g., 'image/jpeg' or 'application/pdf'
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get ChatCONNECTEAM_GET_CHATAcciónTool to retrieve chat conversations. use when you need to list all team chats/channels after confirming your communications hub is on expert plan.
CONNECTEAM_GET_CHATAcciónTool to retrieve chat conversations. use when you need to list all team chats/channels after confirming your communications hub is on expert plan.
Parámetros de entrada
Sin parámetros.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Custom Field CategoriesCONNECTEAM_GET_CUSTOM_FIELD_CATEGORIESAcciónTool to retrieve all custom field categories. use when you need to list or filter custom field categories in your connecteam account.
CONNECTEAM_GET_CUSTOM_FIELD_CATEGORIESAcciónTool to retrieve all custom field categories. use when you need to list or filter custom field categories in your connecteam account.
Parámetros de entrada
limitintegerMaximum number of custom field categories to retrieve
namesstring[]List of custom field category names to filter results
categoryIdsinteger[]List of custom field category IDs to filter results
Parámetros de salida
dataobjectObligatorioResponse data including categories
errorstringError if any occurred during the execution of the action
pagingobjectObligatorioPagination details
requestIdstringObligatorioUnique identifier for the request
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Custom FieldsCONNECTEAM_GET_CUSTOM_FIELDSAcciónTool to retrieve all custom fields associated with the account. use when you need to filter, sort, or page through custom fields after authentication.
CONNECTEAM_GET_CUSTOM_FIELDSAcciónTool to retrieve all custom fields associated with the account. use when you need to filter, sort, or page through custom fields after authentication.
Parámetros de entrada
sortstringenumSort key: 'id', 'name', or 'type'
idnametypelimitintegerMaximum number of results per page (1-500)
orderstringenumSort order, only honored if 'sort' is set
ascdescoffsetintegerResource offset for pagination (>=0)
categoryIdsinteger[]Custom field category IDs to filter by
customFieldIdsinteger[]Custom field IDs to filter by
customFieldNamesstring[]Custom field names to filter by
customFieldTypesstring[]Custom field types to filter by
Parámetros de salida
dataobjectObligatorioResponse data payload
errorstringError if any occurred during the execution of the action
requestIdstringObligatorioUnique request identifier
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get FormsCONNECTEAM_GET_FORMSAcciónTool to retrieve all form definitions from connecteam. use when you need to list all existing forms after enabling the forms api.
CONNECTEAM_GET_FORMSAcciónTool to retrieve all form definitions from connecteam. use when you need to list all existing forms after enabling the forms api.
Parámetros de entrada
Sin parámetros.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get JobsCONNECTEAM_GET_JOBSAcciónTool to retrieve a list of job objects relevant to a specific instance id. use after confirming scheduler or time clock instance id when you need to filter and page through jobs.
CONNECTEAM_GET_JOBSAcciónTool to retrieve a list of job objects relevant to a specific instance id. use after confirming scheduler or time clock instance id when you need to filter and page through jobs.
Parámetros de entrada
sortstringSort key for ordering results. Currently only 'name' is supported.
limitintegerMaximum number of records to return per page.
orderstringenumSort direction. Defaults to ascending.
ascdescjobIdsstring[]List of job IDs to filter by. Includes nested sub-jobs under each parent.
offsetintegerNumber of records to skip before starting to collect the result set.
jobCodesstring[]List of job codes to filter by. Returns matching sub-jobs and their parents.
jobNamesstring[]List of job names to filter by. Returns matching sub-jobs and their parents.
instanceIdsstring[]List of instance IDs (scheduler or time clock) to filter by. Only one allowed.
includeDeletedbooleanWhether to include deleted jobs in the response. Defaults to true.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Performance IndicatorsCONNECTEAM_GET_PERFORMANCE_INDICATORSAcciónTool to retrieve the list of performance metric indicators. use when you need to list available performance indicators for data analysis. examples: "list performance metrics".
CONNECTEAM_GET_PERFORMANCE_INDICATORSAcciónTool to retrieve the list of performance metric indicators. use when you need to list available performance indicators for data analysis. examples: "list performance metrics".
Parámetros de entrada
limitintegerMaximum number of performance indicators to return per page (1-100, default is 10)
offsetintegerResource offset for pagination (>=0, default is 0)
Parámetros de salida
dataobjectObligatorioResponse data payload with indicators and paging
errorstringError if any occurred during the execution of the action
requestIdstringUnique request identifier, if returned by the API
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Policy TypesCONNECTEAM_GET_POLICY_TYPESAcciónTool to retrieve available time-off policy types. use before filtering or creating time-off requests by policytypeid.
CONNECTEAM_GET_POLICY_TYPESAcciónTool to retrieve available time-off policy types. use before filtering or creating time-off requests by policytypeid.
Parámetros de entrada
Sin parámetros.
Parámetros de salida
dataobjectObligatorioContainer for policy types list
errorstringError if any occurred during the execution of the action
requestIdstringObligatorioInternal request identifier returned by Connecteam
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get PublishersCONNECTEAM_GET_PUBLISHERSAcciónTool to retrieve a list of all custom publishers. use when you need to list custom publishers after confirming api access.
CONNECTEAM_GET_PUBLISHERSAcciónTool to retrieve a list of all custom publishers. use when you need to list custom publishers after confirming api access.
Parámetros de entrada
limitintegerMaximum number of publishers to return per page (1-100).
offsetintegerOffset for pagination; the number of items to skip.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get SchedulersCONNECTEAM_GET_SCHEDULERSAcciónTool to retrieve a list of job schedulers associated with the account. use after authentication when you need to enumerate all schedulers.
CONNECTEAM_GET_SCHEDULERSAcciónTool to retrieve a list of job schedulers associated with the account. use after authentication when you need to enumerate all schedulers.
Parámetros de entrada
Sin parámetros.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Smart GroupsCONNECTEAM_GET_SMART_GROUPSAcciónTool to retrieve all smart groups associated with the account. use when you need to list all smart groups after authenticating with a valid api key.
CONNECTEAM_GET_SMART_GROUPSAcciónTool to retrieve all smart groups associated with the account. use when you need to list all smart groups after authenticating with a valid api key.
Parámetros de entrada
Sin parámetros.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Task BoardsCONNECTEAM_GET_TASK_BOARDSAcciónTool to retrieve all task boards. use after authenticating with a valid api key to list available task boards.
CONNECTEAM_GET_TASK_BOARDSAcciónTool to retrieve all task boards. use after authenticating with a valid api key to list available task boards.
Parámetros de entrada
Sin parámetros.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get UsersCONNECTEAM_GET_USERSAcciónTool to retrieve a list of all users associated with your account. use when you need to fetch and filter user data.
CONNECTEAM_GET_USERSAcciónTool to retrieve a list of all users associated with your account. use when you need to fetch and filter user data.
Parámetros de entrada
sortstringSorting criteria (e.g., creation time)
limitintegerMaximum number of results per page (1 to 500, default is 10)
orderstringenumOrder of results. Defaults to ascending.
ascdescoffsetintegerResource offset for pagination (>= 0, default is 0)
userIdsinteger[]List of user IDs to filter results
createdAtintegerFilter users created after a specific Unix timestamp
fullNamesstring[]Filter by exact full names
modifiedAtintegerFilter users modified after a specific Unix timestamp
userStatusstringFilter users by status (e.g., 'active')
phoneNumbersstring[]Filter by phone numbers in E.164 format (e.g., +1234567890)
emailAddressesstring[]Filter by email addresses
Parámetros de salida
dataobjectObligatorioResponse data including users and paging
errorstringError if any occurred during the execution of the action
requestIdstringObligatorioUnique identifier for the request
successfulbooleanObligatorioWhether or not the action execution was successful or not