folk

folk integration (Productivity, Communication). Imported from open-connector.

API key15 toolshttps://api.folk.app

GET

folk_get_current_user

Get the current Folk workspace user associated with the API key.

/v1/users/me

GET

folk_list_users

List workspace users from Folk with cursor pagination.

/v1/users

2 parameters

Param	Type	Required	Description
limit	integer	optional	The number of items to return.
cursor	string	optional	The opaque pagination cursor returned by a previous Folk response.

GET

folk_get_user

Get one Folk workspace user by user ID.

/v1/users/{userId}

1 parameter

Param	Type	Required	Description
userId	string	required	The Folk user ID.

GET

folk_list_groups

List Folk workspace groups with cursor pagination.

/v1/groups

2 parameters

Param	Type	Required	Description
limit	integer	optional	The number of items to return.
cursor	string	optional	The opaque pagination cursor returned by a previous Folk response.

GET

folk_list_group_custom_fields

List Folk custom fields for one group and entity type.

/v1/groups/{groupId}/custom-fields/{entityType}

4 parameters

Param	Type	Required	Description
groupId	string	required	The Folk group ID.
entityType	string	required	The entity type such as person, company, or a custom object name.
limit	integer	optional	The number of items to return.
cursor	string	optional	The opaque pagination cursor returned by a previous Folk response.

GET

folk_list_people

List Folk people with official cursor pagination and the documented nested filter syntax.

/v1/people

4 parameters

Param	Type	Required	Description
limit	integer	optional	The number of items to return.
cursor	string	optional	The opaque pagination cursor returned by a previous Folk response.
combinator	string	optional	The logical operator used to combine multiple Folk filters.
filter	object	optional	The official Folk filter object. Use nested properties such as {"fullName":{"li…

GET

folk_get_person

Get one Folk person by person ID.

/v1/people/{personId}

1 parameter

Param	Type	Required	Description
personId	string	required	The Folk person ID.

POST

folk_create_person

Create one Folk person using the official people payload fields.

/v1/people

13 parameters

Param	Type	Required	Description
firstName	string	optional	The person's first name.
lastName	string	optional	The person's last name.
fullName	string	optional	The person's full name.
description	string	optional	The person's description.
birthday	string	optional	—
jobTitle	string	optional	The person's job title.
groups	array	optional	The groups to associate with the person.
companies	array	optional	The companies to associate with the person.
addresses	array	optional	The addresses associated with the person.
emails	array	optional	The email addresses associated with the person.
phones	array	optional	The phone numbers associated with the person.
urls	array	optional	The URLs associated with the person.
customFieldValues	object	optional	Custom field values grouped by Folk group ID and custom field name.

PATCH

folk_update_person

Update one Folk person by person ID using the official people payload fields.

/v1/people/{personId}

14 parameters

Param	Type	Required	Description
personId	string	required	The Folk person ID.
firstName	string	optional	The person's first name.
lastName	string	optional	The person's last name.
fullName	string	optional	The person's full name.
description	string	optional	The person's description.
birthday	string	optional	—
jobTitle	string	optional	The person's job title.
groups	array	optional	The groups to associate with the person.
companies	array	optional	The companies to associate with the person.
addresses	array	optional	The addresses associated with the person.
emails	array	optional	The email addresses associated with the person.
phones	array	optional	The phone numbers associated with the person.
urls	array	optional	The URLs associated with the person.
customFieldValues	object	optional	Custom field values grouped by Folk group ID and custom field name.

DELETE

folk_delete_person

Delete one Folk person by person ID.

/v1/people/{personId}

1 parameter

Param	Type	Required	Description
personId	string	required	The Folk person ID.

GET

folk_list_companies

List Folk companies with official cursor pagination and the documented nested filter syntax.

/v1/companies

4 parameters

Param	Type	Required	Description
limit	integer	optional	The number of items to return.
cursor	string	optional	The opaque pagination cursor returned by a previous Folk response.
combinator	string	optional	The logical operator used to combine multiple Folk filters.
filter	object	optional	The official Folk filter object. Use nested properties such as {"fullName":{"li…

GET

folk_get_company

Get one Folk company by company ID.

/v1/companies/{companyId}

1 parameter

Param	Type	Required	Description
companyId	string	required	The Folk company ID.

POST

folk_create_company

Create one Folk company using the official companies payload fields.

/v1/companies

13 parameters

Param	Type	Required	Description
name	string	optional	The company name.
description	string	optional	The company description.
fundingRaised	number	optional	The amount of funding raised by the company in USD.
lastFundingDate	string	optional	—
industry	string	optional	—
foundationYear	string	optional	The company foundation year in YYYY format.
employeeRange	string	optional	—
groups	array	optional	The groups to associate with the company.
addresses	array	optional	The addresses associated with the company.
emails	array	optional	The email addresses associated with the company.
phones	array	optional	The phone numbers associated with the company.
urls	array	optional	The URLs associated with the company.
customFieldValues	object	optional	Custom field values grouped by Folk group ID and custom field name.

PATCH

folk_update_company

Update one Folk company by company ID using the official companies payload fields.

/v1/companies/{companyId}

14 parameters

Param	Type	Required	Description
companyId	string	required	The Folk company ID.
name	string	optional	The company name.
description	string	optional	The company description.
fundingRaised	number	optional	The amount of funding raised by the company in USD.
lastFundingDate	string	optional	—
industry	string	optional	—
foundationYear	string	optional	The company foundation year in YYYY format.
employeeRange	string	optional	—
groups	array	optional	The groups to associate with the company.
addresses	array	optional	The addresses associated with the company.
emails	array	optional	The email addresses associated with the company.
phones	array	optional	The phone numbers associated with the company.
urls	array	optional	The URLs associated with the company.
customFieldValues	object	optional	Custom field values grouped by Folk group ID and custom field name.

DELETE

folk_delete_company

Delete one Folk company by company ID.

/v1/companies/{companyId}

1 parameter

Param	Type	Required	Description
companyId	string	required	The Folk company ID.