> ## Documentation Index
> Fetch the complete documentation index at: https://composio-preview.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Folk

> folk is a next-generation CRM designed for teams to manage and nurture their relationships efficiently.

![Folk logo](https://mintcdn.com/composio-preview/GL28i3tBlbEbBd-f/images/toolkits/folk.svg?fit=max\&auto=format\&n=GL28i3tBlbEbBd-f\&q=85\&s=c2d1dd053ff99461325e10e9a61581dd)

* **Category:** crm
* **Auth:** API\_KEY
* **Composio-managed OAuth available?** N/A
* **Tools:** 26
* **Triggers:** 0
* **Slug:** `FOLK`
* **Version:** 20261022\_00

## Tools

> [accordion] Create Company
>
> **Slug:** `FOLK_CREATE_COMPANY`
>
> Creates 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
>
> **name** `string` *required*
>
> The unique name of the company.
>
> **urls** `array`
>
> List of URLs associated with the company.
>
> **emails** `array`
>
> List of email addresses associated with the company.
>
> **groups** `array`
>
> The groups to add the company to. Provide group IDs.
>
> **phones** `array`
>
> List of phone numbers associated with the company.
>
> **industry** `string`
>
> Industry sector of the company.
>
> **addresses** `array`
>
> List of addresses associated with the company.
>
> **description** `string`
>
> A short description of the company.
>
> **employeeRange** `string`
>
> Employee count range for the company.
>
> **fundingRaised** `string`
>
> Amount of funding raised by the company (numeric value only).
>
> **foundationYear** `string`
>
> Year the company was founded in YYYY format.
>
> **lastFundingDate** `string`
>
> Date of the last funding round in YYYY-MM-DD format.
>
> **customFieldValues** `object`
>
> Custom field values grouped by group ID. Values depend on field type: text, number, date, select, contact, user, etc.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Custom Object
>
> **Slug:** `FOLK_CREATE_CUSTOM_OBJECT`
>
> Create a deal or another custom-object record in a Folk group.
>
> #### Input Parameters
>
> **name** `string`
>
> The name of the new custom-object record.
>
> **people** `array`
>
> Up to 20 people to associate by person ID.
>
> **group\_id** `string` *required*
>
> The 40-character group ID from FOLK\_LIST\_GROUPS.
>
> **companies** `array`
>
> Up to 20 companies to associate by company ID.
>
> **object\_type** `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.
>
> **idempotency\_key** `string`
>
> A caller-generated key that makes retries safe for 24 hours.
>
> **custom\_field\_values** `object`
>
> Custom values keyed by exact custom-field name; accepted values depend on each field's type.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Interaction
>
> **Slug:** `FOLK_CREATE_INTERACTION`
>
> Record a dated interaction with a person or company in Folk.
>
> #### Input Parameters
>
> **title** `string` *required*
>
> The interaction title.
>
> **entity** `object` *required*
>
> The Folk person or company linked to the interaction.
>
> **content** `string` *required*
>
> The multiline details of the interaction.
>
> **dateTime** `string` *required*
>
> The interaction date and time as an ISO 8601 timestamp.
>
> **activityType** `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.
>
> **idempotencyKey** `string`
>
> A caller-generated key that makes retries safe for 24 hours.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Note
>
> **Slug:** `FOLK_CREATE_NOTE`
>
> Tool 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
>
> **entity** `object` *required*
>
> The person, company, or deal that the note is attached to. Provide the entity object with an id field.
>
> **content** `string` *required*
>
> The content of the note. Supports plain text or markdown format. Must be between 1 and 100,000 characters.
>
> **parentNote** `object`
>
> Reference to a parent note when creating a reply.
>
> **visibility** `string ("public" | "private")` *required*
>
> Visibility of the note. 'public' means visible to all workspace users, 'private' means visible only to the current user.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Person
>
> **Slug:** `FOLK_CREATE_PERSON`
>
> Creates 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
>
> **emails** `array`
>
> List of email addresses for the person. The first email is considered the primary email.
>
> **groups** `array`
>
> The groups to add the person to. Provide group IDs.
>
> **phones** `array`
>
> List of phone numbers for the person. The first phone is considered the primary phone.
>
> **lastName** `string`
>
> Last name of the person.
>
> **firstName** `string`
>
> First name of the person.
>
> **customFieldValues** `object`
>
> Custom field values grouped by group ID. Values depend on field type: text, number, date, select, contact, user, etc.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Company
>
> **Slug:** `FOLK_DELETE_COMPANY`
>
> Tool to delete a company from the workspace (irreversible). Use after confirming this company should be removed.
>
> #### Input Parameters
>
> **company\_id** `string` *required*
>
> The ID of the company to delete. Must be exactly 40 characters.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Note
>
> **Slug:** `FOLK_DELETE_NOTE`
>
> Tool to delete an existing note in the workspace (irreversible). Use after confirming this note should be permanently removed.
>
> #### Input Parameters
>
> **note\_id** `string` *required*
>
> The ID of the note to delete. Must be exactly 40 characters.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Person
>
> **Slug:** `FOLK_DELETE_PERSON`
>
> Tool to delete an existing person in the workspace (irreversible). Use after confirming this person should be permanently removed.
>
> #### Input Parameters
>
> **person\_id** `string` *required*
>
> The ID of the person to delete. Must be exactly 40 characters.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Reminder
>
> **Slug:** `FOLK_DELETE_REMINDER`
>
> Tool to delete an existing reminder in the workspace (irreversible). Use after confirming this reminder should be permanently removed.
>
> #### Input Parameters
>
> **reminder\_id** `string` *required*
>
> The ID of the reminder to delete. Must be exactly 40 characters.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Company
>
> **Slug:** `FOLK_GET_COMPANY`
>
> Tool to retrieve an existing company by its ID. Use after authentication has been verified.
>
> #### Input Parameters
>
> **company\_id** `string` *required*
>
> The ID of the company to retrieve. Must be exactly 40 characters long.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Current Workspace User
>
> **Slug:** `FOLK_GET_CURRENT_WORKSPACE_USER`
>
> Tool to get details of the current authenticated workspace user. Use after authentication to retrieve the user's profile information.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Note
>
> **Slug:** `FOLK_GET_NOTE`
>
> Tool to retrieve an existing note by its ID. Use when you need the full content and metadata of a specific note.
>
> #### Input Parameters
>
> **note\_id** `string` *required*
>
> The ID of the note to retrieve. Must be exactly 40 characters long.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Person
>
> **Slug:** `FOLK_GET_PERSON`
>
> Tool to retrieve an existing person by their ID. Use when you need full profile details of a person by their unique identifier.
>
> #### Input Parameters
>
> **person\_id** `string` *required*
>
> The unique identifier of the person to retrieve. Must be exactly 40 characters long (format: per\_XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX)
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get User
>
> **Slug:** `FOLK_GET_USER`
>
> Tool to retrieve a user by their unique identifier. Use when you need to get details of a specific workspace user.
>
> #### Input Parameters
>
> **user\_id** `string` *required*
>
> The unique identifier of the user to retrieve
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Companies
>
> **Slug:** `FOLK_LIST_COMPANIES`
>
> Tool to list companies in the workspace. Use when you need a paginated overview of companies, optionally filtered.
>
> #### Input Parameters
>
> **limit** `integer`
>
> The number of items to return. Must be between 1 and 100.
>
> **cursor** `string`
>
> A pagination cursor from a previous response's `pagination.nextLink`. Omit on the first call.
>
> **filter** `object`
>
> Filters to apply, using `filter[attribute][operator]=value` syntax.
>
> **combinator** `string ("and" | "or")`
>
> Logical operator to combine multiple filters.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Group Custom Fields
>
> **Slug:** `FOLK_LIST_GROUP_CUSTOM_FIELDS`
>
> Tool 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
>
> **limit** `integer`
>
> Number of items to return (1-100). Defaults to 20.
>
> **cursor** `string`
>
> Pagination cursor. Omit on first call; use `data.pagination.nextLink` from previous response for subsequent pages.
>
> **group\_id** `string` *required*
>
> ID of the group (exactly 40 characters). Obtain via the list-groups endpoint.
>
> **entity\_type** `string ("person" | "company")` *required*
>
> Entity type whose custom fields to list. Must be 'person' or 'company'.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Groups
>
> **Slug:** `FOLK_LIST_GROUPS`
>
> Tool to list workspace groups. Use when you need to retrieve a paginated list of all workspace groups after authentication.
>
> #### Input Parameters
>
> **limit** `integer`
>
> The number of items to return. Must be between 1 and 100.
>
> **cursor** `string`
>
> Cursor for pagination across multiple pages. Omit on first call. Use the `pagination.nextLink` value from a previous response for subsequent pages.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Interactions
>
> **Slug:** `FOLK_LIST_INTERACTIONS`
>
> List one cursor-paginated page of past or upcoming interactions linked to a Folk person, company, or custom object.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Maximum interactions to return in this page (1-100).
>
> **cursor** `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.
>
> **user\_ids** `array`
>
> One to 50 workspace member IDs whose interactions should be returned. Each ID must contain exactly 40 characters.
>
> **entity\_id** `string` *required*
>
> The 40-character Folk ID of the person, company, or custom object linked to the interactions.
>
> **timeframe** `string ("past" | "upcoming")` *required*
>
> Whether to return past interactions, newest first, or upcoming interactions.
>
> **imported\_types** `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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Notes
>
> **Slug:** `FOLK_LIST_NOTES`
>
> Tool to list notes in the workspace. Use when you need to retrieve notes with pagination support.
>
> #### Input Parameters
>
> **limit** `integer`
>
> The number of items to return. Must be between 1 and 100.
>
> **cursor** `string`
>
> A pagination cursor from a previous response's `pagination.nextLink`. Omit on the first call.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List People
>
> **Slug:** `FOLK_LIST_PEOPLE`
>
> Tool to list people in the workspace. Use when you need to paginate through contacts after authentication.
>
> #### Input Parameters
>
> **limit** `integer`
>
> The number of items to return. Must be between 1 and 100.
>
> **cursor** `string`
>
> A pagination cursor from a previous response's `pagination.nextLink`. Omit on the first call.
>
> **filter** `object`
>
> Filters to apply, following `filter[attribute][operator]=value` format. E.g., \{'firstName': \{'eq': 'John'}}.
>
> **combinator** `string ("and" | "or")`
>
> Logical operator to combine multiple filters.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Reminders
>
> **Slug:** `FOLK_LIST_REMINDERS`
>
> Tool to list reminders in the workspace. Use when you need a paginated overview of reminders, optionally filtered by entity.
>
> #### Input Parameters
>
> **limit** `integer`
>
> The number of items to return. Must be between 1 and 100.
>
> **cursor** `string`
>
> A pagination cursor from a previous response's `pagination.nextLink`. Omit on the first call.
>
> **entity\_id** `string`
>
> Filter reminders by entity ID (person, company, or object).
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Users
>
> **Slug:** `FOLK_LIST_USERS`
>
> Tool to list workspace users. Use when you need to paginate through users list.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Number of users to return. Must be between 1 and 100.
>
> **cursor** `string`
>
> A pagination cursor from previous response's `nextLink`. Omit on first call.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Webhooks
>
> **Slug:** `FOLK_LIST_WEBHOOKS`
>
> Tool to list webhooks in the workspace. Use when you need to retrieve configured webhooks with pagination support.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Number of webhooks to return. Must be between 1 and 100.
>
> **cursor** `string`
>
> A pagination cursor from previous response's `nextLink`. Omit on first call.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Company
>
> **Slug:** `FOLK_UPDATE_COMPANY`
>
> Tool 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
>
> **name** `string`
>
> The name of the company.
>
> **urls** `array`
>
> List of URLs associated with the company; replaces existing URLs.
>
> **emails** `array`
>
> List of email addresses associated with the company; replaces existing emails.
>
> **groups** `array`
>
> Groups to associate with the company; list values replace existing groups.
>
> **phones** `array`
>
> List of phone numbers associated with the company; replaces existing phones.
>
> **addresses** `array`
>
> List of addresses associated with the company; replaces existing addresses.
>
> **companyId** `string` *required*
>
> The ID of the company to update. Must be exactly 40 characters long.
>
> **description** `string`
>
> A short description of the company.
>
> **customFieldValues** `object`
>
> Custom field values grouped by group ID. Values depend on field type: text, number, date, select, contact, user, etc.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Note
>
> **Slug:** `FOLK_UPDATE_NOTE`
>
> Tool to update an existing note in the workspace. Use after confirming the note ID; only provided fields are updated.
>
> #### Input Parameters
>
> **content** `string`
>
> The content of the note in plain text or markdown format.
>
> **note\_id** `string` *required*
>
> The ID of the note to update.
>
> **visibility** `string ("public" | "private")`
>
> Visibility level for a note.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Person
>
> **Slug:** `FOLK_UPDATE_PERSON`
>
> Tool 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
>
> **urls** `array`
>
> List of URLs associated with the person; replaces existing URLs.
>
> **emails** `array`
>
> List of email addresses associated with the person; replaces existing emails.
>
> **groups** `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.
>
> **phones** `array`
>
> List of phone numbers associated with the person; replaces existing phones.
>
> **birthday** `string`
>
> The person's birthday in ISO 8601 date format (YYYY-MM-DD). Set to null to remove.
>
> **fullName** `string`
>
> The full name of the person.
>
> **jobTitle** `string`
>
> The job title of the person.
>
> **lastName** `string`
>
> The last name of the person.
>
> **personId** `string` *required*
>
> The ID of the person to update. Must be exactly 40 characters long.
>
> **addresses** `array`
>
> List of addresses associated with the person; replaces existing addresses.
>
> **companies** `array`
>
> Companies to associate with the person; list values replace existing companies.
>
> **firstName** `string`
>
> The first name of the person.
>
> **description** `string`
>
> A short description of the person.
>
> **customFieldValues** `object`
>
> Custom field values grouped by group ID. Values depend on field type: text, number, date, select, contact, user, etc.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not
