Folk

folk

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

CRM Contact Management Web del proveedor

Acciones

Triggers

Autenticación

—

OAuth gestionado

Información técnica: el detalle de parámetros, schemas y triggers de esta página está pensado para equipos de integración. Si solo necesitas saber si tu herramienta favorita está disponible, basta con ver la lista de acciones.

Acciones disponibles (12)

Cada acción es una operación que el agente puede ejecutar contra este conector. Haz clic en una acción para ver sus parámetros.

Create CompanyFOLK_CREATE_COMPANYAcción

Tool to create a new company in the workspace. use after gathering all required company details and ensuring the name is unique.

Parámetros de entrada

namestringObligatorio
The unique name of the company.
urlsstring[]
List of URLs associated with the company.
emailsstring[]
List of email addresses associated with the company.
groupsobject[]
The groups to add the company to. Provide group IDs.
phonesstring[]
List of phone numbers associated with the company.
addressesstring[]
List of addresses associated with the company.
descriptionstring
A short description of the company.
customFieldValuesobject
Custom field values grouped by group ID. Values depend on field type: text, number, date, select, contact, user, etc.

Parámetros de salida

dataobjectObligatorio
Created company data.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not
deprecationsstring[]
Any deprecation notices returned by the API.

Delete CompanyFOLK_DELETE_COMPANYAcción

Tool to delete a company from the workspace (irreversible). use after confirming this company should be removed.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
The deleted company data.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not
deprecationsstring[]
Any deprecation notices returned by the API.

Delete PersonFOLK_FOLK_DELETE_PERSONAcción

Tool to delete an existing person in the workspace (irreversible). use after confirming this person should be permanently removed.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
The deleted person data.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not
deprecationsstring[]
Any deprecation notices returned by the API.

List CompaniesFOLK_FOLK_LIST_COMPANIESAcción

Tool to list companies in the workspace. use when you need a paginated overview of companies, optionally filtered.

Parámetros de entrada

limitinteger
The number of items to return. Must be between 1 and 100.
cursorstring
A pagination cursor from a previous response's `pagination.nextLink`. Omit on the first call.
filterobject
Filters to apply, using `filter[attribute][operator]=value` syntax.
combinatorstringenum
Logical operator to combine multiple filters.
andor

Parámetros de salida

dataobjectObligatorio
Response data with items and pagination.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not
deprecationsstring[]
List of deprecation warnings, if any.

Get CompanyFOLK_GET_COMPANYAcción

Tool to retrieve an existing company by its id. use after authentication has been verified.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
The retrieved company object.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Current Workspace UserFOLK_GET_CURRENT_WORKSPACE_USERAcción

Tool to get details of the current authenticated workspace user. use after authentication to retrieve the user's profile information.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
The current workspace user's details
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get PersonFOLK_GET_PERSONAcción

Tool to retrieve an existing person by their id. use when you need full profile details of a person by their unique identifier.

Parámetros de entrada

person_idstringObligatorio
The unique identifier of the person to retrieve

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List Group Custom FieldsFOLK_LIST_GROUP_CUSTOM_FIELDSAcción

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.

Parámetros de entrada

limitinteger
Number of items to return (1-100). Defaults to 20.
cursorstring
Pagination cursor. Omit on first call; use `data.pagination.nextLink` from previous response for subsequent pages.
group_idstringObligatorio
ID of the group (exactly 40 characters). Obtain via the list-groups endpoint.
entity_typestringObligatorioenum
Entity type whose custom fields to list. Must be 'person' or 'company'.
personcompany

Parámetros de salida

dataobjectObligatorio
Response data container with items and pagination.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not
deprecationsstring[]
Deprecation warnings, if any.

List GroupsFOLK_LIST_GROUPSAcción

Tool to list workspace groups. use when you need to retrieve a paginated list of all workspace groups after authentication.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Envelope containing items and pagination.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not
deprecationsstring[]
Array of deprecation warnings, if any.

List PeopleFOLK_LIST_PEOPLEAcción

Tool to list people in the workspace. use when you need to paginate through contacts after authentication.

Parámetros de entrada

limitinteger
The number of items to return. Must be between 1 and 100.
cursorstring
A pagination cursor from a previous response's `pagination.nextLink`. Omit on the first call.
filterobject
Filters to apply, following `filter[attribute][operator]=value` format. E.g., {'firstName': {'eq': 'John'}}.
combinatorstringenum
Logical operator to combine multiple filters.
andor

Parámetros de salida

dataobjectObligatorio
Paginated list of people
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not
deprecationsstring[]
Deprecation warnings returned by the API

List UsersFOLK_LIST_USERSAcción

Tool to list workspace users. use when you need to paginate through users list.

Parámetros de entrada

limitinteger
Number of users to return. Must be between 1 and 100.
cursorstring
A pagination cursor from previous response's `nextLink`. Omit on first call.

Parámetros de salida

dataobjectObligatorio
Envelope containing users and pagination.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not
deprecationsstring[]
Deprecation warnings, if any.

Update CompanyFOLK_UPDATE_COMPANYAcción

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.

Parámetros de entrada

namestring
The name of the company.
urlsstring[]
List of URLs associated with the company; replaces existing URLs.
emailsstring[]
List of email addresses associated with the company; replaces existing emails.
groupsobject[]
Groups to associate with the company; list values replace existing groups.
phonesstring[]
List of phone numbers associated with the company; replaces existing phones.
addressesstring[]
List of addresses associated with the company; replaces existing addresses.
company_idstringObligatorio
The ID of the company to update. Must be exactly 40 characters long.
descriptionstring
A short description of the company.
customFieldValuesobject
Custom field values grouped by group ID. Values depend on field type: text, number, date, select, contact, user, etc.

Parámetros de salida

dataobjectObligatorio
The updated company object.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not
deprecationsstring[]
Any deprecation notices returned by the API.