Skip to main content
Folk logo
  • Category: crm
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 26
  • Triggers: 0
  • Slug: FOLK
  • Version: 20261022_00

Tools

Slug: 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

string
required
The unique name of the company.
array
List of URLs associated with the company.
array
List of email addresses associated with the company.
array
The groups to add the company to. Provide group IDs.
array
List of phone numbers associated with the company.
string
Industry sector of the company.
array
List of addresses associated with the company.
string
A short description of the company.
string
Employee count range for the company.
string
Amount of funding raised by the company (numeric value only).
string
Year the company was founded in YYYY format.
string
Date of the last funding round in YYYY-MM-DD format.
object
Custom field values grouped by group ID. Values depend on field type: text, number, date, select, contact, user, etc.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FOLK_CREATE_CUSTOM_OBJECTCreate a deal or another custom-object record in a Folk group.

Input Parameters

string
The name of the new custom-object record.
array
Up to 20 people to associate by person ID.
string
required
The 40-character group ID from FOLK_LIST_GROUPS.
array
Up to 20 companies to associate by company ID.
string
required
The case-sensitive object type defined in the group, such as Deals. Use an objectField name returned by FOLK_LIST_GROUP_CUSTOM_FIELDS for entity_type person.
string
A caller-generated key that makes retries safe for 24 hours.
object
Custom values keyed by exact custom-field name; accepted values depend on each field’s type.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FOLK_CREATE_INTERACTIONRecord a dated interaction with a person or company in Folk.

Input Parameters

string
required
The interaction title.
object
required
The Folk person or company linked to the interaction.
string
required
The multiline details of the interaction.
string
required
The interaction date and time as an ISO 8601 timestamp.
string
A predefined activity (call, meeting, message, coffee, lunch, event, drink), messaging app (whatsapp, twitter, linkedin, instagram, hangout, tiktok, skype, slack, iMessage, fbMessenger, signal, discord, wechat, telegram, viber), or emoji.
string
A caller-generated key that makes retries safe for 24 hours.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

object
required
The person, company, or deal that the note is attached to. Provide the entity object with an id field.
string
required
The content of the note. Supports plain text or markdown format. Must be between 1 and 100,000 characters.
object
Reference to a parent note when creating a reply.
string ("public" | "private")
required
Visibility of the note. ‘public’ means visible to all workspace users, ‘private’ means visible only to the current user.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

array
List of email addresses for the person. The first email is considered the primary email.
array
The groups to add the person to. Provide group IDs.
array
List of phone numbers for the person. The first phone is considered the primary phone.
string
Last name of the person.
string
First name of the person.
object
Custom field values grouped by group ID. Values depend on field type: text, number, date, select, contact, user, etc.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FOLK_DELETE_COMPANYTool to delete a company from the workspace (irreversible). Use after confirming this company should be removed.

Input Parameters

string
required
The ID of the company to delete. Must be exactly 40 characters.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FOLK_DELETE_NOTETool to delete an existing note in the workspace (irreversible). Use after confirming this note should be permanently removed.

Input Parameters

string
required
The ID of the note to delete. Must be exactly 40 characters.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FOLK_DELETE_PERSONTool to delete an existing person in the workspace (irreversible). Use after confirming this person should be permanently removed.

Input Parameters

string
required
The ID of the person to delete. Must be exactly 40 characters.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FOLK_DELETE_REMINDERTool to delete an existing reminder in the workspace (irreversible). Use after confirming this reminder should be permanently removed.

Input Parameters

string
required
The ID of the reminder to delete. Must be exactly 40 characters.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FOLK_GET_COMPANYTool to retrieve an existing company by its ID. Use after authentication has been verified.

Input Parameters

string
required
The ID of the company to retrieve. Must be exactly 40 characters long.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The ID of the note to retrieve. Must be exactly 40 characters long.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The unique identifier of the person to retrieve. Must be exactly 40 characters long (format: per_XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The unique identifier of the user to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FOLK_LIST_COMPANIESTool to list companies in the workspace. Use when you need a paginated overview of companies, optionally filtered.

Input Parameters

integer
The number of items to return. Must be between 1 and 100.
string
A pagination cursor from a previous response’s pagination.nextLink. Omit on the first call.
object
Filters to apply, using filter[attribute][operator]=value syntax.
string ("and" | "or")
Logical operator to combine multiple filters.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Number of items to return (1-100). Defaults to 20.
string
Pagination cursor. Omit on first call; use data.pagination.nextLink from previous response for subsequent pages.
string
required
ID of the group (exactly 40 characters). Obtain via the list-groups endpoint.
string ("person" | "company")
required
Entity type whose custom fields to list. Must be ‘person’ or ‘company’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FOLK_LIST_GROUPSTool to list workspace groups. Use when you need to retrieve a paginated list of all workspace groups after authentication.

Input Parameters

integer
The number of items to return. Must be between 1 and 100.
string
Cursor for pagination across multiple pages. Omit on first call. Use the pagination.nextLink value from a previous response for subsequent pages.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FOLK_LIST_INTERACTIONSList one cursor-paginated page of past or upcoming interactions linked to a Folk person, company, or custom object.

Input Parameters

integer
Maximum interactions to return in this page (1-100).
string
Opaque value of the cursor query parameter parsed from the previous response’s full data.pagination.nextLink URL. Do not pass the full URL. Omit on the first call.
array
One to 50 workspace member IDs whose interactions should be returned. Each ID must contain exactly 40 characters.
string
required
The 40-character Folk ID of the person, company, or custom object linked to the interactions.
string ("past" | "upcoming")
required
Whether to return past interactions, newest first, or upcoming interactions.
string
Imported interaction types to include. Provide an array to filter imported interactions, an empty string to return only logged interactions, or omit to return every imported type. Logged interactions are always returned.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FOLK_LIST_NOTESTool to list notes in the workspace. Use when you need to retrieve notes with pagination support.

Input Parameters

integer
The number of items to return. Must be between 1 and 100.
string
A pagination cursor from a previous response’s pagination.nextLink. Omit on the first call.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FOLK_LIST_PEOPLETool to list people in the workspace. Use when you need to paginate through contacts after authentication.

Input Parameters

integer
The number of items to return. Must be between 1 and 100.
string
A pagination cursor from a previous response’s pagination.nextLink. Omit on the first call.
object
Filters to apply, following filter[attribute][operator]=value format. E.g., {‘firstName’: {‘eq’: ‘John’}}.
string ("and" | "or")
Logical operator to combine multiple filters.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FOLK_LIST_REMINDERSTool to list reminders in the workspace. Use when you need a paginated overview of reminders, optionally filtered by entity.

Input Parameters

integer
The number of items to return. Must be between 1 and 100.
string
A pagination cursor from a previous response’s pagination.nextLink. Omit on the first call.
string
Filter reminders by entity ID (person, company, or object).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FOLK_LIST_USERSTool to list workspace users. Use when you need to paginate through users list.

Input Parameters

integer
Number of users to return. Must be between 1 and 100.
string
A pagination cursor from previous response’s nextLink. Omit on first call.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FOLK_LIST_WEBHOOKSTool to list webhooks in the workspace. Use when you need to retrieve configured webhooks with pagination support.

Input Parameters

integer
Number of webhooks to return. Must be between 1 and 100.
string
A pagination cursor from previous response’s nextLink. Omit on first call.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
The name of the company.
array
List of URLs associated with the company; replaces existing URLs.
array
List of email addresses associated with the company; replaces existing emails.
array
Groups to associate with the company; list values replace existing groups.
array
List of phone numbers associated with the company; replaces existing phones.
array
List of addresses associated with the company; replaces existing addresses.
string
required
The ID of the company to update. Must be exactly 40 characters long.
string
A short description of the company.
object
Custom field values grouped by group ID. Values depend on field type: text, number, date, select, contact, user, etc.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FOLK_UPDATE_NOTETool to update an existing note in the workspace. Use after confirming the note ID; only provided fields are updated.

Input Parameters

string
The content of the note in plain text or markdown format.
string
required
The ID of the note to update.
string ("public" | "private")
Visibility level for a note.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

array
List of URLs associated with the person; replaces existing URLs.
array
List of email addresses associated with the person; replaces existing emails.
array
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.
array
List of phone numbers associated with the person; replaces existing phones.
string
The person’s birthday in ISO 8601 date format (YYYY-MM-DD). Set to null to remove.
string
The full name of the person.
string
The job title of the person.
string
The last name of the person.
string
required
The ID of the person to update. Must be exactly 40 characters long.
array
List of addresses associated with the person; replaces existing addresses.
array
Companies to associate with the person; list values replace existing companies.
string
The first name of the person.
string
A short description of the person.
object
Custom field values grouped by group ID. Values depend on field type: text, number, date, select, contact, user, etc.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not