Folk

Create and list contacts in Folk's collaborative CRM.

CRM and salesAPI key8 actionsAll integrations

On this page

Connect
Call it from a workflow
Actions (8)
createCompany
createPerson
findCompany
findPerson
getCompany
getPerson
updateCompany
updatePerson
Details

Connect

Auth type: API key (secret_text). Paste the API key (or token) from the provider's settings into the connect dialog. It is encrypted at rest and only decrypted on the server when an action runs.

In the editor: Backend panel, Integrations tab, then Connect. This connects it for the project.
For every project in a workspace: Workspace settings, Integrations.
Owners and admins choose which integrations members may connect in the admin panel (Integrations tab), and can attach their own OAuth app there.

Call it from a workflow

Pass the action name and its input. The call resolves with { success, output, error? }; a missing connection resolves with success false and the reason. See ctx.integrations.invoke and ctx.integrations.call.

Native workflow

// .workflow.js (native ctx)
export async function run(ctx) {
  const res = await ctx.integrations.invoke("folk", "createCompany", {
    "name": "<company name>"
  });
  if (!res.success) throw new Error(res.error);
  ctx.log.info("Folk answered", { output: res.output });
}

defineWorkflow module

// defineWorkflow module (@app/sdk ctx)
import { defineWorkflow } from "@app/sdk";

export default defineWorkflow({
  id: "folk-createcompany",
  name: "Folk: Create Company",
  description: "Calls Folk when a row is created.",
  trigger: { type: "entity_event", entity: "tickets", event: "created" },
  async run(ctx, event) {
    const res = await ctx.integrations.call("folk", {
      "action": "createCompany",
      "name": "<company name>"
    }) as { success: boolean; error?: string };
    if (!res.success) throw new Error(res.error);
  },
});

From an app (connector proxy)

curl -X POST "$APP_ORIGIN/__appbricx/connector-proxy/folk/createCompany" \
  -H "Authorization: Bearer $APP_KEY" \
  -H "content-type: application/json" \
  -d '{"props":{"name":"<company name>"}}'

Actions

createCompanyin catalog

Create Company. Create a new company in your Folk workspace. You can add emails, links, phone numbers, and assign it to a group.

Input	Type	Description
`name`required	text	The name of the company
`description`optional	long text	A short description of the company
`industry`optional	text	The industry the company operates in
`addresses`optional	array	Physical addresses for the company. The first address is primary.
`emails`optional	array	Email addresses for the company. The first email is primary.
`phones`optional	array	Phone numbers for the company. The first phone is primary.
`urls`optional	array	Website URLs for the company. The first URL is primary.
`groupId`optional	id (picked from your account)	Enter a Folk group ID (e.g., grp_abc123). Groups help you organize your contacts.

createPersonin catalog

Create Person. Create a new person in your Folk workspace. You can link them to a company, add contact details, and assign to a group.

Input	Type	Description
`firstName`optional	text	The first name of the person
`lastName`optional	text	The last name of the person
`fullName`optional	text	The full name of the person (alternative to first/last)
`description`optional	long text	A short description of the person
`birthday`optional	text	The birthday in YYYY-MM-DD format
`jobTitle`optional	text	The job title of the person
`companyNames`optional	array	The names of companies to associate with the person. The first company will be primary.
`companyIds`optional	ids (picked from your account)	Select companies to associate with the person.
`addresses`optional	array	Physical addresses for the person. The first address is primary.
`emails`optional	array	Email addresses for the person. The first email is primary.
`phones`optional	array	Phone numbers for the person. The first phone is primary.
`urls`optional	array	Website URLs for the person. The first URL is primary.
`groupId`optional	id (picked from your account)	Enter a Folk group ID (e.g., grp_abc123). Groups help you organize your contacts.

findCompanyin catalog

Find Company. Search for companies in your Folk workspace by name or email address.

Input	Type	Description
`query`required	text	Enter company name or email to search for

findPersonin catalog

List People. Retrieve a paginated list of people in your Folk workspace with optional filtering.

Input	Type	Description
`limit`optional	number	The number of items to return (1-100)
`cursor`optional	text	A cursor for pagination. Use the nextLink value from a previous response.
`combinator`optional	one of "and" \| "or"	The logical operator to combine multiple filters
`nameFilter`optional	text	Filter by person name (contains)
`emailFilter`optional	text	Filter by email address (contains)

getCompanyin catalog

Get Company. Retrieve detailed information about a company from your Folk workspace.

Input	Type	Description
`companyId`required	id (picked from your account)	Select a company from your Folk workspace.

getPersonin catalog

Get Person. Retrieve detailed information about a person from your Folk workspace.

Input	Type	Description
`personId`required	id (picked from your account)	Select a person from your Folk workspace.

updateCompany

Update Company. Update an existing company in your Folk workspace. Select the company from the dropdown to update its details.

Input	Type	Description
`companyId`required	id (picked from your account)	Select a company from your Folk workspace.
`name`optional	text	The name of the company
`description`optional	long text	A short description of the company
`industry`optional	text	The industry the company operates in
`addresses`optional	array	Physical addresses for the company. The first address is primary.
`emails`optional	array	Email addresses for the company. The first email is primary.
`phones`optional	array	Phone numbers for the company. The first phone is primary.
`urls`optional	array	Website URLs for the company. The first URL is primary.
`groupId`optional	id (picked from your account)	Enter a Folk group ID (e.g., grp_abc123). Groups help you organize your contacts.

updatePerson

Update Person. Update an existing person in your Folk workspace with new information.

Input	Type	Description
`personId`required	id (picked from your account)	Select a person from your Folk workspace.
`firstName`optional	text	The first name of the person
`lastName`optional	text	The last name of the person
`fullName`optional	text	The full name of the person (alternative to first/last)
`description`optional	long text	A short description of the person
`birthday`optional	text	The birthday in YYYY-MM-DD format
`jobTitle`optional	text	The job title of the person
`companyIds`optional	ids (picked from your account)	Select companies to associate with the person.
`companyNames`optional	array	Company names to create or associate with. Companies will be created if they don't exist.
`addresses`optional	array	Physical addresses for the person. The first address is primary.
`emails`optional	array	Email addresses for the person. The first email is primary.
`phones`optional	array	Phone numbers for the person. The first phone is primary.
`urls`optional	array	Website URLs for the person. The first URL is primary.
`groupId`optional	id (picked from your account)	Enter a Folk group ID (e.g., grp_abc123). Groups help you organize your contacts.

Details

Id: folk
Category: CRM and sales
Tags: crm, contacts, relationships, collaborative
Package: @activepieces/piece-folk@0.1.4
Tier: Community