NagentArtefacts
Dev & Technology
Enterprise and White Glove
Company
Connecteam connects to a Nagent workspace with an API key. Once it is connected, agents can call 16 Connecteam actions, such as "Create Users", "Get Chat" and "Get Custom Field Categories". Nothing is enabled on connect: each action is allowed one at a time, and an action with side effects runs or waits for a person according to the agent's level.
Every operation an agent can call against Connecteam, with input parameters and output schema.
CONNECTEAM_ARCHIVE_USERSTool to archive one or more users by their unique IDs. Use when you need to deactivate users without deleting their records.
Input parameters
List of unique user IDs to archive.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
CONNECTEAM_CREATE_USERSTool to create multiple users in Connecteam. Use when you need to add several staff or admin accounts at once.
Input parameters
List of users to create in batch
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
CONNECTEAM_GENERATE_UPLOAD_URLTool to generate a pre-signed URL for uploading a file. Use when you need a secure, time-limited URL prior to file upload.
Input parameters
Name of the file to be uploaded, e.g., 'document.pdf'
Application feature associated with the file, such as 'chat'
Optional MIME type hint for the file, e.g., 'image/jpeg' or 'application/pdf'
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
CONNECTEAM_GET_CHATTool to retrieve chat conversations. Use when you need to list all team chats/channels after confirming your Communications hub is on Expert plan.
Input parameters
Maximum number of conversations to return per page (1 to 500).
Number of conversations to skip for pagination (>= 0, default is 0).
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
CONNECTEAM_GET_CUSTOM_FIELD_CATEGORIESTool to retrieve all custom field categories. Use when you need to list or filter custom field categories in your Connecteam account.
Input parameters
Maximum number of custom field categories to retrieve
List of custom field category names to filter results
List of custom field category IDs to filter results
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
CONNECTEAM_GET_CUSTOM_FIELDSTool to retrieve all custom fields associated with the account. Use when you need to filter, sort, or page through custom fields after authentication.
Input parameters
Sort key: 'id', 'name', or 'type'
Maximum number of results per page (1-500)
Sort order, only honored if 'sort' is set
Resource offset for pagination (>=0)
Custom field category IDs to filter by
Custom field IDs to filter by
Custom field names to filter by
Custom field types to filter by
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
CONNECTEAM_GET_FORMSTool to retrieve all form definitions from Connecteam. Use when you need to list all existing forms after enabling the Forms API.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
CONNECTEAM_GET_JOBSTool 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.
Input parameters
Sort key for ordering results. Currently only 'title' is supported.
Maximum number of records to return per page.
Sort direction. Defaults to ascending.
List of job IDs to filter by. Includes nested sub-jobs under each parent.
Number of records to skip before starting to collect the result set.
List of job codes to filter by. Returns matching sub-jobs and their parents.
List of job names to filter by. Returns matching sub-jobs and their parents.
List of instance IDs (scheduler or time clock) to filter by. Only one allowed.
Whether to include deleted jobs in the response. Defaults to true.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
CONNECTEAM_GET_PERFORMANCE_INDICATORSTool to retrieve the list of performance metric indicators. Use when you need to list available performance indicators for data analysis. Examples: "List performance metrics".
Input parameters
Maximum number of performance indicators to return per page (1-100, default is 10)
Resource offset for pagination (>=0, default is 0)
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
CONNECTEAM_GET_POLICY_TYPESTool to retrieve available time-off policy types. Use before filtering or creating time-off requests by policyTypeId.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
CONNECTEAM_GET_PUBLISHERSTool to retrieve a list of all custom publishers. Use when you need to list custom publishers after confirming API access.
Input parameters
Maximum number of publishers to return per page (1-100).
Offset for pagination; the number of items to skip.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
CONNECTEAM_GET_SCHEDULERSTool to retrieve a list of job schedulers associated with the account. Use after authentication when you need to enumerate all schedulers.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
CONNECTEAM_GET_SMART_GROUPSTool 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.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
CONNECTEAM_GET_TASK_BOARDSTool to retrieve all task boards. Use after authenticating with a valid API key to list available task boards.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
CONNECTEAM_GET_USERSTool to retrieve a list of all users associated with your account. Use when you need to fetch and filter user data.
Input parameters
Sorting criteria (e.g., creation time)
Maximum number of results per page (1 to 500, default is 10)
Order of results. Defaults to ascending.
Resource offset for pagination (>= 0, default is 0)
List of user IDs to filter results
Filter users created after a specific Unix timestamp
Filter by exact full names
Filter users modified after a specific Unix timestamp
Filter users by status (e.g., 'active')
Filter by phone numbers in E.164 format (e.g., +1234567890)
Filter by email addresses
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
CONNECTEAM_LIST_METool to retrieve account information including company name and company ID. Use when you need to get details about the authenticated account.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
Agents can call 16 Connecteam actions on Nagent, including "Create Users", "Get Chat" and "Get Custom Field Categories". Create Users: Create multiple users in Connecteam. Each action is listed on this page with its input parameters and its output.
Connecteam connects with an API key, under your workspace's own connection. Nothing is enabled on connect: each action is allowed one at a time and can be scoped to the agents that need it.
Create Users takes 1 required input: users. It returns data, error and successful.