NagentArtefacts
Dev & Technology
Enterprise and White Glove
Company
Folk connects to a Nagent workspace with an API key. Once it is connected, agents can call 23 Folk actions, such as "Create Company", "Create Note" and "Create Person". 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 Folk, with input parameters and output schema.
FOLK_CREATE_COMPANYCreates a new company in the Folk workspace with the specified details. Required: company name (unique identifier). Optional: description, industry, funding details, employee range, contact info (emails, phones, urls, addresses), group assignments, and custom field values. Returns the created company with a unique ID, all provided fields, timestamps, and creator information.
Input parameters
The unique name of the company.
List of URLs associated with the company.
List of email addresses associated with the company.
The groups to add the company to. Provide group IDs.
List of phone numbers associated with the company.
Industry sector of the company.
List of addresses associated with the company.
A short description of the company.
Employee count range for the company.
Amount of funding raised by the company (numeric value only).
Year the company was founded in YYYY format.
Date of the last funding round in YYYY-MM-DD format.
Custom field values grouped by group ID. Values depend on field type: text, number, date, select, contact, user, etc.
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
FOLK_CREATE_NOTETool to create a new note in the Folk workspace. Use when you need to add a note to a person, company, or deal entity.
Input parameters
The person, company, or deal that the note is attached to. Provide the entity object with an id field.
The content of the note. Supports plain text or markdown format. Must be between 1 and 100,000 characters.
Reference to a parent note when creating a reply.
Visibility of the note. 'public' means visible to all workspace users, 'private' means visible only to the current user.
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
FOLK_CREATE_PERSONCreates a new person in the Folk workspace with the specified details. Optional fields include: first name, last name, emails, phones, group assignments, and custom field values. The first email/phone in the list is treated as the primary contact. Returns the created person with a unique ID, all provided fields, timestamps, and creator information.
Input parameters
List of email addresses for the person. The first email is considered the primary email.
The groups to add the person to. Provide group IDs.
List of phone numbers for the person. The first phone is considered the primary phone.
Last name of the person.
First name of the person.
Custom field values grouped by group ID. Values depend on field type: text, number, date, select, contact, user, etc.
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
FOLK_DELETE_COMPANYTool to delete a company from the workspace (irreversible). Use after confirming this company should be removed.
Input parameters
The ID of the company to delete. Must be exactly 40 characters.
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
FOLK_DELETE_NOTETool to delete an existing note in the workspace (irreversible). Use after confirming this note should be permanently removed.
Input parameters
The ID of the note to delete. Must be exactly 40 characters.
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
FOLK_DELETE_PERSONTool to delete an existing person in the workspace (irreversible). Use after confirming this person should be permanently removed.
Input parameters
The ID of the person to delete. Must be exactly 40 characters.
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
FOLK_DELETE_REMINDERTool to delete an existing reminder in the workspace (irreversible). Use after confirming this reminder should be permanently removed.
Input parameters
The ID of the reminder to delete. Must be exactly 40 characters.
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
FOLK_GET_COMPANYTool to retrieve an existing company by its ID. Use after authentication has been verified.
Input parameters
The ID of the company to retrieve. Must be exactly 40 characters long.
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
FOLK_GET_CURRENT_WORKSPACE_USERTool to get details of the current authenticated workspace user. Use after authentication to retrieve the user's profile information.
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
FOLK_GET_NOTETool to retrieve an existing note by its ID. Use when you need the full content and metadata of a specific note.
Input parameters
The ID of the note to retrieve. Must be exactly 40 characters long.
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
FOLK_GET_PERSONTool to retrieve an existing person by their ID. Use when you need full profile details of a person by their unique identifier.
Input parameters
The unique identifier of the person to retrieve. Must be exactly 40 characters long (format: per_XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX)
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
FOLK_GET_USERTool to retrieve a user by their unique identifier. Use when you need to get details of a specific workspace user.
Input parameters
The unique identifier of the user to retrieve
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
FOLK_LIST_COMPANIESTool to list companies in the workspace. Use when you need a paginated overview of companies, optionally filtered.
Input parameters
The number of items to return. Must be between 1 and 100.
A pagination cursor from a previous response's `pagination.nextLink`. Omit on the first call.
Filters to apply, using `filter\[attribute\]\[operator\]=value` syntax.
Logical operator to combine multiple filters.
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
FOLK_LIST_GROUP_CUSTOM_FIELDSTool to list custom fields for a specific group and entity type. Use after selecting a group and entity type to inspect available custom fields.
Input parameters
Number of items to return (1-100). Defaults to 20.
Pagination cursor. Omit on first call; use `data.pagination.nextLink` from previous response for subsequent pages.
ID of the group (exactly 40 characters). Obtain via the list-groups endpoint.
Entity type whose custom fields to list. Must be 'person' or 'company'.
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
FOLK_LIST_GROUPSTool to list workspace groups. Use when you need to retrieve a paginated list of all workspace groups after authentication.
Input parameters
The number of items to return. Must be between 1 and 100.
Cursor for pagination across multiple pages. Omit on first call. Use the `pagination.nextLink` value from a previous response for subsequent pages.
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
FOLK_LIST_NOTESTool to list notes in the workspace. Use when you need to retrieve notes with pagination support.
Input parameters
The number of items to return. Must be between 1 and 100.
A pagination cursor from a previous response's `pagination.nextLink`. Omit on the first call.
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
FOLK_LIST_PEOPLETool to list people in the workspace. Use when you need to paginate through contacts after authentication.
Input parameters
The number of items to return. Must be between 1 and 100.
A pagination cursor from a previous response's `pagination.nextLink`. Omit on the first call.
Filters to apply, following `filter\[attribute\]\[operator\]=value` format. E.g., {'firstName': {'eq': 'John'}}.
Logical operator to combine multiple filters.
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
FOLK_LIST_REMINDERSTool to list reminders in the workspace. Use when you need a paginated overview of reminders, optionally filtered by entity.
Input parameters
The number of items to return. Must be between 1 and 100.
A pagination cursor from a previous response's `pagination.nextLink`. Omit on the first call.
Filter reminders by entity ID (person, company, or object).
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
FOLK_LIST_USERSTool to list workspace users. Use when you need to paginate through users list.
Input parameters
Number of users to return. Must be between 1 and 100.
A pagination cursor from previous response's `nextLink`. Omit on first call.
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
FOLK_LIST_WEBHOOKSTool to list webhooks in the workspace. Use when you need to retrieve configured webhooks with pagination support.
Input parameters
Number of webhooks to return. Must be between 1 and 100.
A pagination cursor from previous response's `nextLink`. Omit on first call.
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
FOLK_UPDATE_COMPANYTool to update an existing company in the workspace. Use after confirming the company ID; only provided fields are updated and list fields replace existing values.
Input parameters
The name of the company.
List of URLs associated with the company; replaces existing URLs.
List of email addresses associated with the company; replaces existing emails.
Groups to associate with the company; list values replace existing groups.
List of phone numbers associated with the company; replaces existing phones.
List of addresses associated with the company; replaces existing addresses.
The ID of the company to update. Must be exactly 40 characters long.
A short description of the company.
Custom field values grouped by group ID. Values depend on field type: text, number, date, select, contact, user, etc.
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
FOLK_UPDATE_NOTETool to update an existing note in the workspace. Use after confirming the note ID; only provided fields are updated.
Input parameters
The content of the note in plain text or markdown format.
The ID of the note to update.
Visibility level for a note.
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
FOLK_UPDATE_PERSONTool to update an existing person in the workspace. Use after confirming the person ID; only provided fields are updated and list fields replace existing values.
Input parameters
List of URLs associated with the person; replaces existing URLs.
List of email addresses associated with the person; replaces existing emails.
Groups to associate with the person; list values replace existing groups. When removing a person from a group, their custom field values for that group are also removed.
List of phone numbers associated with the person; replaces existing phones.
The person's birthday in ISO 8601 date format (YYYY-MM-DD). Set to null to remove.
The full name of the person.
The job title of the person.
The last name of the person.
The ID of the person to update. Must be exactly 40 characters long.
List of addresses associated with the person; replaces existing addresses.
Companies to associate with the person; list values replace existing companies.
The first name of the person.
A short description of the person.
Custom field values grouped by group ID. Values depend on field type: text, number, date, select, contact, user, etc.
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 23 Folk actions on Nagent, including "Create Company", "Create Note" and "Create Person". Create Company: Creates a new company in the Folk workspace with the specified details. Each action is listed on this page with its input parameters and its output.
Folk 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 Company takes 1 required input: name. It also takes 12 optional inputs: urls, emails, groups, phones, industry, addresses, description, employeeRange, fundingRaised, foundationYear, lastFundingDate and customFieldValues. It returns data, error and successful.